Small code tidy up and test results
[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;
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     size_t idx;
63     int minValue, maxValue;
64     ComboValues comboValues;
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["LSN filtering"] = Option(true);
132     o["LSN Time Margin (sec)"] = Option(4, 1, 10);
133     o["LSN Value Margin"] = Option(200, 100, 600);
134     o["Randomness"] = Option(0, 0, 10);
135     o["Minimum Split Depth"] = Option(4, 4, 7);
136     o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
137     o["Threads"] = Option(1, 1, 8);
138     o["Hash"] = Option(32, 4, 4096);
139     o["Clear Hash"] = Option(false, BUTTON);
140     o["Ponder"] = Option(true);
141     o["OwnBook"] = Option(true);
142     o["MultiPV"] = Option(1, 1, 500);
143     o["UCI_ShowCurrLine"] = Option(false);
144     o["UCI_Chess960"] = Option(false);
145
146     // Any option should know its name so to be easily printed
147     for (Options::iterator it = o.begin(); it != o.end(); ++it)
148         it->second.name = it->first;
149   }
150
151   ///
152   /// Variables
153   ///
154
155   Options options;
156
157   // stringify converts a value of type T to a std::string
158   template<typename T>
159   std::string stringify(const T& v) {
160
161      std::ostringstream ss;
162      ss << v;
163      return ss.str();
164   }
165
166
167   // get_option_value implements the various get_option_value_<type>
168   // functions defined later, because only the option value
169   // type changes a template seems a proper solution.
170
171   template<typename T>
172   T get_option_value(const std::string& optionName) {
173
174       T ret = T();
175       if (options.find(optionName) == options.end())
176           return ret;
177
178       std::istringstream ss(options[optionName].currentValue);
179       ss >> ret;
180       return ret;
181   }
182
183 }
184
185 ////
186 //// Functions
187 ////
188
189 /// init_uci_options() initializes the UCI options.  Currently, the only
190 /// thing this function does is to initialize the default value of the
191 /// "Threads" parameter to the number of available CPU cores.
192
193 void init_uci_options() {
194
195   load_defaults(options);
196
197   // Limit the default value of "Threads" to 7 even if we have 8 CPU cores.
198   // According to Ken Dail's tests, Glaurung plays much better with 7 than
199   // with 8 threads.  This is weird, but it is probably difficult to find out
200   // why before I have a 8-core computer to experiment with myself.
201   assert(options.find("Threads") != options.end());
202   assert(options.find("Minimum Split Depth") != options.end());
203
204   options["Threads"].defaultValue = stringify(Min(cpu_count(), 7));
205   options["Threads"].currentValue = stringify(Min(cpu_count(), 7));
206
207   // Increase the minimum split depth when the number of CPUs is big.
208   // It would probably be better to let this depend on the number of threads
209   // instead.
210   if (cpu_count() > 4)
211   {
212       options["Minimum Split Depth"].defaultValue = "6";
213       options["Minimum Split Depth"].currentValue = "6";
214   }
215 }
216
217
218 /// print_uci_options() prints all the UCI options to the standard output,
219 /// in the format defined by the UCI protocol.
220
221 void print_uci_options() {
222
223   static const char optionTypeName[][16] = {
224     "spin", "combo", "check", "string", "button"
225   };
226
227   // Build up a vector out of the options map and sort it according to idx
228   // field, that is the chronological insertion order in options map.
229   std::vector<Option> vec;
230   for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
231       vec.push_back(it->second);
232
233   std::sort(vec.begin(), vec.end());
234
235   for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
236   {
237       std::cout << "\noption name " << it->name
238                 << " type "         << optionTypeName[it->type];
239
240       if (it->type == BUTTON)
241           continue;
242
243       if (it->type == CHECK)
244           std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
245       else
246           std::cout << " default " << it->defaultValue;
247
248       if (it->type == SPIN)
249           std::cout << " min " << it->minValue
250                     << " max " << it->maxValue;
251
252       else if (it->type == COMBO)
253           for (ComboValues::const_iterator itc = it->comboValues.begin();
254               itc != it->comboValues.end(); ++itc)
255               std::cout << " var " << *itc;
256   }
257   std::cout << std::endl;
258 }
259
260
261 /// get_option_value_bool() returns the current value of a UCI parameter of
262 /// type "check".
263
264 bool get_option_value_bool(const std::string& optionName) {
265
266   return get_option_value<bool>(optionName);
267 }
268
269
270 /// get_option_value_int() returns the value of a UCI parameter as an integer.
271 /// Normally, this function will be used for a parameter of type "spin", but
272 /// it could also be used with a "combo" parameter, where all the available
273 /// values are integers.
274
275 int get_option_value_int(const std::string& optionName) {
276
277   return get_option_value<int>(optionName);
278 }
279
280
281 /// get_option_value_string() returns the current value of a UCI parameter as
282 /// a string. It is used with parameters of type "combo" and "string".
283
284 const std::string get_option_value_string(const std::string& optionName) {
285
286    return get_option_value<std::string>(optionName);
287 }
288
289
290 /// set_option_value() inserts a new value for a UCI parameter. Note that
291 /// the function does not check that the new value is legal for the given
292 /// parameter: This is assumed to be the responsibility of the GUI.
293
294 void set_option_value(const std::string& optionName,
295                       const std::string& newValue) {
296
297   // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
298   // newValue according to standard C++ convention before to store it.
299   std::string v(newValue);
300   if (v == "true")
301       v = "1";
302   else if (v == "false")
303       v = "0";
304
305   if (options.find(optionName) != options.end())
306       options[optionName].currentValue = v;
307   else
308       std::cout << "No such option: " << optionName << std::endl;
309 }
310
311
312 /// push_button() is used to tell the engine that a UCI parameter of type
313 /// "button" has been selected:
314
315 void push_button(const std::string& buttonName) {
316
317   set_option_value(buttonName, "true");
318 }
319
320
321 /// button_was_pressed() tests whether a UCI parameter of type "button" has
322 /// been selected since the last time the function was called, in this case
323 /// it also resets the button.
324
325 bool button_was_pressed(const std::string& buttonName) {
326
327   if (!get_option_value<bool>(buttonName))
328           return false;
329
330   set_option_value(buttonName, "false");
331   return true;
332 }
333
334
335 namespace {
336
337   // Define constructors of Option class.
338
339   Option::Option() {} // To allow insertion in a std::map
340
341   Option::Option(const char* def, OptionType t)
342   : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
343
344   Option::Option(bool def, OptionType t)
345   : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
346
347   Option::Option(int def, int minv, int maxv)
348   : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
349
350 }