2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2020 The Stockfish developers (see AUTHORS file)
5 Stockfish is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 Stockfish is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include "hashprobe.h"
30 #include "syzygy/tbprobe.h"
34 UCI::OptionsMap Options; // Global object
35 std::unique_ptr<HashProbeThread> hash_probe_thread;
39 /// 'On change' actions, triggered by an option's value change
40 void on_clear_hash(const Option&) { Search::clear(); }
41 void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
42 void on_logger(const Option& o) { start_logger(o); }
43 void on_threads(const Option& o) { Threads.set(size_t(o)); }
44 void on_tb_path(const Option& o) { Tablebases::init(o); }
45 void on_use_NNUE(const Option& ) { Eval::init_NNUE(); }
46 void on_eval_file(const Option& ) { Eval::init_NNUE(); }
47 void on_rpc_server_address(const Option& o) {
48 if (hash_probe_thread) {
49 hash_probe_thread->Shutdown();
52 hash_probe_thread.reset(new HashProbeThread(addr));
55 /// Our case insensitive less() function as required by UCI protocol
56 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
58 return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
59 [](char c1, char c2) { return tolower(c1) < tolower(c2); });
63 /// UCI::init() initializes the UCI options to their hard-coded default values
65 void init(OptionsMap& o) {
67 constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
69 o["Debug Log File"] << Option("", on_logger);
70 o["Contempt"] << Option(24, -100, 100);
71 o["Analysis Contempt"] << Option("Both var Off var White var Black var Both", "Both");
72 o["Threads"] << Option(1, 1, 512, on_threads);
73 o["Hash"] << Option(16, 1, MaxHashMB, on_hash_size);
74 o["Clear Hash"] << Option(on_clear_hash);
75 o["Ponder"] << Option(false);
76 o["MultiPV"] << Option(1, 1, 500);
77 o["Skill Level"] << Option(20, 0, 20);
78 o["Move Overhead"] << Option(10, 0, 5000);
79 o["Slow Mover"] << Option(100, 10, 1000);
80 o["nodestime"] << Option(0, 0, 10000);
81 o["UCI_Chess960"] << Option(false);
82 o["UCI_AnalyseMode"] << Option(false);
83 o["UCI_LimitStrength"] << Option(false);
84 o["UCI_Elo"] << Option(1350, 1350, 2850);
85 o["UCI_ShowWDL"] << Option(false);
86 o["SyzygyPath"] << Option("<empty>", on_tb_path);
87 o["SyzygyProbeDepth"] << Option(1, 1, 100);
88 o["Syzygy50MoveRule"] << Option(true);
89 o["SyzygyProbeLimit"] << Option(7, 0, 7);
90 o["Use NNUE"] << Option(false, on_use_NNUE);
91 o["EvalFile"] << Option("nn-9931db908a9b.nnue", on_eval_file);
92 o["RPCServerAddress"] << Option("<empty>", on_rpc_server_address);
96 /// operator<<() is used to print all the options default values in chronological
97 /// insertion order (the idx field) and in the format defined by the UCI protocol.
99 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
101 for (size_t idx = 0; idx < om.size(); ++idx)
102 for (const auto& it : om)
103 if (it.second.idx == idx)
105 const Option& o = it.second;
106 os << "\noption name " << it.first << " type " << o.type;
108 if (o.type == "string" || o.type == "check" || o.type == "combo")
109 os << " default " << o.defaultValue;
111 if (o.type == "spin")
112 os << " default " << int(stof(o.defaultValue))
123 /// Option class constructors and conversion operators
125 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
126 { defaultValue = currentValue = v; }
128 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
129 { defaultValue = currentValue = (v ? "true" : "false"); }
131 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
134 Option::Option(double v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
135 { defaultValue = currentValue = std::to_string(v); }
137 Option::Option(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
138 { defaultValue = v; currentValue = cur; }
140 Option::operator double() const {
141 assert(type == "check" || type == "spin");
142 return (type == "spin" ? stof(currentValue) : currentValue == "true");
145 Option::operator std::string() const {
146 assert(type == "string");
150 bool Option::operator==(const char* s) const {
151 assert(type == "combo");
152 return !CaseInsensitiveLess()(currentValue, s)
153 && !CaseInsensitiveLess()(s, currentValue);
157 /// operator<<() inits options and assigns idx in the correct printing order
159 void Option::operator<<(const Option& o) {
161 static size_t insert_order = 0;
164 idx = insert_order++;
168 /// operator=() updates currentValue and triggers on_change() action. It's up to
169 /// the GUI to check for option's limits, but we could receive the new value
170 /// from the user by console window, so let's check the bounds anyway.
172 Option& Option::operator=(const string& v) {
174 assert(!type.empty());
176 if ( (type != "button" && v.empty())
177 || (type == "check" && v != "true" && v != "false")
178 || (type == "spin" && (stof(v) < min || stof(v) > max)))
183 OptionsMap comboMap; // To have case insensitive compare
185 std::istringstream ss(defaultValue);
187 comboMap[token] << Option();
188 if (!comboMap.count(v) || v == "var")
192 if (type != "button")