2 Glaurung, a UCI chess playing engine.
3 Copyright (C) 2004-2008 Tord Romstad
5 Glaurung is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 Glaurung is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "ucioption.h"
38 bool Chess960 = false;
42 //// Local definitions
51 enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
53 typedef std::vector<std::string> ComboValues;
57 std::string name, defaultValue, currentValue;
59 int minValue, maxValue;
60 ComboValues comboValues;
62 Option(const char* name, const char* defaultValue, OptionType = STRING);
63 Option(const char* name, bool defaultValue, OptionType = CHECK);
64 Option(const char* name, int defaultValue, int minValue, int maxValue);
67 typedef std::vector<Option> Options;
73 // load_defaults populates the options vector with the hard
74 // coded names and default values.
75 void load_defaults(Options& o) {
77 o.push_back(Option("Use Search Log", false));
78 o.push_back(Option("Search Log Filename", "SearchLog.txt"));
79 o.push_back(Option("Book File", "book.bin"));
80 o.push_back(Option("Mobility (Middle Game)", 100, 0, 200));
81 o.push_back(Option("Mobility (Endgame)", 100, 0, 200));
82 o.push_back(Option("Pawn Structure (Middle Game)", 100, 0, 200));
83 o.push_back(Option("Pawn Structure (Endgame)", 100, 0, 200));
84 o.push_back(Option("Passed Pawns (Middle Game)", 100, 0, 200));
85 o.push_back(Option("Passed Pawns (Endgame)", 100, 0, 200));
86 o.push_back(Option("Aggressiveness", 100, 0, 200));
87 o.push_back(Option("Cowardice", 100, 0, 200));
88 o.push_back(Option("King Safety Curve", "Quadratic", COMBO));
90 o.back().comboValues.push_back("Quadratic");
91 o.back().comboValues.push_back("Linear"); /*, "From File"*/
93 o.push_back(Option("King Safety Coefficient", 40, 1, 100));
94 o.push_back(Option("King Safety X Intercept", 0, 0, 20));
95 o.push_back(Option("King Safety Max Slope", 30, 10, 100));
96 o.push_back(Option("King Safety Max Value", 500, 100, 1000));
97 o.push_back(Option("Queen Contact Check Bonus", 4, 0, 8));
98 o.push_back(Option("Rook Contact Check Bonus", 2, 0, 4));
99 o.push_back(Option("Queen Check Bonus", 2, 0, 4));
100 o.push_back(Option("Rook Check Bonus", 1, 0, 4));
101 o.push_back(Option("Bishop Check Bonus", 1, 0, 4));
102 o.push_back(Option("Knight Check Bonus", 1, 0, 4));
103 o.push_back(Option("Discovered Check Bonus", 3, 0, 8));
104 o.push_back(Option("Mate Threat Bonus", 3, 0, 8));
105 o.push_back(Option("Check Extension (PV nodes)", 2, 0, 2));
106 o.push_back(Option("Check Extension (non-PV nodes)", 1, 0, 2));
107 o.push_back(Option("Single Reply Extension (PV nodes)", 2, 0, 2));
108 o.push_back(Option("Single Reply Extension (non-PV nodes)", 2, 0, 2));
109 o.push_back(Option("Mate Threat Extension (PV nodes)", 0, 0, 2));
110 o.push_back(Option("Mate Threat Extension (non-PV nodes)", 0, 0, 2));
111 o.push_back(Option("Pawn Push to 7th Extension (PV nodes)", 1, 0, 2));
112 o.push_back(Option("Pawn Push to 7th Extension (non-PV nodes)", 1, 0, 2));
113 o.push_back(Option("Passed Pawn Extension (PV nodes)", 1, 0, 2));
114 o.push_back(Option("Passed Pawn Extension (non-PV nodes)", 0, 0, 2));
115 o.push_back(Option("Pawn Endgame Extension (PV nodes)", 2, 0, 2));
116 o.push_back(Option("Pawn Endgame Extension (non-PV nodes)", 2, 0, 2));
117 o.push_back(Option("Full Depth Moves (PV nodes)", 14, 1, 100));
118 o.push_back(Option("Full Depth Moves (non-PV nodes)", 3, 1, 100));
119 o.push_back(Option("Threat Depth", 5, 0, 100));
120 o.push_back(Option("Selective Plies", 7, 0, 10));
121 o.push_back(Option("Futility Pruning (Main Search)", true));
122 o.push_back(Option("Futility Pruning (Quiescence Search)", true));
123 o.push_back(Option("Futility Margin 0", 50, 0, 1000));
124 o.push_back(Option("Futility Margin 1", 100, 0, 1000));
125 o.push_back(Option("Futility Margin 2", 300, 0, 1000));
126 o.push_back(Option("Maximum Razoring Depth", 3, 0, 4));
127 o.push_back(Option("Razoring Margin", 300, 150, 600));
128 o.push_back(Option("Randomness", 0, 0, 10));
129 o.push_back(Option("Minimum Split Depth", 4, 4, 7));
130 o.push_back(Option("Maximum Number of Threads per Split Point", 5, 4, 8));
131 o.push_back(Option("Threads", 1, 1, 8));
132 o.push_back(Option("Hash", 32, 4, 4096));
133 o.push_back(Option("Clear Hash", false, BUTTON));
134 o.push_back(Option("Ponder", true));
135 o.push_back(Option("OwnBook", true));
136 o.push_back(Option("MultiPV", 1, 1, 500));
137 o.push_back(Option("UCI_ShowCurrLine", false));
138 o.push_back(Option("UCI_Chess960", false));
148 Options::iterator option_with_name(const std::string& optionName);
150 // stringify converts a value of type T to a std::string
152 std::string stringify(const T& v) {
154 std::ostringstream ss;
159 // We want conversion from a bool value to be "true" or "false",
160 // not "1" or "0", so add a specialization for bool type.
162 std::string stringify<bool>(const bool& v) {
164 return v ? "true" : "false";
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.
172 T get_option_value(const std::string& optionName) {
175 Options::iterator it = option_with_name(optionName);
177 if (it != options.end())
179 std::istringstream ss(it->currentValue);
185 // Unfortunatly we need a specialization to convert "false" and "true"
186 // to proper bool values. The culprit is that we use a non standard way
187 // to store a bool value in a string, in particular we use "false" and
188 // "true" instead of "0" and "1" due to how UCI protocol works.
191 bool get_option_value<bool>(const std::string& optionName) {
193 Options::iterator it = option_with_name(optionName);
195 return it != options.end() && it->currentValue == "true";
203 /// init_uci_options() initializes the UCI options. Currently, the only
204 /// thing this function does is to initialize the default value of the
205 /// "Threads" parameter to the number of available CPU cores.
207 void init_uci_options() {
209 load_defaults(options);
211 // Limit the default value of "Threads" to 7 even if we have 8 CPU cores.
212 // According to Ken Dail's tests, Glaurung plays much better with 7 than
213 // with 8 threads. This is weird, but it is probably difficult to find out
214 // why before I have a 8-core computer to experiment with myself.
215 Options::iterator it = option_with_name("Threads");
217 assert(it != options.end());
219 it->defaultValue = stringify(Min(cpu_count(), 7));
220 it->currentValue = stringify(Min(cpu_count(), 7));
222 // Increase the minimum split depth when the number of CPUs is big.
223 // It would probably be better to let this depend on the number of threads
227 it = option_with_name("Minimum Split Depth");
229 assert(it != options.end());
231 it->defaultValue = "6";
232 it->currentValue = "6";
237 /// print_uci_options() prints all the UCI options to the standard output,
238 /// in the format defined by the UCI protocol.
240 void print_uci_options() {
242 static const char optionTypeName[][16] = {
243 "spin", "combo", "check", "string", "button"
246 for (Options::iterator it = options.begin(); it != options.end(); ++it)
248 std::cout << "option name " << it->name
249 << " type " << optionTypeName[it->type];
251 if (it->type != BUTTON)
253 std::cout << " default " << it->defaultValue;
255 if (it->type == SPIN)
256 std::cout << " min " << it->minValue
257 << " max " << it->maxValue;
259 else if (it->type == COMBO)
260 for(ComboValues::iterator itc = it->comboValues.begin();
261 itc != it->comboValues.end(); ++itc)
262 std::cout << " var " << *itc;
264 std::cout << std::endl;
268 /// get_option_value_bool() returns the current value of a UCI parameter of
271 bool get_option_value_bool(const std::string& optionName) {
273 return get_option_value<bool>(optionName);
277 /// get_option_value_int() returns the value of a UCI parameter as an integer.
278 /// Normally, this function will be used for a parameter of type "spin", but
279 /// it could also be used with a "combo" parameter, where all the available
280 /// values are integers.
282 int get_option_value_int(const std::string& optionName) {
284 return get_option_value<int>(optionName);
288 /// get_option_value_string() returns the current value of a UCI parameter as
289 /// a string. It is used with parameters of type "combo" and "string".
291 const std::string get_option_value_string(const std::string& optionName) {
293 return get_option_value<std::string>(optionName);
297 /// button_was_pressed() tests whether a UCI parameter of type "button" has
298 /// been selected since the last time the function was called.
300 bool button_was_pressed(const std::string& buttonName) {
302 if (get_option_value<bool>(buttonName))
304 set_option_value(buttonName, "false");
312 /// set_option_value() inserts a new value for a UCI parameter. Note that
313 /// the function does not check that the new value is legal for the given
314 /// parameter: This is assumed to be the responsibility of the GUI.
316 void set_option_value(const std::string& optionName,
317 const std::string& newValue) {
319 Options::iterator it = option_with_name(optionName);
321 if (it != options.end())
322 it->currentValue = newValue;
324 std::cout << "No such option: " << optionName << std::endl;
328 /// push_button() is used to tell the engine that a UCI parameter of type
329 /// "button" has been selected:
331 void push_button(const std::string& buttonName) {
333 set_option_value(buttonName, "true");
339 // Define constructors of Option class.
341 Option::Option(const char* nm, const char* def, OptionType t)
342 : name(nm), defaultValue(def), currentValue(def), type(t), minValue(0), maxValue(0) {}
344 Option::Option(const char* nm, bool def, OptionType t)
345 : name(nm), defaultValue(stringify(def)), currentValue(stringify(def)), type(t), minValue(0), maxValue(0) {}
347 Option::Option(const char* nm, int def, int minv, int maxv)
348 : name(nm), defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), minValue(minv), maxValue(maxv) {}
350 // option_with_name() tries to find a UCI option with a given
351 // name. It returns an iterator to the UCI option or to options.end(),
352 // depending on whether an option with the given name exists.
354 Options::iterator option_with_name(const std::string& optionName) {
356 for (Options::iterator it = options.begin(); it != options.end(); ++it)
357 if (it->name == optionName)
360 return options.end();