2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2022 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/>.
30 #include "syzygy/tbprobe.h"
36 UCI::OptionsMap Options; // Global object
40 /// 'On change' actions, triggered by an option's value change
41 void on_clear_hash(const Option&) { Search::clear(); }
42 void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
43 void on_logger(const Option& o) { start_logger(o); }
44 void on_threads(const Option& o) { Threads.set(size_t(o)); }
45 void on_tb_path(const Option& o) { Tablebases::init(o); }
46 void on_use_NNUE(const Option& ) { Eval::NNUE::init(); }
47 void on_eval_file(const Option& ) { Eval::NNUE::init(); }
49 /// Our case insensitive less() function as required by UCI protocol
50 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
52 return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
53 [](char c1, char c2) { return tolower(c1) < tolower(c2); });
57 /// UCI::init() initializes the UCI options to their hard-coded default values
59 void init(OptionsMap& o) {
61 constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
63 o["Debug Log File"] << Option("", on_logger);
64 o["Threads"] << Option(1, 1, 512, on_threads);
65 o["Hash"] << Option(16, 1, MaxHashMB, on_hash_size);
66 o["Clear Hash"] << Option(on_clear_hash);
67 o["Ponder"] << Option(false);
68 o["MultiPV"] << Option(1, 1, 500);
69 o["Skill Level"] << Option(20, 0, 20);
70 o["Move Overhead"] << Option(10, 0, 5000);
71 o["Slow Mover"] << Option(100, 10, 1000);
72 o["nodestime"] << Option(0, 0, 10000);
73 o["UCI_Chess960"] << Option(false);
74 o["UCI_AnalyseMode"] << Option(false);
75 o["UCI_LimitStrength"] << Option(false);
76 o["UCI_Elo"] << Option(1350, 1350, 2850);
77 o["UCI_ShowWDL"] << Option(false);
78 o["SyzygyPath"] << Option("<empty>", on_tb_path);
79 o["SyzygyProbeDepth"] << Option(1, 1, 100);
80 o["Syzygy50MoveRule"] << Option(true);
81 o["SyzygyProbeLimit"] << Option(7, 0, 7);
82 o["Use NNUE"] << Option(true, on_use_NNUE);
83 o["EvalFile"] << Option(EvalFileDefaultName, on_eval_file);
87 /// operator<<() is used to print all the options default values in chronological
88 /// insertion order (the idx field) and in the format defined by the UCI protocol.
90 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
92 for (size_t idx = 0; idx < om.size(); ++idx)
93 for (const auto& it : om)
94 if (it.second.idx == idx)
96 const Option& o = it.second;
97 os << "\noption name " << it.first << " type " << o.type;
99 if (o.type == "string" || o.type == "check" || o.type == "combo")
100 os << " default " << o.defaultValue;
102 if (o.type == "spin")
103 os << " default " << int(stof(o.defaultValue))
114 /// Option class constructors and conversion operators
116 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
117 { defaultValue = currentValue = v; }
119 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
120 { defaultValue = currentValue = (v ? "true" : "false"); }
122 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
125 Option::Option(double v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
126 { defaultValue = currentValue = std::to_string(v); }
128 Option::Option(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
129 { defaultValue = v; currentValue = cur; }
131 Option::operator double() const {
132 assert(type == "check" || type == "spin");
133 return (type == "spin" ? stof(currentValue) : currentValue == "true");
136 Option::operator std::string() const {
137 assert(type == "string");
141 bool Option::operator==(const char* s) const {
142 assert(type == "combo");
143 return !CaseInsensitiveLess()(currentValue, s)
144 && !CaseInsensitiveLess()(s, currentValue);
148 /// operator<<() inits options and assigns idx in the correct printing order
150 void Option::operator<<(const Option& o) {
152 static size_t insert_order = 0;
155 idx = insert_order++;
159 /// operator=() updates currentValue and triggers on_change() action. It's up to
160 /// the GUI to check for option's limits, but we could receive the new value
161 /// from the user by console window, so let's check the bounds anyway.
163 Option& Option::operator=(const string& v) {
165 assert(!type.empty());
167 if ( (type != "button" && type != "string" && v.empty())
168 || (type == "check" && v != "true" && v != "false")
169 || (type == "spin" && (stof(v) < min || stof(v) > max)))
174 OptionsMap comboMap; // To have case insensitive compare
176 std::istringstream ss(defaultValue);
178 comboMap[token] << Option();
179 if (!comboMap.count(v) || v == "var")
183 if (type != "button")
194 } // namespace Stockfish