/*
- 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.
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
-////
-//// Includes
-////
-
-#include <cassert>
-#include <map>
-#include <string>
+#include <cctype>
+#include <iostream>
#include <sstream>
-#include <vector>
#include "misc.h"
#include "thread.h"
#include "ucioption.h"
+using std::string;
+using std::cout;
+using std::endl;
-////
-//// Variables
-////
-
-bool Chess960 = false;
-
-
-////
-//// Local definitions
-////
-
-namespace {
-
- ///
- /// Types
- ///
-
- enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON, OPTION_TYPE_NONE };
-
- typedef std::vector<std::string> ComboValues;
-
- struct OptionValue
- {
- std::string defaultValue, currentValue;
- OptionType type;
- int minValue, maxValue;
- ComboValues comboValues;
-
- // Helper to convert a bool or an int in a std::string
- template<typename T> std::string stringify(const T& v);
-
- 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);
- };
-
- 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);
- }
-
-
- ///
- /// Variables
- ///
-
- Options options;
-
- // Local functions
- template<typename T> T get_option_value(const std::string& optionName);
-
-}
-
-////
-//// 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.
-
-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());
-
- options["Threads"].defaultValue = Min(cpu_count(), 7);
- options["Threads"].currentValue = Min(cpu_count(), 7);
-
- // 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());
-
- options["Minimum Split Depth"].defaultValue = 6;
- options["Minimum Split Depth"].currentValue = 6;
- }
-}
-
+OptionsMap Options; // Global object
-/// print_uci_options() prints all the UCI options to the standard output,
-/// in the format defined by the UCI protocol.
-void print_uci_options() {
+// Our case insensitive less() function as required by UCI protocol
+bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
- static const char optionTypeName[][16] = {
- "spin", "combo", "check", "string", "button"
- };
+ int c1, c2;
+ size_t i = 0;
- for (Options::iterator it = options.begin(); it != options.end(); ++it)
+ while (i < s1.size() && i < s2.size())
{
- const OptionValue& o = it->second;
-
- std::cout << "option name " << it->first
- << " type " << optionTypeName[o.type];
-
- if (o.type != BUTTON)
- {
- std::cout << " default " << o.defaultValue;
-
- if (o.type == SPIN)
- std::cout << " min " << o.minValue
- << " max " << o.maxValue;
+ c1 = tolower(s1[i]);
+ c2 = tolower(s2[i++]);
- else if (o.type == COMBO)
- for(ComboValues::size_type i = 0; i < o.comboValues.size(); ++i)
- std::cout << " var " << o.comboValues[i];
- }
- std::cout << std::endl;
+ if (c1 != c2)
+ return c1 < c2;
}
+ return s1.size() < s2.size();
}
-/// get_option_value_bool() returns the current value of a UCI parameter of
-/// type "check".
-
-bool get_option_value_bool(const std::string& optionName) {
-
- return get_option_value<bool>(optionName);
-}
-
-
-/// get_option_value_int() returns the value of a UCI parameter as an integer.
-/// Normally, this function will be used for a parameter of type "spin", but
-/// 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) {
-
- 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".
-const std::string get_option_value_string(const std::string& optionName) {
+// An helper to convert an integer value to a std::string
+static string int_to_string(int v) {
- return get_option_value<std::string>(optionName);
+ std::ostringstream ss;
+ ss << v;
+ return ss.str();
}
-/// button_was_pressed() tests whether a UCI parameter of type "button" has
-/// been selected since the last time the function was called.
-
-bool button_was_pressed(const std::string& buttonName) {
-
- if (get_option_value<bool>(buttonName))
- {
- set_option_value(buttonName, "false");
- return true;
- }
-
- return false;
+/// OptionsMap c'tor initializes the UCI options to their hard coded default
+/// values and initializes the default value of "Threads" and "Minimum Split Depth"
+/// parameters according to the number of CPU cores.
+
+OptionsMap::OptionsMap() {
+
+ OptionsMap& o = *this;
+
+ o["Use Search Log"] = UCIOption(false);
+ o["Search Log Filename"] = UCIOption("SearchLog.txt");
+ o["Book File"] = UCIOption("book.bin");
+ o["Best Book Move"] = UCIOption(false);
+ o["Mobility (Middle Game)"] = UCIOption(100, 0, 200);
+ o["Mobility (Endgame)"] = UCIOption(100, 0, 200);
+ o["Passed Pawns (Middle Game)"] = UCIOption(100, 0, 200);
+ o["Passed Pawns (Endgame)"] = UCIOption(100, 0, 200);
+ o["Space"] = UCIOption(100, 0, 200);
+ o["Aggressiveness"] = UCIOption(100, 0, 200);
+ o["Cowardice"] = UCIOption(100, 0, 200);
+ o["Minimum Split Depth"] = UCIOption(4, 4, 7);
+ o["Maximum Number of Threads per Split Point"] = UCIOption(5, 4, 8);
+ o["Threads"] = UCIOption(1, 1, MAX_THREADS);
+ o["Use Sleeping Threads"] = UCIOption(true);
+ o["Hash"] = UCIOption(32, 4, 8192);
+ o["Clear Hash"] = UCIOption(false, "button");
+ o["Ponder"] = UCIOption(true);
+ o["OwnBook"] = UCIOption(true);
+ o["MultiPV"] = UCIOption(1, 1, 500);
+ o["Skill Level"] = UCIOption(20, 0, 20);
+ o["Emergency Move Horizon"] = UCIOption(40, 0, 50);
+ o["Emergency Base Time"] = UCIOption(200, 0, 30000);
+ o["Emergency Move Time"] = UCIOption(70, 0, 5000);
+ o["Minimum Thinking Time"] = UCIOption(20, 0, 5000);
+ o["UCI_Chess960"] = UCIOption(false);
+ o["UCI_AnalyseMode"] = UCIOption(false);
+
+ // Set some SMP parameters accordingly to the detected CPU count
+ UCIOption& thr = o["Threads"];
+ UCIOption& msd = o["Minimum Split Depth"];
+
+ thr.defaultValue = thr.currentValue = int_to_string(cpu_count());
+
+ if (cpu_count() >= 8)
+ msd.defaultValue = msd.currentValue = int_to_string(7);
}
-/// 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.
+/// OptionsMap::print_all() returns a string with all the UCI options in chronological
+/// insertion order (the idx field) and in the format defined by the UCI protocol.
-void set_option_value(const std::string& optionName,
- const std::string& newValue) {
+string OptionsMap::print_all() const {
- if (options.find(optionName) != options.end())
- options[optionName].currentValue = newValue;
- else
- std::cout << "No such option: " << optionName << std::endl;
-}
+ std::stringstream s;
+ for (size_t i = 0; i <= size(); i++)
+ for (OptionsMap::const_iterator it = begin(); it != end(); ++it)
+ if (it->second.idx == i)
+ {
+ const UCIOption& o = it->second;
+ s << "\noption name " << it->first << " type " << o.type;
-/// push_button() is used to tell the engine that a UCI parameter of type
-/// "button" has been selected:
+ if (o.type != "button")
+ s << " default " << o.defaultValue;
-void push_button(const std::string& buttonName) {
+ if (o.type == "spin")
+ s << " min " << o.minValue << " max " << o.maxValue;
- set_option_value(buttonName, "true");
+ break;
+ }
+ return s.str();
}
-namespace {
+/// Option class c'tors
- // methods and c'tors of OptionValue class.
+UCIOption::UCIOption(const char* def) : type("string"), minValue(0), maxValue(0), idx(Options.size())
+{ defaultValue = currentValue = def; }
- template<typename T>
- std::string OptionValue::stringify(const T& v)
- {
- std::ostringstream ss;
- ss << v;
+UCIOption::UCIOption(bool def, string t) : type(t), minValue(0), maxValue(0), idx(Options.size())
+{ defaultValue = currentValue = (def ? "true" : "false"); }
- return ss.str();
- }
+UCIOption::UCIOption(int def, int minv, int maxv) : type("spin"), minValue(minv), maxValue(maxv), idx(Options.size())
+{ defaultValue = currentValue = int_to_string(def); }
- OptionValue::OptionValue() {}
- OptionValue::OptionValue(const char* def, OptionType t)
- : defaultValue(def), currentValue(def), type(t), minValue(0), maxValue(0) {}
+/// set_value() updates currentValue of the Option object. 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.
- OptionValue::OptionValue(bool def)
- : defaultValue(stringify(def)), currentValue(stringify(def)), type(CHECK), minValue(0), maxValue(0) {}
+void UCIOption::set_value(const string& v) {
- OptionValue::OptionValue(int def, int minv, int maxv)
- : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), minValue(minv), maxValue(maxv) {}
+ assert(!type.empty());
- // 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.
+ if (v.empty())
+ return;
- template<typename T>
- T get_option_value(const std::string& optionName) {
+ if ((type == "check" || type == "button") != (v == "true" || v == "false"))
+ return;
- T ret;
-
- if (options.find(optionName) != options.end())
- {
- std::istringstream ss(options[optionName].currentValue);
- ss >> ret;
- }
- return ret;
- }
+ if (type == "spin")
+ {
+ int val = atoi(v.c_str());
+ if (val < minValue || val > maxValue)
+ return;
+ }
+ currentValue = v;
}