/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008 Marco Costalba
+ Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
//// Includes
////
+#include <algorithm>
#include <cassert>
+#include <map>
#include <string>
#include <sstream>
#include <vector>
#include "thread.h"
#include "ucioption.h"
-
-////
-//// Variables
-////
-
-bool Chess960 = false;
-
+using std::string;
////
//// Local definitions
enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
- typedef std::vector<std::string> ComboValues;
+ typedef std::vector<string> ComboValues;
struct Option {
- std::string name, defaultValue, currentValue;
+ string name, defaultValue, currentValue;
OptionType type;
+ size_t idx;
int minValue, maxValue;
ComboValues comboValues;
- Option(const char* name, const char* defaultValue, OptionType = STRING);
- Option(const char* name, bool defaultValue, OptionType = CHECK);
- Option(const char* name, int defaultValue, int minValue, int maxValue);
+ Option();
+ Option(const char* defaultValue, OptionType = STRING);
+ Option(bool defaultValue, OptionType = CHECK);
+ Option(int defaultValue, int minValue, int maxValue);
+
+ bool operator<(const Option& o) const { return this->idx < o.idx; }
};
- typedef std::vector<Option> Options;
+ typedef std::map<string, Option> Options;
///
/// Constants
///
- // load_defaults populates the options vector with the hard
+ // load_defaults populates the options map with the hard
// coded names and default values.
void load_defaults(Options& o) {
- o.push_back(Option("Use Search Log", false));
- o.push_back(Option("Search Log Filename", "SearchLog.txt"));
- o.push_back(Option("Book File", "book.bin"));
- o.push_back(Option("Mobility (Middle Game)", 100, 0, 200));
- o.push_back(Option("Mobility (Endgame)", 100, 0, 200));
- o.push_back(Option("Pawn Structure (Middle Game)", 100, 0, 200));
- o.push_back(Option("Pawn Structure (Endgame)", 100, 0, 200));
- o.push_back(Option("Passed Pawns (Middle Game)", 100, 0, 200));
- o.push_back(Option("Passed Pawns (Endgame)", 100, 0, 200));
- o.push_back(Option("Space", 100, 0, 200));
- o.push_back(Option("Aggressiveness", 100, 0, 200));
- o.push_back(Option("Cowardice", 100, 0, 200));
- o.push_back(Option("King Safety Curve", "Quadratic", COMBO));
-
- o.back().comboValues.push_back("Quadratic");
- o.back().comboValues.push_back("Linear"); /*, "From File"*/
-
- o.push_back(Option("King Safety Coefficient", 40, 1, 100));
- o.push_back(Option("King Safety X Intercept", 0, 0, 20));
- o.push_back(Option("King Safety Max Slope", 30, 10, 100));
- o.push_back(Option("King Safety Max Value", 500, 100, 1000));
- o.push_back(Option("Queen Contact Check Bonus", 3, 0, 8));
- o.push_back(Option("Queen Check Bonus", 2, 0, 4));
- o.push_back(Option("Rook Check Bonus", 1, 0, 4));
- o.push_back(Option("Bishop Check Bonus", 1, 0, 4));
- o.push_back(Option("Knight Check Bonus", 1, 0, 4));
- o.push_back(Option("Discovered Check Bonus", 3, 0, 8));
- o.push_back(Option("Mate Threat Bonus", 3, 0, 8));
- o.push_back(Option("Check Extension (PV nodes)", 2, 0, 2));
- o.push_back(Option("Check Extension (non-PV nodes)", 1, 0, 2));
- o.push_back(Option("Single Reply Extension (PV nodes)", 2, 0, 2));
- o.push_back(Option("Single Reply Extension (non-PV nodes)", 2, 0, 2));
- o.push_back(Option("Mate Threat Extension (PV nodes)", 0, 0, 2));
- o.push_back(Option("Mate Threat Extension (non-PV nodes)", 0, 0, 2));
- o.push_back(Option("Pawn Push to 7th Extension (PV nodes)", 1, 0, 2));
- o.push_back(Option("Pawn Push to 7th Extension (non-PV nodes)", 1, 0, 2));
- o.push_back(Option("Passed Pawn Extension (PV nodes)", 1, 0, 2));
- o.push_back(Option("Passed Pawn Extension (non-PV nodes)", 0, 0, 2));
- o.push_back(Option("Pawn Endgame Extension (PV nodes)", 2, 0, 2));
- o.push_back(Option("Pawn Endgame Extension (non-PV nodes)", 2, 0, 2));
- o.push_back(Option("Full Depth Moves (PV nodes)", 14, 1, 100));
- o.push_back(Option("Full Depth Moves (non-PV nodes)", 3, 1, 100));
- o.push_back(Option("Threat Depth", 5, 0, 100));
- o.push_back(Option("Selective Plies", 7, 0, 10));
- o.push_back(Option("Null driven IID", false));
- o.push_back(Option("Futility Pruning (Main Search)", true));
- o.push_back(Option("Futility Pruning (Quiescence Search)", true));
- o.push_back(Option("Futility Margin (Quiescence Search)", 50, 0, 1000));
- o.push_back(Option("Futility Margin Scale Factor (Main Search)", 100, 0, 1000));
- o.push_back(Option("Maximum Razoring Depth", 3, 0, 4));
- o.push_back(Option("Razoring Margin", 300, 150, 600));
- o.push_back(Option("LSN filtering", true));
- o.push_back(Option("LSN Time Margin (sec)", 4, 1, 10));
- o.push_back(Option("LSN Value Margin", 200, 100, 600));
- o.push_back(Option("Randomness", 0, 0, 10));
- o.push_back(Option("Minimum Split Depth", 4, 4, 7));
- o.push_back(Option("Maximum Number of Threads per Split Point", 5, 4, 8));
- o.push_back(Option("Threads", 1, 1, 8));
- o.push_back(Option("Hash", 32, 4, 4096));
- o.push_back(Option("Clear Hash", false, BUTTON));
- o.push_back(Option("Ponder", true));
- o.push_back(Option("OwnBook", true));
- o.push_back(Option("MultiPV", 1, 1, 500));
- o.push_back(Option("UCI_ShowCurrLine", false));
- o.push_back(Option("UCI_Chess960", false));
+ 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["Randomness"] = Option(0, 0, 10);
+ 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["UCI_Chess960"] = Option(false);
+ 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;
}
///
Options options;
- // Local functions
- Options::iterator option_with_name(const std::string& optionName);
-
// stringify converts a value of type T to a std::string
template<typename T>
- std::string stringify(const T& v) {
+ string stringify(const T& v) {
std::ostringstream ss;
ss << v;
return ss.str();
}
- // We want conversion from a bool value to be "true" or "false",
- // not "1" or "0", so add a specialization for bool type.
- template<>
- std::string stringify<bool>(const bool& v) {
-
- return v ? "true" : "false";
- }
// get_option_value implements the various get_option_value_<type>
// functions defined later, because only the option value
// type changes a template seems a proper solution.
template<typename T>
- T get_option_value(const std::string& optionName) {
+ T get_option_value(const string& optionName) {
T ret = T();
- Options::iterator it = option_with_name(optionName);
-
- if (it != options.end())
- {
- std::istringstream ss(it->currentValue);
- ss >> ret;
- } else
- assert(false);
+ if (options.find(optionName) == options.end())
+ return ret;
+ std::istringstream ss(options[optionName].currentValue);
+ ss >> ret;
return ret;
}
- // Unfortunatly we need a specialization to convert "false" and "true"
- // to proper bool values. The culprit is that we use a non standard way
- // to store a bool value in a string, in particular we use "false" and
- // "true" instead of "0" and "1" due to how UCI protocol works.
+ // Specialization for std::string where instruction 'ss >> ret;'
+ // would erroneusly tokenize a string with spaces.
template<>
- bool get_option_value<bool>(const std::string& optionName) {
+ string get_option_value<string>(const string& optionName) {
- Options::iterator it = option_with_name(optionName);
+ if (options.find(optionName) == options.end())
+ return string();
- return it != options.end() && it->currentValue == "true";
+ return options[optionName].currentValue;
}
+
}
////
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.
- Options::iterator it = option_with_name("Threads");
-
- assert(it != options.end());
+ // Set optimal value for parameter "Minimum Split Depth"
+ // according to number of available cores.
+ assert(options.find("Threads") != options.end());
+ assert(options.find("Minimum Split Depth") != options.end());
- it->defaultValue = stringify(Min(cpu_count(), 7));
- it->currentValue = stringify(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)
- {
- it = option_with_name("Minimum Split Depth");
+ Option& thr = options["Threads"];
+ Option& msd = options["Minimum Split Depth"];
- assert(it != options.end());
+ thr.defaultValue = thr.currentValue = stringify(cpu_count());
- it->defaultValue = "6";
- it->currentValue = "6";
- }
+ if (cpu_count() >= 8)
+ msd.defaultValue = msd.currentValue = stringify(7);
}
"spin", "combo", "check", "string", "button"
};
- for (Options::iterator it = options.begin(); it != options.end(); ++it)
+ // 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.
+ std::vector<Option> vec;
+ for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
+ vec.push_back(it->second);
+
+ std::sort(vec.begin(), vec.end());
+
+ for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
{
- std::cout << "option name " << it->name
- << " type " << optionTypeName[it->type];
+ std::cout << "\noption name " << it->name
+ << " type " << optionTypeName[it->type];
- if (it->type != BUTTON)
- {
- std::cout << " default " << it->defaultValue;
+ if (it->type == BUTTON)
+ continue;
- if (it->type == SPIN)
- std::cout << " min " << it->minValue
- << " max " << it->maxValue;
+ if (it->type == CHECK)
+ std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
+ else
+ std::cout << " default " << it->defaultValue;
- else if (it->type == COMBO)
- for(ComboValues::iterator itc = it->comboValues.begin();
- itc != it->comboValues.end(); ++itc)
- std::cout << " var " << *itc;
- }
- std::cout << std::endl;
+ if (it->type == SPIN)
+ std::cout << " min " << it->minValue << " max " << it->maxValue;
+ else if (it->type == COMBO)
+ for (ComboValues::const_iterator itc = it->comboValues.begin();
+ itc != it->comboValues.end(); ++itc)
+ std::cout << " var " << *itc;
}
+ std::cout << std::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. 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.
+
+void set_option_value(const string& name, const string& value) {
-bool button_was_pressed(const std::string& buttonName) {
+ // 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";
- if (get_option_value<bool>(buttonName))
+ if (options.find(name) == options.end())
{
- set_option_value(buttonName, "false");
- return true;
+ std::cout << "No such option: " << name << std::endl;
+ return;
}
- return false;
-}
-
-
-/// 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;
- Options::iterator it = option_with_name(optionName);
+ else if (opt.type == SPIN)
+ {
+ int val = atoi(v.c_str());
+ if (val < opt.minValue || val > opt.maxValue)
+ return;
+ }
- if (it != options.end())
- it->currentValue = newValue;
- else
- std::cout << "No such option: " << optionName << std::endl;
+ 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 {
+/// 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.
+
+bool button_was_pressed(const string& buttonName) {
- // Define constructors of Option class.
+ if (!get_option_value<bool>(buttonName))
+ return false;
- Option::Option(const char* nm, const char* def, OptionType t)
- : name(nm), defaultValue(def), currentValue(def), type(t), minValue(0), maxValue(0) {}
+ set_option_value(buttonName, "false");
+ return true;
+}
+
+
+namespace {
- Option::Option(const char* nm, bool def, OptionType t)
- : name(nm), defaultValue(stringify(def)), currentValue(stringify(def)), type(t), minValue(0), maxValue(0) {}
+ // Define constructors of Option class.
- Option::Option(const char* nm, int def, int minv, int maxv)
- : name(nm), defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), minValue(minv), maxValue(maxv) {}
+ Option::Option() {} // To allow insertion in a std::map
- // option_with_name() tries to find a UCI option with a given
- // name. It returns an iterator to the UCI option or to options.end(),
- // depending on whether an option with the given name exists.
+ Option::Option(const char* def, OptionType t)
+ : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
- Options::iterator option_with_name(const std::string& optionName) {
+ Option::Option(bool def, OptionType t)
+ : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
- for (Options::iterator it = options.begin(); it != options.end(); ++it)
- if (it->name == optionName)
- return it;
+ Option::Option(int def, int minv, int maxv)
+ : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
- return options.end();
- }
}