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