]> git.sesse.net Git - stockfish/blobdiff - src/ucioption.cpp
Update copyright year
[stockfish] / src / ucioption.cpp
index d700e6d18e840aef53f2abf888fe98baf843ce42..dc76af9e42f746f8c1d799fcd464c774a55247e9 100644 (file)
@@ -1,13 +1,14 @@
 /*
-  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-2014 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 <algorithm>
 #include <cassert>
-#include <map>
-#include <string>
+#include <cstdlib>
 #include <sstream>
-#include <vector>
 
+#include "evaluate.h"
 #include "misc.h"
 #include "thread.h"
+#include "tt.h"
 #include "ucioption.h"
 
+using std::string;
 
-////
-//// 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;
-  }
-}
-
-
-/// print_uci_options() prints all the UCI options to the standard output,
-/// in the format defined by the UCI protocol.
-
-void print_uci_options() {
+UCI::OptionsMap Options; // Global object
 
-  static const char optionTypeName[][16] = {
-    "spin", "combo", "check", "string", "button"
-  };
+namespace UCI {
 
-  for (Options::iterator it = options.begin(); it != options.end(); ++it)
-  {
-      const OptionValue& o = it->second;
+/// 'On change' actions, triggered by an option's value change
+void on_logger(const Option& o) { start_logger(o); }
+void on_eval(const Option&) { Eval::init(); }
+void on_threads(const Option&) { Threads.read_uci_options(); }
+void on_hash_size(const Option& o) { TT.set_size(o); }
+void on_clear_hash(const Option&) { TT.clear(); }
 
-      std::cout << "option name " << it->first
-                << " type "       << optionTypeName[o.type];
 
-      if (o.type != BUTTON)
-      {
-          std::cout << " default " << o.defaultValue;
+/// Our case insensitive less() function as required by UCI protocol
+bool ci_less(char c1, char c2) { return tolower(c1) < tolower(c2); }
 
-          if (o.type == SPIN)
-              std::cout << " min " << o.minValue
-                        << " max " << o.maxValue;
-
-          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;
-  }
+bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
+  return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(), ci_less);
 }
 
-/// 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);
+/// init() initializes the UCI options to their hard-coded default values
+
+void init(OptionsMap& o) {
+
+  o["Write Debug Log"]             = Option(false, on_logger);
+  o["Write Search Log"]            = Option(false);
+  o["Search Log Filename"]         = Option("SearchLog.txt");
+  o["Book File"]                   = Option("book.bin");
+  o["Best Book Move"]              = Option(false);
+  o["Contempt Factor"]             = Option(0, -50,  50);
+  o["Mobility (Midgame)"]          = Option(100, 0, 200, on_eval);
+  o["Mobility (Endgame)"]          = Option(100, 0, 200, on_eval);
+  o["Pawn Structure (Midgame)"]    = Option(100, 0, 200, on_eval);
+  o["Pawn Structure (Endgame)"]    = Option(100, 0, 200, on_eval);
+  o["Passed Pawns (Midgame)"]      = Option(100, 0, 200, on_eval);
+  o["Passed Pawns (Endgame)"]      = Option(100, 0, 200, on_eval);
+  o["Space"]                       = Option(100, 0, 200, on_eval);
+  o["Aggressiveness"]              = Option(100, 0, 200, on_eval);
+  o["Cowardice"]                   = Option(100, 0, 200, on_eval);
+  o["Min Split Depth"]             = Option(0, 0, 12, on_threads);
+  o["Max Threads per Split Point"] = Option(5, 4,  8, on_threads);
+  o["Threads"]                     = Option(1, 1, MAX_THREADS, on_threads);
+  o["Idle Threads Sleep"]          = Option(true);
+  o["Hash"]                        = Option(32, 1, 8192, on_hash_size);
+  o["Clear Hash"]                  = Option(on_clear_hash);
+  o["Ponder"]                      = Option(true);
+  o["OwnBook"]                     = Option(false);
+  o["MultiPV"]                     = Option(1, 1, 500);
+  o["Skill Level"]                 = Option(20, 0, 20);
+  o["Emergency Move Horizon"]      = Option(40, 0, 50);
+  o["Emergency Base Time"]         = Option(60, 0, 30000);
+  o["Emergency Move Time"]         = Option(30, 0, 5000);
+  o["Minimum Thinking Time"]       = Option(20, 0, 5000);
+  o["Slow Mover"]                  = Option(70, 10, 1000);
+  o["UCI_Chess960"]                = Option(false);
+  o["UCI_AnalyseMode"]             = Option(false, on_eval);
 }
 
 
-/// 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.
+/// operator<<() is used to print all the options default values in chronological
+/// insertion order (the idx field) and in the format defined by the UCI protocol.
 
-int get_option_value_int(const std::string& optionName) {
-
-  return get_option_value<int>(optionName);
-}
+std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
 
+  for (size_t idx = 0; idx < om.size(); ++idx)
+      for (OptionsMap::const_iterator it = om.begin(); it != om.end(); ++it)
+          if (it->second.idx == idx)
+          {
+              const Option& o = it->second;
+              os << "\noption name " << it->first << " type " << o.type;
 
-/// 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".
+              if (o.type != "button")
+                  os << " default " << o.defaultValue;
 
-const std::string get_option_value_string(const std::string& optionName) {
+              if (o.type == "spin")
+                  os << " min " << o.min << " max " << o.max;
 
-   return get_option_value<std::string>(optionName);
+              break;
+          }
+  return os;
 }
 
 
-/// button_was_pressed() tests whether a UCI parameter of type "button" has
-/// been selected since the last time the function was called.
+/// Option c'tors and conversion operators
 
-bool button_was_pressed(const std::string& buttonName) {
+Option::Option(const char* v, Fn* f) : type("string"), min(0), max(0), idx(Options.size()), on_change(f)
+{ defaultValue = currentValue = v; }
 
-  if (get_option_value<bool>(buttonName))
-  {
-    set_option_value(buttonName, "false");
-    return true;
-  }
-
-  return false;
-}
+Option::Option(bool v, Fn* f) : type("check"), min(0), max(0), idx(Options.size()), on_change(f)
+{ defaultValue = currentValue = (v ? "true" : "false"); }
 
+Option::Option(Fn* f) : type("button"), min(0), max(0), idx(Options.size()), on_change(f)
+{}
 
-/// 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.
+Option::Option(int v, int minv, int maxv, Fn* f) : type("spin"), min(minv), max(maxv), idx(Options.size()), on_change(f)
+{ std::ostringstream ss; ss << v; defaultValue = currentValue = ss.str(); }
 
-void set_option_value(const std::string& optionName,
-                      const std::string& newValue) {
 
-  if (options.find(optionName) != options.end())
-      options[optionName].currentValue = newValue;
-  else
-      std::cout << "No such option: " << optionName << std::endl;
+Option::operator int() const {
+  assert(type == "check" || type == "spin");
+  return (type == "spin" ? atoi(currentValue.c_str()) : currentValue == "true");
 }
 
-
-/// 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) {
-
-  set_option_value(buttonName, "true");
+Option::operator std::string() const {
+  assert(type == "string");
+  return currentValue;
 }
 
 
-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();
-    }
+/// operator=() updates currentValue and triggers on_change() action. It's up to
+/// the GUI to check for option's limits, but we could receive the new value from
+/// the user by console window, so let's check the bounds anyway.
 
-    OptionValue::OptionValue() {}
+Option& Option::operator=(const string& v) {
 
-    OptionValue::OptionValue(const char* def, OptionType t)
-    : defaultValue(def), currentValue(def), type(t), minValue(0), maxValue(0) {}
+  assert(!type.empty());
 
-    OptionValue::OptionValue(bool def)
-    : defaultValue(stringify(def)), currentValue(stringify(def)), type(CHECK), minValue(0), maxValue(0) {}
+  if (   (type != "button" && v.empty())
+      || (type == "check" && v != "true" && v != "false")
+      || (type == "spin" && (atoi(v.c_str()) < min || atoi(v.c_str()) > max)))
+      return *this;
 
-    OptionValue::OptionValue(int def, int minv, int maxv)
-    : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), minValue(minv), maxValue(maxv) {}
+  if (type != "button")
+      currentValue = v;
 
-    // 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) {
-
-        T ret;
-
-        if (options.find(optionName) != options.end())
-        {
-            std::istringstream ss(options[optionName].currentValue);
-            ss >> ret;
-        }
-        return ret;
-    }
+  if (on_change)
+      (*on_change)(*this);
 
+  return *this;
 }
+
+} // namespace UCI