Restore development versioning and LSN filtering
[stockfish] / src / ucioption.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2009 Marco Costalba
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20
21 ////
22 //// Includes
23 ////
24
25 #include <algorithm>
26 #include <cassert>
27 #include <map>
28 #include <string>
29 #include <sstream>
30 #include <vector>
31
32 #include "misc.h"
33 #include "thread.h"
34 #include "ucioption.h"
35
36 using std::string;
37
38 ////
39 //// Local definitions
40 ////
41
42 namespace {
43
44   ///
45   /// Types
46   ///
47
48   enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
49
50   typedef std::vector<string> ComboValues;
51
52   struct Option {
53
54     string name, defaultValue, currentValue;
55     OptionType type;
56     size_t idx;
57     int minValue, maxValue;
58     ComboValues comboValues;
59
60     Option();
61     Option(const char* defaultValue, OptionType = STRING);
62     Option(bool defaultValue, OptionType = CHECK);
63     Option(int defaultValue, int minValue, int maxValue);
64
65     bool operator<(const Option& o) const { return this->idx < o.idx; }
66   };
67
68   typedef std::map<string, Option> Options;
69
70   ///
71   /// Constants
72   ///
73
74   // load_defaults populates the options map with the hard
75   // coded names and default values.
76
77   void load_defaults(Options& o) {
78
79     o["Use Search Log"] = Option(false);
80     o["Search Log Filename"] = Option("SearchLog.txt");
81     o["Book File"] = Option("book.bin");
82     o["Mobility (Middle Game)"] = Option(100, 0, 200);
83     o["Mobility (Endgame)"] = Option(100, 0, 200);
84     o["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
85     o["Pawn Structure (Endgame)"] = Option(100, 0, 200);
86     o["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
87     o["Passed Pawns (Endgame)"] = Option(100, 0, 200);
88     o["Space"] = Option(100, 0, 200);
89     o["Aggressiveness"] = Option(100, 0, 200);
90     o["Cowardice"] = Option(100, 0, 200);
91     o["King Safety Curve"] = Option("Quadratic", COMBO);
92
93        o["King Safety Curve"].comboValues.push_back("Quadratic");
94        o["King Safety Curve"].comboValues.push_back("Linear");  /*, "From File"*/
95
96     o["King Safety Coefficient"] = Option(40, 1, 100);
97     o["King Safety X Intercept"] = Option(0, 0, 20);
98     o["King Safety Max Slope"] = Option(30, 10, 100);
99     o["King Safety Max Value"] = Option(500, 100, 1000);
100     o["Queen Contact Check Bonus"] = Option(3, 0, 8);
101     o["Queen Check Bonus"] = Option(2, 0, 4);
102     o["Rook Check Bonus"] = Option(1, 0, 4);
103     o["Bishop Check Bonus"] = Option(1, 0, 4);
104     o["Knight Check Bonus"] = Option(1, 0, 4);
105     o["Discovered Check Bonus"] = Option(3, 0, 8);
106     o["Mate Threat Bonus"] = Option(3, 0, 8);
107     o["Check Extension (PV nodes)"] = Option(2, 0, 2);
108     o["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
109     o["Single Reply Extension (PV nodes)"] = Option(2, 0, 2);
110     o["Single Reply Extension (non-PV nodes)"] = Option(2, 0, 2);
111     o["Mate Threat Extension (PV nodes)"] = Option(0, 0, 2);
112     o["Mate Threat Extension (non-PV nodes)"] = Option(0, 0, 2);
113     o["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
114     o["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
115     o["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
116     o["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
117     o["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
118     o["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
119     o["Full Depth Moves (PV nodes)"] = Option(14, 1, 100);
120     o["Full Depth Moves (non-PV nodes)"] = Option(3, 1, 100);
121     o["Threat Depth"] = Option(5, 0, 100);
122     o["LSN filtering"] = Option(true);
123     o["LSN Time Margin (sec)"] = Option(4, 1, 10);
124     o["LSN Value Margin"] = Option(200, 100, 600);
125     o["Randomness"] = Option(0, 0, 10);
126     o["Minimum Split Depth"] = Option(4, 4, 7);
127     o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
128     o["Threads"] = Option(1, 1, 8);
129     o["Hash"] = Option(32, 4, 4096);
130     o["Clear Hash"] = Option(false, BUTTON);
131     o["Ponder"] = Option(true);
132     o["OwnBook"] = Option(true);
133     o["MultiPV"] = Option(1, 1, 500);
134     o["UCI_ShowCurrLine"] = Option(false);
135     o["UCI_Chess960"] = Option(false);
136
137     // Any option should know its name so to be easily printed
138     for (Options::iterator it = o.begin(); it != o.end(); ++it)
139         it->second.name = it->first;
140   }
141
142   ///
143   /// Variables
144   ///
145
146   Options options;
147
148   // stringify converts a value of type T to a std::string
149   template<typename T>
150   string stringify(const T& v) {
151
152      std::ostringstream ss;
153      ss << v;
154      return ss.str();
155   }
156
157
158   // get_option_value implements the various get_option_value_<type>
159   // functions defined later, because only the option value
160   // type changes a template seems a proper solution.
161
162   template<typename T>
163   T get_option_value(const string& optionName) {
164
165       T ret = T();
166       if (options.find(optionName) == options.end())
167           return ret;
168
169       std::istringstream ss(options[optionName].currentValue);
170       ss >> ret;
171       return ret;
172   }
173
174 }
175
176 ////
177 //// Functions
178 ////
179
180 /// init_uci_options() initializes the UCI options.  Currently, the only
181 /// thing this function does is to initialize the default value of the
182 /// "Threads" parameter to the number of available CPU cores.
183
184 void init_uci_options() {
185
186   load_defaults(options);
187
188   // Limit the default value of "Threads" to 7 even if we have 8 CPU cores.
189   // According to Ken Dail's tests, Glaurung plays much better with 7 than
190   // with 8 threads.  This is weird, but it is probably difficult to find out
191   // why before I have a 8-core computer to experiment with myself.
192   assert(options.find("Threads") != options.end());
193   assert(options.find("Minimum Split Depth") != options.end());
194
195   options["Threads"].defaultValue = stringify(Min(cpu_count(), 7));
196   options["Threads"].currentValue = stringify(Min(cpu_count(), 7));
197
198   // Increase the minimum split depth when the number of CPUs is big.
199   // It would probably be better to let this depend on the number of threads
200   // instead.
201   if (cpu_count() > 4)
202   {
203       options["Minimum Split Depth"].defaultValue = "6";
204       options["Minimum Split Depth"].currentValue = "6";
205   }
206 }
207
208
209 /// print_uci_options() prints all the UCI options to the standard output,
210 /// in the format defined by the UCI protocol.
211
212 void print_uci_options() {
213
214   static const char optionTypeName[][16] = {
215     "spin", "combo", "check", "string", "button"
216   };
217
218   // Build up a vector out of the options map and sort it according to idx
219   // field, that is the chronological insertion order in options map.
220   std::vector<Option> vec;
221   for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
222       vec.push_back(it->second);
223
224   std::sort(vec.begin(), vec.end());
225
226   for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
227   {
228       std::cout << "\noption name " << it->name
229                 << " type "         << optionTypeName[it->type];
230
231       if (it->type == BUTTON)
232           continue;
233
234       if (it->type == CHECK)
235           std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
236       else
237           std::cout << " default " << it->defaultValue;
238
239       if (it->type == SPIN)
240           std::cout << " min " << it->minValue << " max " << it->maxValue;
241       else if (it->type == COMBO)
242           for (ComboValues::const_iterator itc = it->comboValues.begin();
243               itc != it->comboValues.end(); ++itc)
244               std::cout << " var " << *itc;
245   }
246   std::cout << std::endl;
247 }
248
249
250 /// get_option_value_bool() returns the current value of a UCI parameter of
251 /// type "check".
252
253 bool get_option_value_bool(const string& optionName) {
254
255   return get_option_value<bool>(optionName);
256 }
257
258
259 /// get_option_value_int() returns the value of a UCI parameter as an integer.
260 /// Normally, this function will be used for a parameter of type "spin", but
261 /// it could also be used with a "combo" parameter, where all the available
262 /// values are integers.
263
264 int get_option_value_int(const string& optionName) {
265
266   return get_option_value<int>(optionName);
267 }
268
269
270 /// get_option_value_string() returns the current value of a UCI parameter as
271 /// a string. It is used with parameters of type "combo" and "string".
272
273 string get_option_value_string(const string& optionName) {
274
275    return get_option_value<string>(optionName);
276 }
277
278
279 /// set_option_value() inserts a new value for a UCI parameter. Note that
280 /// the function does not check that the new value is legal for the given
281 /// parameter: This is assumed to be the responsibility of the GUI.
282
283 void set_option_value(const string& name, const string& value) {
284
285   // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
286   // value according to standard C++ convention before to store it.
287   string v(value);
288   if (v == "true")
289       v = "1";
290   else if (v == "false")
291       v = "0";
292
293   if (options.find(name) != options.end())
294       options[name].currentValue = v;
295   else
296       std::cout << "No such option: " << name << std::endl;
297 }
298
299
300 /// push_button() is used to tell the engine that a UCI parameter of type
301 /// "button" has been selected:
302
303 void push_button(const string& buttonName) {
304
305   set_option_value(buttonName, "true");
306 }
307
308
309 /// button_was_pressed() tests whether a UCI parameter of type "button" has
310 /// been selected since the last time the function was called, in this case
311 /// it also resets the button.
312
313 bool button_was_pressed(const string& buttonName) {
314
315   if (!get_option_value<bool>(buttonName))
316           return false;
317
318   set_option_value(buttonName, "false");
319   return true;
320 }
321
322
323 namespace {
324
325   // Define constructors of Option class.
326
327   Option::Option() {} // To allow insertion in a std::map
328
329   Option::Option(const char* def, OptionType t)
330   : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
331
332   Option::Option(bool def, OptionType t)
333   : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
334
335   Option::Option(int def, int minv, int maxv)
336   : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
337
338 }