git.sesse.net Git - stockfish/blob - src/ucioption.cpp

   1 /*
   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-2009 Marco Costalba
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20
  21 ////
  22 //// Includes
  23 ////
  24
  25 #include <algorithm>
  26 #include <cassert>
  27 #include <map>
  28 #include <string>
  29 #include <sstream>
  30 #include <vector>
  31
  32 #include "misc.h"
  33 #include "thread.h"
  34 #include "ucioption.h"
  35
  36 using std::string;
  37
  38 ////
  39 //// Local definitions
  40 ////
  41
  42 namespace {
  43
  44   ///
  45   /// Types
  46   ///
  47
  48   enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
  49
  50   typedef std::vector<string> ComboValues;
  51
  52   struct Option {
  53
  54     string name, defaultValue, currentValue;
  55     OptionType type;
  56     size_t idx;
  57     int minValue, maxValue;
  58     ComboValues comboValues;
  59
  60     Option();
  61     Option(const char* defaultValue, OptionType = STRING);
  62     Option(bool defaultValue, OptionType = CHECK);
  63     Option(int defaultValue, int minValue, int maxValue);
  64
  65     bool operator<(const Option& o) const { return this->idx < o.idx; }
  66   };
  67
  68   typedef std::map<string, Option> Options;
  69
  70   ///
  71   /// Constants
  72   ///
  73
  74   // load_defaults populates the options map with the hard
  75   // coded names and default values.
  76
  77   void load_defaults(Options& o) {
  78
  79     o["Use Search Log"] = Option(false);
  80     o["Search Log Filename"] = Option("SearchLog.txt");
  81     o["Book File"] = Option("book.bin");
  82     o["Mobility (Middle Game)"] = Option(100, 0, 200);
  83     o["Mobility (Endgame)"] = Option(100, 0, 200);
  84     o["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
  85     o["Pawn Structure (Endgame)"] = Option(100, 0, 200);
  86     o["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
  87     o["Passed Pawns (Endgame)"] = Option(100, 0, 200);
  88     o["Space"] = Option(100, 0, 200);
  89     o["Aggressiveness"] = Option(100, 0, 200);
  90     o["Cowardice"] = Option(100, 0, 200);
  91     o["King Safety Curve"] = Option("Quadratic", COMBO);
  92
  93        o["King Safety Curve"].comboValues.push_back("Quadratic");
  94        o["King Safety Curve"].comboValues.push_back("Linear");  /*, "From File"*/
  95
  96     o["King Safety Coefficient"] = Option(40, 1, 100);
  97     o["King Safety X Intercept"] = Option(0, 0, 20);
  98     o["King Safety Max Slope"] = Option(30, 10, 100);
  99     o["King Safety Max Value"] = Option(500, 100, 1000);
 100     o["Queen Contact Check Bonus"] = Option(3, 0, 8);
 101     o["Queen Check Bonus"] = Option(2, 0, 4);
 102     o["Rook Check Bonus"] = Option(1, 0, 4);
 103     o["Bishop Check Bonus"] = Option(1, 0, 4);
 104     o["Knight Check Bonus"] = Option(1, 0, 4);
 105     o["Discovered Check Bonus"] = Option(3, 0, 8);
 106     o["Mate Threat Bonus"] = Option(3, 0, 8);
 107     o["Check Extension (PV nodes)"] = Option(2, 0, 2);
 108     o["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
 109     o["Single Evasion Extension (PV nodes)"] = Option(2, 0, 2);
 110     o["Single Evasion Extension (non-PV nodes)"] = Option(2, 0, 2);
 111     o["Mate Threat Extension (PV nodes)"] = Option(0, 0, 2);
 112     o["Mate Threat Extension (non-PV nodes)"] = Option(0, 0, 2);
 113     o["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
 114     o["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
 115     o["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
 116     o["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
 117     o["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
 118     o["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
 119     o["Full Depth Moves (PV nodes)"] = Option(10, 1, 100);
 120     o["Full Depth Moves (non-PV nodes)"] = Option(3, 1, 100);
 121     o["Threat Depth"] = Option(5, 0, 100);
 122     o["Randomness"] = Option(0, 0, 10);
 123     o["Minimum Split Depth"] = Option(4, 4, 7);
 124     o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
 125     o["Threads"] = Option(1, 1, THREAD_MAX);
 126     o["Hash"] = Option(32, 4, 2048);
 127     o["Clear Hash"] = Option(false, BUTTON);
 128     o["New Game"] = Option(false, BUTTON);
 129     o["Ponder"] = Option(true);
 130     o["OwnBook"] = Option(true);
 131     o["MultiPV"] = Option(1, 1, 500);
 132     o["UCI_ShowCurrLine"] = Option(false);
 133     o["UCI_Chess960"] = Option(false);
 134     o["UCI_AnalyseMode"] = Option(false);
 135
 136     // Any option should know its name so to be easily printed
 137     for (Options::iterator it = o.begin(); it != o.end(); ++it)
 138         it->second.name = it->first;
 139   }
 140
 141   ///
 142   /// Variables
 143   ///
 144
 145   Options options;
 146
 147   // stringify converts a value of type T to a std::string
 148   template<typename T>
 149   string stringify(const T& v) {
 150
 151      std::ostringstream ss;
 152      ss << v;
 153      return ss.str();
 154   }
 155
 156
 157   // get_option_value implements the various get_option_value_<type>
 158   // functions defined later, because only the option value
 159   // type changes a template seems a proper solution.
 160
 161   template<typename T>
 162   T get_option_value(const string& optionName) {
 163
 164       T ret = T();
 165       if (options.find(optionName) == options.end())
 166           return ret;
 167
 168       std::istringstream ss(options[optionName].currentValue);
 169       ss >> ret;
 170       return ret;
 171   }
 172
 173   // Specialization for std::string where instruction 'ss >> ret;'
 174   // would erroneusly tokenize a string with spaces.
 175
 176   template<>
 177   string get_option_value<string>(const string& optionName) {
 178
 179       if (options.find(optionName) == options.end())
 180           return string();
 181
 182       return options[optionName].currentValue;
 183   }
 184
 185 }
 186
 187 ////
 188 //// Functions
 189 ////
 190
 191 /// init_uci_options() initializes the UCI options.  Currently, the only
 192 /// thing this function does is to initialize the default value of the
 193 /// "Threads" parameter to the number of available CPU cores.
 194
 195 void init_uci_options() {
 196
 197   load_defaults(options);
 198
 199   // Set optimal value for parameter "Minimum Split Depth"
 200   // according to number of available cores.
 201   assert(options.find("Threads") != options.end());
 202   assert(options.find("Minimum Split Depth") != options.end());
 203
 204   Option& thr = options["Threads"];
 205   Option& msd = options["Minimum Split Depth"];
 206
 207   thr.defaultValue = thr.currentValue = stringify(cpu_count());
 208
 209   if (cpu_count() >= 8)
 210       msd.defaultValue = msd.currentValue = stringify(7);
 211 }
 212
 213
 214 /// print_uci_options() prints all the UCI options to the standard output,
 215 /// in the format defined by the UCI protocol.
 216
 217 void print_uci_options() {
 218
 219   static const char optionTypeName[][16] = {
 220     "spin", "combo", "check", "string", "button"
 221   };
 222
 223   // Build up a vector out of the options map and sort it according to idx
 224   // field, that is the chronological insertion order in options map.
 225   std::vector<Option> vec;
 226   for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
 227       vec.push_back(it->second);
 228
 229   std::sort(vec.begin(), vec.end());
 230
 231   for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
 232   {
 233       std::cout << "\noption name " << it->name
 234                 << " type "         << optionTypeName[it->type];
 235
 236       if (it->type == BUTTON)
 237           continue;
 238
 239       if (it->type == CHECK)
 240           std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
 241       else
 242           std::cout << " default " << it->defaultValue;
 243
 244       if (it->type == SPIN)
 245           std::cout << " min " << it->minValue << " max " << it->maxValue;
 246       else if (it->type == COMBO)
 247           for (ComboValues::const_iterator itc = it->comboValues.begin();
 248               itc != it->comboValues.end(); ++itc)
 249               std::cout << " var " << *itc;
 250   }
 251   std::cout << std::endl;
 252 }
 253
 254
 255 /// get_option_value_bool() returns the current value of a UCI parameter of
 256 /// type "check".
 257
 258 bool get_option_value_bool(const string& optionName) {
 259
 260   return get_option_value<bool>(optionName);
 261 }
 262
 263
 264 /// get_option_value_int() returns the value of a UCI parameter as an integer.
 265 /// Normally, this function will be used for a parameter of type "spin", but
 266 /// it could also be used with a "combo" parameter, where all the available
 267 /// values are integers.
 268
 269 int get_option_value_int(const string& optionName) {
 270
 271   return get_option_value<int>(optionName);
 272 }
 273
 274
 275 /// get_option_value_string() returns the current value of a UCI parameter as
 276 /// a string. It is used with parameters of type "combo" and "string".
 277
 278 string get_option_value_string(const string& optionName) {
 279
 280    return get_option_value<string>(optionName);
 281 }
 282
 283
 284 /// set_option_value() inserts a new value for a UCI parameter. Note that
 285 /// the function does not check that the new value is legal for the given
 286 /// parameter: This is assumed to be the responsibility of the GUI.
 287
 288 void set_option_value(const string& name, const string& value) {
 289
 290   // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
 291   // value according to standard C++ convention before to store it.
 292   string v(value);
 293   if (v == "true")
 294       v = "1";
 295   else if (v == "false")
 296       v = "0";
 297
 298   if (options.find(name) != options.end())
 299       options[name].currentValue = v;
 300   else
 301       std::cout << "No such option: " << name << std::endl;
 302 }
 303
 304
 305 /// push_button() is used to tell the engine that a UCI parameter of type
 306 /// "button" has been selected:
 307
 308 void push_button(const string& buttonName) {
 309
 310   set_option_value(buttonName, "true");
 311 }
 312
 313
 314 /// button_was_pressed() tests whether a UCI parameter of type "button" has
 315 /// been selected since the last time the function was called, in this case
 316 /// it also resets the button.
 317
 318 bool button_was_pressed(const string& buttonName) {
 319
 320   if (!get_option_value<bool>(buttonName))
 321       return false;
 322
 323   set_option_value(buttonName, "false");
 324   return true;
 325 }
 326
 327
 328 namespace {
 329
 330   // Define constructors of Option class.
 331
 332   Option::Option() {} // To allow insertion in a std::map
 333
 334   Option::Option(const char* def, OptionType t)
 335   : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
 336
 337   Option::Option(bool def, OptionType t)
 338   : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
 339
 340   Option::Option(int def, int minv, int maxv)
 341   : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
 342
 343 }