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
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.
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.
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/>.
34 #include "ucioption.h"
39 //// Local definitions
48 enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
50 typedef std::vector<string> ComboValues;
54 string name, defaultValue, currentValue;
57 int minValue, maxValue;
58 ComboValues comboValues;
61 Option(const char* defaultValue, OptionType = STRING);
62 Option(bool defaultValue, OptionType = CHECK);
63 Option(int defaultValue, int minValue, int maxValue);
65 bool operator<(const Option& o) const { return this->idx < o.idx; }
68 typedef std::map<string, Option> Options;
74 // load_defaults populates the options map with the hard
75 // coded names and default values.
77 void load_defaults(Options& o) {
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);
117 // Any option should know its name so to be easily printed
118 for (Options::iterator it = o.begin(); it != o.end(); ++it)
119 it->second.name = it->first;
128 // stringify converts a value of type T to a std::string
130 string stringify(const T& v) {
132 std::ostringstream ss;
138 // get_option_value implements the various get_option_value_<type>
139 // functions defined later, because only the option value
140 // type changes a template seems a proper solution.
143 T get_option_value(const string& optionName) {
146 if (options.find(optionName) == options.end())
149 std::istringstream ss(options[optionName].currentValue);
154 // Specialization for std::string where instruction 'ss >> ret;'
155 // would erroneusly tokenize a string with spaces.
158 string get_option_value<string>(const string& optionName) {
160 if (options.find(optionName) == options.end())
163 return options[optionName].currentValue;
172 /// init_uci_options() initializes the UCI options. Currently, the only
173 /// thing this function does is to initialize the default value of the
174 /// "Threads" parameter to the number of available CPU cores.
176 void init_uci_options() {
178 load_defaults(options);
180 // Set optimal value for parameter "Minimum Split Depth"
181 // according to number of available cores.
182 assert(options.find("Threads") != options.end());
183 assert(options.find("Minimum Split Depth") != options.end());
185 Option& thr = options["Threads"];
186 Option& msd = options["Minimum Split Depth"];
188 thr.defaultValue = thr.currentValue = stringify(cpu_count());
190 if (cpu_count() >= 8)
191 msd.defaultValue = msd.currentValue = stringify(7);
195 /// print_uci_options() prints all the UCI options to the standard output,
196 /// in the format defined by the UCI protocol.
198 void print_uci_options() {
200 static const char optionTypeName[][16] = {
201 "spin", "combo", "check", "string", "button"
204 // Build up a vector out of the options map and sort it according to idx
205 // field, that is the chronological insertion order in options map.
206 std::vector<Option> vec;
207 for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
208 vec.push_back(it->second);
210 std::sort(vec.begin(), vec.end());
212 for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
214 std::cout << "\noption name " << it->name
215 << " type " << optionTypeName[it->type];
217 if (it->type == BUTTON)
220 if (it->type == CHECK)
221 std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
223 std::cout << " default " << it->defaultValue;
225 if (it->type == SPIN)
226 std::cout << " min " << it->minValue << " max " << it->maxValue;
227 else if (it->type == COMBO)
228 for (ComboValues::const_iterator itc = it->comboValues.begin();
229 itc != it->comboValues.end(); ++itc)
230 std::cout << " var " << *itc;
232 std::cout << std::endl;
236 /// get_option_value_bool() returns the current value of a UCI parameter of
239 bool get_option_value_bool(const string& optionName) {
241 return get_option_value<bool>(optionName);
245 /// get_option_value_int() returns the value of a UCI parameter as an integer.
246 /// Normally, this function will be used for a parameter of type "spin", but
247 /// it could also be used with a "combo" parameter, where all the available
248 /// values are integers.
250 int get_option_value_int(const string& optionName) {
252 return get_option_value<int>(optionName);
256 /// get_option_value_string() returns the current value of a UCI parameter as
257 /// a string. It is used with parameters of type "combo" and "string".
259 string get_option_value_string(const string& optionName) {
261 return get_option_value<string>(optionName);
265 /// set_option_value() inserts a new value for a UCI parameter. Note that
266 /// the function does not check that the new value is legal for the given
267 /// parameter: This is assumed to be the responsibility of the GUI.
269 void set_option_value(const string& name, const string& value) {
271 // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
272 // value according to standard C++ convention before to store it.
276 else if (v == "false")
279 if (options.find(name) == options.end())
281 std::cout << "No such option: " << name << std::endl;
285 // Normally it's up to the GUI to check for option's limits,
286 // but we could receive the new value directly from the user
287 // by teminal window. So let's check the bounds anyway.
288 Option& opt = options[name];
290 if (opt.type == CHECK && v != "0" && v != "1")
293 else if (opt.type == SPIN)
295 int val = atoi(v.c_str());
296 if (val < opt.minValue || val > opt.maxValue)
300 opt.currentValue = v;
304 /// push_button() is used to tell the engine that a UCI parameter of type
305 /// "button" has been selected:
307 void push_button(const string& buttonName) {
309 set_option_value(buttonName, "true");
313 /// button_was_pressed() tests whether a UCI parameter of type "button" has
314 /// been selected since the last time the function was called, in this case
315 /// it also resets the button.
317 bool button_was_pressed(const string& buttonName) {
319 if (!get_option_value<bool>(buttonName))
322 set_option_value(buttonName, "false");
329 // Define constructors of Option class.
331 Option::Option() {} // To allow insertion in a std::map
333 Option::Option(const char* def, OptionType t)
334 : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
336 Option::Option(bool def, OptionType t)
337 : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
339 Option::Option(int def, int minv, int maxv)
340 : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}