/*
- Glaurung, a UCI chess playing engine.
- Copyright (C) 2004-2008 Tord Romstad
+ Stockfish, a UCI chess playing engine derived from Glaurung 2.1
+ Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
+ Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
- Glaurung is free software: you can redistribute it and/or modify
+ Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
- Glaurung is distributed in the hope that it will be useful,
+ Stockfish is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
//// Includes
////
+#include <algorithm>
#include <cassert>
#include <map>
#include <string>
#include "thread.h"
#include "ucioption.h"
-
-////
-//// Variables
-////
-
-bool Chess960 = false;
-
+using std::string;
+using std::cout;
+using std::endl;
////
//// Local definitions
namespace {
- ///
- /// Types
- ///
+ enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
- enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON, OPTION_TYPE_NONE };
+ typedef std::vector<string> StrVector;
- typedef std::vector<std::string> ComboValues;
+ struct Option {
- struct OptionValue
- {
- std::string defaultValue, currentValue;
+ string name, defaultValue, currentValue;
OptionType type;
+ size_t idx;
int minValue, maxValue;
- ComboValues comboValues;
+ StrVector comboValues;
- // Helper to convert a bool or an int in a std::string
- template<typename T> std::string stringify(const T& v);
+ Option();
+ Option(const char* defaultValue, OptionType = STRING);
+ Option(bool defaultValue, OptionType = CHECK);
+ Option(int defaultValue, int minValue, int maxValue);
- OptionValue(); // this is needed to use a std::map
- OptionValue(const char* defaultValue, OptionType = STRING);
- OptionValue(bool defaultValue);
- OptionValue(int defaultValue, int minValue, int maxValue);
+ bool operator<(const Option& o) const { return idx < o.idx; }
};
- typedef std::map<std::string, OptionValue> Options;
-
- ///
- /// Constants
- ///
-
- // load-defaults populates the options map with the hard
- // coded options names and their default values.
- void load_defaults(Options& options) {
-
- options["Use Search Log"] = OptionValue(false);
- options["Search Log Filename"] = OptionValue("SearchLog.txt");
- options["Book File"] = OptionValue("book.bin");
- options["Mobility (Middle Game)"] = OptionValue(100, 0, 200);
- options["Mobility (Endgame)"] = OptionValue(100, 0, 200);
- options["Pawn Structure (Middle Game)"] = OptionValue(100, 0, 200);
- options["Pawn Structure (Endgame)"] = OptionValue(100, 0, 200);
- options["Passed Pawns (Middle Game)"] = OptionValue(100, 0, 200);
- options["Passed Pawns (Endgame)"] = OptionValue(100, 0, 200);
- options["Aggressiveness"] = OptionValue(100, 0, 200);
- options["Cowardice"] = OptionValue(100, 0, 200);
- options["King Safety Curve"] = OptionValue("Quadratic", COMBO);
-
- options["King Safety Curve"].comboValues.push_back("Quadratic");
- options["King Safety Curve"].comboValues.push_back("Linear"); /*, "From File"*/
-
- options["King Safety Coefficient"] = OptionValue(40, 1, 100);
- options["King Safety X Intercept"] = OptionValue(0, 0, 20);
- options["King Safety Max Slope"] = OptionValue(30, 10, 100);
- options["King Safety Max Value"] = OptionValue(500, 100, 1000);
- options["Queen Contact Check Bonus"] = OptionValue(4, 0, 8);
- options["Rook Contact Check Bonus"] = OptionValue(2, 0, 4);
- options["Queen Check Bonus"] = OptionValue(2, 0, 4);
- options["Rook Check Bonus"] = OptionValue(1, 0, 4);
- options["Bishop Check Bonus"] = OptionValue(1, 0, 4);
- options["Knight Check Bonus"] = OptionValue(1, 0, 4);
- options["Discovered Check Bonus"] = OptionValue(3, 0, 8);
- options["Mate Threat Bonus"] = OptionValue(3, 0, 8);
-
- options["Check Extension (PV nodes)"] = OptionValue(2, 0, 2);
- options["Check Extension (non-PV nodes)"] = OptionValue(1, 0, 2);
- options["Single Reply Extension (PV nodes)"] = OptionValue(2, 0, 2);
- options["Single Reply Extension (non-PV nodes)"] = OptionValue(2, 0, 2);
- options["Mate Threat Extension (PV nodes)"] = OptionValue(2, 0, 2);
- options["Mate Threat Extension (non-PV nodes)"] = OptionValue(0, 0, 2);
- options["Pawn Push to 7th Extension (PV nodes)"] = OptionValue(1, 0, 2);
- options["Pawn Push to 7th Extension (non-PV nodes)"] = OptionValue(1, 0, 2);
- options["Passed Pawn Extension (PV nodes)"] = OptionValue(1, 0, 2);
- options["Passed Pawn Extension (non-PV nodes)"] = OptionValue(0, 0, 2);
- options["Pawn Endgame Extension (PV nodes)"] = OptionValue(2, 0, 2);
- options["Pawn Endgame Extension (non-PV nodes)"] = OptionValue(2, 0, 2);
- options["Full Depth Moves (PV nodes)"] = OptionValue(14, 1, 100);
- options["Full Depth Moves (non-PV nodes)"] = OptionValue(3, 1, 100);
- options["Threat Depth"] = OptionValue(5, 0, 100);
- options["Selective Plies"] = OptionValue(7, 0, 10);
- options["Futility Pruning (Main Search)"] = OptionValue(true);
- options["Futility Pruning (Quiescence Search)"] = OptionValue(true);
- options["Futility Margin 0"] = OptionValue(50, 0, 1000);
- options["Futility Margin 1"] = OptionValue(100, 0, 1000);
- options["Futility Margin 2"] = OptionValue(300, 0, 1000);
- options["Maximum Razoring Depth"] = OptionValue(3, 0, 4);
- options["Razoring Margin"] = OptionValue(300, 150, 600);
- options["Randomness"] = OptionValue(0, 0, 10);
- options["Minimum Split Depth"] = OptionValue(4, 4, 7);
- options["Maximum Number of Threads per Split Point"] = OptionValue(5, 4, 8);
- options["Threads"] = OptionValue(1, 1, 8);
- options["Hash"] = OptionValue(32, 4, 4096);
- options["Clear Hash"] = OptionValue(false);
- options["Ponder"] = OptionValue(true);
- options["OwnBook"] = OptionValue(true);
- options["MultiPV"] = OptionValue(1, 1, 500);
- options["UCI_ShowCurrLine"] = OptionValue(false);
- options["UCI_Chess960"] = OptionValue(false);
+ typedef std::vector<Option> OptionsVector;
+ typedef std::map<string, Option> Options;
+
+ Options options;
+
+ // stringify() converts a value of type T to a std::string
+ template<typename T>
+ string stringify(const T& v) {
+
+ std::ostringstream ss;
+ ss << v;
+ return ss.str();
+ }
+
+ Option::Option() {} // To allow insertion in a std::map
+
+ Option::Option(const char* def, OptionType t)
+ : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
+
+ Option::Option(bool def, OptionType t)
+ : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
+
+ Option::Option(int def, int minv, int maxv)
+ : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
+
+ // load_defaults() populates the options map with the hard
+ // coded names and default values.
+
+ void load_defaults(Options& o) {
+
+ o["Use Search Log"] = Option(false);
+ o["Search Log Filename"] = Option("SearchLog.txt");
+ o["Book File"] = Option("book.bin");
+ o["Best Book Move"] = Option(false);
+ o["Mobility (Middle Game)"] = Option(100, 0, 200);
+ o["Mobility (Endgame)"] = Option(100, 0, 200);
+ o["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
+ o["Pawn Structure (Endgame)"] = Option(100, 0, 200);
+ o["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
+ o["Passed Pawns (Endgame)"] = Option(100, 0, 200);
+ o["Space"] = Option(100, 0, 200);
+ o["Aggressiveness"] = Option(100, 0, 200);
+ o["Cowardice"] = Option(100, 0, 200);
+ o["Check Extension (PV nodes)"] = Option(2, 0, 2);
+ o["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
+ o["Single Evasion Extension (PV nodes)"] = Option(2, 0, 2);
+ o["Single Evasion Extension (non-PV nodes)"] = Option(2, 0, 2);
+ o["Mate Threat Extension (PV nodes)"] = Option(2, 0, 2);
+ o["Mate Threat Extension (non-PV nodes)"] = Option(2, 0, 2);
+ o["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
+ o["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
+ o["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
+ o["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
+ o["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
+ o["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
+ o["Minimum Split Depth"] = Option(4, 4, 7);
+ o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
+ o["Threads"] = Option(1, 1, MAX_THREADS);
+ o["Hash"] = Option(32, 4, 8192);
+ o["Clear Hash"] = Option(false, BUTTON);
+ o["New Game"] = Option(false, BUTTON);
+ o["Ponder"] = Option(true);
+ o["OwnBook"] = Option(true);
+ o["MultiPV"] = Option(1, 1, 500);
+ o["Emergency Move Horizon"] = Option(40, 0, 50);
+ o["Emergency Base Time"] = Option(200, 0, 60000);
+ o["Emergency Move Time"] = Option(70, 0, 5000);
+ o["Minimum Thinking Time"] = Option(20, 0, 5000);
+ o["UCI_Chess960"] = Option(false); // Just a dummy but needed by GUIs
+ o["UCI_AnalyseMode"] = Option(false);
+
+ // Any option should know its name so to be easily printed
+ for (Options::iterator it = o.begin(); it != o.end(); ++it)
+ it->second.name = it->first;
}
+ // get_option_value() implements the various get_option_value_<type>
+ // functions defined later.
- ///
- /// Variables
- ///
+ template<typename T>
+ T get_option_value(const string& optionName) {
- Options options;
+ T ret = T();
+ if (options.find(optionName) == options.end())
+ return ret;
+
+ std::istringstream ss(options[optionName].currentValue);
+ ss >> ret;
+ return ret;
+ }
+
+ // Specialization for std::string where instruction 'ss >> ret'
+ // would erroneusly tokenize a string with spaces.
+ template<>
+ string get_option_value<string>(const string& optionName) {
- // Local functions
- template<typename T> T get_option_value(const std::string& optionName);
+ if (options.find(optionName) == options.end())
+ return string();
+
+ return options[optionName].currentValue;
+ }
}
-////
-//// Functions
-////
-/// init_uci_options() initializes the UCI options. Currently, the only
-/// thing this function does is to initialize the default value of the
-/// "Threads" parameter to the number of available CPU cores.
+/// init_uci_options() initializes the UCI options. Currently, the only thing
+/// this function does is to initialize the default value of "Threads" and
+/// "Minimum Split Depth" parameters according to the number of CPU cores.
void init_uci_options() {
load_defaults(options);
- // Limit the default value of "Threads" to 7 even if we have 8 CPU cores.
- // According to Ken Dail's tests, Glaurung plays much better with 7 than
- // with 8 threads. This is weird, but it is probably difficult to find out
- // why before I have a 8-core computer to experiment with myself.
assert(options.find("Threads") != options.end());
+ assert(options.find("Minimum Split Depth") != options.end());
- options["Threads"].defaultValue = Min(cpu_count(), 7);
- options["Threads"].currentValue = Min(cpu_count(), 7);
+ Option& thr = options["Threads"];
+ Option& msd = options["Minimum Split Depth"];
- // Increase the minimum split depth when the number of CPUs is big.
- // It would probably be better to let this depend on the number of threads
- // instead.
- if(cpu_count() > 4)
- {
- assert(options.find("Minimum Split Depth") != options.end());
+ thr.defaultValue = thr.currentValue = stringify(cpu_count());
- options["Minimum Split Depth"].defaultValue = 6;
- options["Minimum Split Depth"].currentValue = 6;
- }
+ if (cpu_count() >= 8)
+ msd.defaultValue = msd.currentValue = stringify(7);
}
void print_uci_options() {
- static const char optionTypeName[][16] = {
+ const char OptTypeName[][16] = {
"spin", "combo", "check", "string", "button"
};
- for (Options::iterator it = options.begin(); it != options.end(); ++it)
- {
- const OptionValue& o = it->second;
+ // Build up a vector out of the options map and sort it according to idx
+ // field, that is the chronological insertion order in options map.
+ OptionsVector vec;
+ for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
+ vec.push_back(it->second);
- std::cout << "option name " << it->first
- << " type " << optionTypeName[o.type];
+ std::sort(vec.begin(), vec.end());
- if (o.type != BUTTON)
- {
- std::cout << " default " << o.defaultValue;
+ for (OptionsVector::const_iterator it = vec.begin(); it != vec.end(); ++it)
+ {
+ cout << "\noption name " << it->name << " type " << OptTypeName[it->type];
- if (o.type == SPIN)
- std::cout << " min " << o.minValue
- << " max " << o.maxValue;
+ if (it->type == BUTTON)
+ continue;
- else if (o.type == COMBO)
- for(ComboValues::size_type i = 0; i < o.comboValues.size(); ++i)
- std::cout << " var " << o.comboValues[i];
+ if (it->type == CHECK)
+ cout << " default " << (it->defaultValue == "1" ? "true" : "false");
+ else
+ cout << " default " << it->defaultValue;
+
+ if (it->type == SPIN)
+ cout << " min " << it->minValue << " max " << it->maxValue;
+ else if (it->type == COMBO)
+ {
+ StrVector::const_iterator itc;
+ for (itc = it->comboValues.begin(); itc != it->comboValues.end(); ++itc)
+ cout << " var " << *itc;
}
- std::cout << std::endl;
}
+ cout << endl;
}
+
/// get_option_value_bool() returns the current value of a UCI parameter of
/// type "check".
-bool get_option_value_bool(const std::string& optionName) {
+bool get_option_value_bool(const string& optionName) {
return get_option_value<bool>(optionName);
}
/// it could also be used with a "combo" parameter, where all the available
/// values are integers.
-int get_option_value_int(const std::string& optionName) {
+int get_option_value_int(const string& optionName) {
return get_option_value<int>(optionName);
}
/// get_option_value_string() returns the current value of a UCI parameter as
-/// a string. It is used with parameters of type "combo" and "string".
+/// a string. It is used with parameters of type "combo" and "string".
-const std::string get_option_value_string(const std::string& optionName) {
+string get_option_value_string(const string& optionName) {
- return get_option_value<std::string>(optionName);
+ return get_option_value<string>(optionName);
}
-/// button_was_pressed() tests whether a UCI parameter of type "button" has
-/// been selected since the last time the function was called.
+/// set_option_value() inserts a new value for a UCI parameter
-bool button_was_pressed(const std::string& buttonName) {
+void set_option_value(const string& name, const string& value) {
- if (get_option_value<bool>(buttonName))
+ if (options.find(name) == options.end())
{
- set_option_value(buttonName, "false");
- return true;
+ cout << "No such option: " << name << endl;
+ return;
}
- return false;
-}
-
+ // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
+ // value according to standard C++ convention before to store it.
+ string v(value);
+ if (v == "true")
+ v = "1";
+ else if (v == "false")
+ v = "0";
-/// set_option_value() inserts a new value for a UCI parameter. Note that
-/// the function does not check that the new value is legal for the given
-/// parameter: This is assumed to be the responsibility of the GUI.
+ // Normally it's up to the GUI to check for option's limits,
+ // but we could receive the new value directly from the user
+ // by teminal window. So let's check the bounds anyway.
+ Option& opt = options[name];
-void set_option_value(const std::string& optionName,
- const std::string& newValue) {
+ if (opt.type == CHECK && v != "0" && v != "1")
+ return;
- if (options.find(optionName) != options.end())
- options[optionName].currentValue = newValue;
- else
- std::cout << "No such option: " << optionName << std::endl;
+ else if (opt.type == SPIN)
+ {
+ int val = atoi(v.c_str());
+ if (val < opt.minValue || val > opt.maxValue)
+ return;
+ }
+ opt.currentValue = v;
}
/// push_button() is used to tell the engine that a UCI parameter of type
/// "button" has been selected:
-void push_button(const std::string& buttonName) {
+void push_button(const string& buttonName) {
set_option_value(buttonName, "true");
}
-namespace {
-
- // methods and c'tors of OptionValue class.
-
- template<typename T>
- std::string OptionValue::stringify(const T& v)
- {
- std::ostringstream ss;
- ss << v;
-
- return ss.str();
- }
-
- OptionValue::OptionValue() {}
-
- OptionValue::OptionValue(const char* def, OptionType t)
- : defaultValue(def), currentValue(def), type(t), minValue(0), maxValue(0) {}
-
- OptionValue::OptionValue(bool def)
- : defaultValue(stringify(def)), currentValue(stringify(def)), type(CHECK), minValue(0), maxValue(0) {}
-
- OptionValue::OptionValue(int def, int minv, int maxv)
- : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), minValue(minv), maxValue(maxv) {}
-
- // get_option_value is the implementation of the various
- // get_option_value_<type>, because only the option value
- // type changes a template is the proper solution.
-
- template<typename T>
- T get_option_value(const std::string& optionName) {
+/// button_was_pressed() tests whether a UCI parameter of type "button" has
+/// been selected since the last time the function was called, in this case
+/// it also resets the button.
- T ret;
+bool button_was_pressed(const string& buttonName) {
- if (options.find(optionName) != options.end())
- {
- std::istringstream ss(options[optionName].currentValue);
- ss >> ret;
- }
- return ret;
- }
+ if (!get_option_value<bool>(buttonName))
+ return false;
+ set_option_value(buttonName, "false");
+ return true;
}
projects / stockfish / blobdiff