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