Add "Best Book Move" UCI option
[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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
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["Best Book Move"] = Option(false);
83     o["Mobility (Middle Game)"] = Option(100, 0, 200);
84     o["Mobility (Endgame)"] = Option(100, 0, 200);
85     o["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
86     o["Pawn Structure (Endgame)"] = Option(100, 0, 200);
87     o["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
88     o["Passed Pawns (Endgame)"] = Option(100, 0, 200);
89     o["Space"] = Option(100, 0, 200);
90     o["Aggressiveness"] = Option(100, 0, 200);
91     o["Cowardice"] = Option(100, 0, 200);
92     o["Check Extension (PV nodes)"] = Option(2, 0, 2);
93     o["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
94     o["Single Evasion Extension (PV nodes)"] = Option(2, 0, 2);
95     o["Single Evasion Extension (non-PV nodes)"] = Option(2, 0, 2);
96     o["Mate Threat Extension (PV nodes)"] = Option(0, 0, 2);
97     o["Mate Threat Extension (non-PV nodes)"] = Option(0, 0, 2);
98     o["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
99     o["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
100     o["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
101     o["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
102     o["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
103     o["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
104     o["Randomness"] = Option(0, 0, 10);
105     o["Minimum Split Depth"] = Option(4, 4, 7);
106     o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
107     o["Threads"] = Option(1, 1, MAX_THREADS);
108     o["Hash"] = Option(32, 4, 8192);
109     o["Clear Hash"] = Option(false, BUTTON);
110     o["New Game"] = Option(false, BUTTON);
111     o["Ponder"] = Option(true);
112     o["OwnBook"] = Option(true);
113     o["MultiPV"] = Option(1, 1, 500);
114     o["UCI_Chess960"] = Option(false);
115     o["UCI_AnalyseMode"] = Option(false);
116
117     // Temporary hack for 1.7.1 to be removed in next release
118     o["Zugzwang detection"] = Option(false);
119
120     // Any option should know its name so to be easily printed
121     for (Options::iterator it = o.begin(); it != o.end(); ++it)
122         it->second.name = it->first;
123   }
124
125   ///
126   /// Variables
127   ///
128
129   Options options;
130
131   // stringify converts a value of type T to a std::string
132   template<typename T>
133   string stringify(const T& v) {
134
135      std::ostringstream ss;
136      ss << v;
137      return ss.str();
138   }
139
140
141   // get_option_value implements the various get_option_value_<type>
142   // functions defined later, because only the option value
143   // type changes a template seems a proper solution.
144
145   template<typename T>
146   T get_option_value(const string& optionName) {
147
148       T ret = T();
149       if (options.find(optionName) == options.end())
150           return ret;
151
152       std::istringstream ss(options[optionName].currentValue);
153       ss >> ret;
154       return ret;
155   }
156
157   // Specialization for std::string where instruction 'ss >> ret;'
158   // would erroneusly tokenize a string with spaces.
159
160   template<>
161   string get_option_value<string>(const string& optionName) {
162
163       if (options.find(optionName) == options.end())
164           return string();
165
166       return options[optionName].currentValue;
167   }
168
169 }
170
171 ////
172 //// Functions
173 ////
174
175 /// init_uci_options() initializes the UCI options.  Currently, the only
176 /// thing this function does is to initialize the default value of the
177 /// "Threads" parameter to the number of available CPU cores.
178
179 void init_uci_options() {
180
181   load_defaults(options);
182
183   // Set optimal value for parameter "Minimum Split Depth"
184   // according to number of available cores.
185   assert(options.find("Threads") != options.end());
186   assert(options.find("Minimum Split Depth") != options.end());
187
188   Option& thr = options["Threads"];
189   Option& msd = options["Minimum Split Depth"];
190
191   thr.defaultValue = thr.currentValue = stringify(cpu_count());
192
193   if (cpu_count() >= 8)
194       msd.defaultValue = msd.currentValue = stringify(7);
195 }
196
197
198 /// print_uci_options() prints all the UCI options to the standard output,
199 /// in the format defined by the UCI protocol.
200
201 void print_uci_options() {
202
203   static const char optionTypeName[][16] = {
204     "spin", "combo", "check", "string", "button"
205   };
206
207   // Build up a vector out of the options map and sort it according to idx
208   // field, that is the chronological insertion order in options map.
209   std::vector<Option> vec;
210   for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
211       vec.push_back(it->second);
212
213   std::sort(vec.begin(), vec.end());
214
215   for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
216   {
217       std::cout << "\noption name " << it->name
218                 << " type "         << optionTypeName[it->type];
219
220       if (it->type == BUTTON)
221           continue;
222
223       if (it->type == CHECK)
224           std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
225       else
226           std::cout << " default " << it->defaultValue;
227
228       if (it->type == SPIN)
229           std::cout << " min " << it->minValue << " max " << it->maxValue;
230       else if (it->type == COMBO)
231           for (ComboValues::const_iterator itc = it->comboValues.begin();
232               itc != it->comboValues.end(); ++itc)
233               std::cout << " var " << *itc;
234   }
235   std::cout << std::endl;
236 }
237
238
239 /// get_option_value_bool() returns the current value of a UCI parameter of
240 /// type "check".
241
242 bool get_option_value_bool(const string& optionName) {
243
244   return get_option_value<bool>(optionName);
245 }
246
247
248 /// get_option_value_int() returns the value of a UCI parameter as an integer.
249 /// Normally, this function will be used for a parameter of type "spin", but
250 /// it could also be used with a "combo" parameter, where all the available
251 /// values are integers.
252
253 int get_option_value_int(const string& optionName) {
254
255   return get_option_value<int>(optionName);
256 }
257
258
259 /// get_option_value_string() returns the current value of a UCI parameter as
260 /// a string. It is used with parameters of type "combo" and "string".
261
262 string get_option_value_string(const string& optionName) {
263
264    return get_option_value<string>(optionName);
265 }
266
267
268 /// set_option_value() inserts a new value for a UCI parameter. Note that
269 /// the function does not check that the new value is legal for the given
270 /// parameter: This is assumed to be the responsibility of the GUI.
271
272 void set_option_value(const string& name, const string& value) {
273
274   // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
275   // value according to standard C++ convention before to store it.
276   string v(value);
277   if (v == "true")
278       v = "1";
279   else if (v == "false")
280       v = "0";
281
282   if (options.find(name) == options.end())
283   {
284       std::cout << "No such option: " << name << std::endl;
285       return;
286   }
287
288   // Normally it's up to the GUI to check for option's limits,
289   // but we could receive the new value directly from the user
290   // by teminal window. So let's check the bounds anyway.
291   Option& opt = options[name];
292
293   if (opt.type == CHECK && v != "0" && v != "1")
294       return;
295
296   else if (opt.type == SPIN)
297   {
298       int val = atoi(v.c_str());
299       if (val < opt.minValue || val > opt.maxValue)
300           return;
301   }
302
303   opt.currentValue = v;
304 }
305
306
307 /// push_button() is used to tell the engine that a UCI parameter of type
308 /// "button" has been selected:
309
310 void push_button(const string& buttonName) {
311
312   set_option_value(buttonName, "true");
313 }
314
315
316 /// button_was_pressed() tests whether a UCI parameter of type "button" has
317 /// been selected since the last time the function was called, in this case
318 /// it also resets the button.
319
320 bool button_was_pressed(const string& buttonName) {
321
322   if (!get_option_value<bool>(buttonName))
323       return false;
324
325   set_option_value(buttonName, "false");
326   return true;
327 }
328
329
330 namespace {
331
332   // Define constructors of Option class.
333
334   Option::Option() {} // To allow insertion in a std::map
335
336   Option::Option(const char* def, OptionType t)
337   : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
338
339   Option::Option(bool def, OptionType t)
340   : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
341
342   Option::Option(int def, int minv, int maxv)
343   : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
344
345 }