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