]> git.sesse.net Git - stockfish/blob - src/ucioption.cpp
VLTC Search parameters tune
[stockfish] / src / ucioption.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
4
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.
9
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.
14
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/>.
17 */
18
19 #include <algorithm>
20 #include <cassert>
21 #include <cctype>
22 #include <cstddef>
23 #include <iosfwd>
24 #include <istream>
25 #include <map>
26 #include <ostream>
27 #include <sstream>
28 #include <string>
29
30 #include "evaluate.h"
31 #include "misc.h"
32 #include "search.h"
33 #include "syzygy/tbprobe.h"
34 #include "thread.h"
35 #include "tt.h"
36 #include "types.h"
37 #include "uci.h"
38
39 using std::string;
40
41 namespace Stockfish {
42
43 UCI::OptionsMap Options;  // Global object
44
45 namespace UCI {
46
47 // 'On change' actions, triggered by an option's value change
48 static void on_clear_hash(const Option&) { Search::clear(); }
49 static void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
50 static void on_logger(const Option& o) { start_logger(o); }
51 static void on_threads(const Option& o) { Threads.set(size_t(o)); }
52 static void on_tb_path(const Option& o) { Tablebases::init(o); }
53 static void on_eval_file(const Option&) { Eval::NNUE::init(); }
54
55 // Our case insensitive less() function as required by UCI protocol
56 bool CaseInsensitiveLess::operator()(const string& s1, const string& s2) const {
57
58     return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
59                                         [](char c1, char c2) { return tolower(c1) < tolower(c2); });
60 }
61
62
63 // Initializes the UCI options to their hard-coded default values
64 void init(OptionsMap& o) {
65
66     constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
67
68     o["Debug Log File"] << Option("", on_logger);
69     o["Threads"] << Option(1, 1, 1024, on_threads);
70     o["Hash"] << Option(16, 1, MaxHashMB, on_hash_size);
71     o["Clear Hash"] << Option(on_clear_hash);
72     o["Ponder"] << Option(false);
73     o["MultiPV"] << Option(1, 1, 500);
74     o["Skill Level"] << Option(20, 0, 20);
75     o["Move Overhead"] << Option(10, 0, 5000);
76     o["Slow Mover"] << Option(100, 10, 1000);
77     o["nodestime"] << Option(0, 0, 10000);
78     o["UCI_Chess960"] << Option(false);
79     o["UCI_AnalyseMode"] << Option(false);
80     o["UCI_LimitStrength"] << Option(false);
81     o["UCI_Elo"] << Option(1320, 1320, 3190);
82     o["UCI_ShowWDL"] << Option(false);
83     o["SyzygyPath"] << Option("<empty>", on_tb_path);
84     o["SyzygyProbeDepth"] << Option(1, 1, 100);
85     o["Syzygy50MoveRule"] << Option(true);
86     o["SyzygyProbeLimit"] << Option(7, 0, 7);
87     o["EvalFile"] << Option(EvalFileDefaultName, on_eval_file);
88 }
89
90
91 // Used to print all the options default values in chronological
92 // insertion order (the idx field) and in the format defined by the UCI protocol.
93 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
94
95     for (size_t idx = 0; idx < om.size(); ++idx)
96         for (const auto& it : om)
97             if (it.second.idx == idx)
98             {
99                 const Option& o = it.second;
100                 os << "\noption name " << it.first << " type " << o.type;
101
102                 if (o.type == "string" || o.type == "check" || o.type == "combo")
103                     os << " default " << o.defaultValue;
104
105                 if (o.type == "spin")
106                     os << " default " << int(stof(o.defaultValue)) << " min " << o.min << " max "
107                        << o.max;
108
109                 break;
110             }
111
112     return os;
113 }
114
115
116 // Option class constructors and conversion operators
117
118 Option::Option(const char* v, OnChange f) :
119     type("string"),
120     min(0),
121     max(0),
122     on_change(f) {
123     defaultValue = currentValue = v;
124 }
125
126 Option::Option(bool v, OnChange f) :
127     type("check"),
128     min(0),
129     max(0),
130     on_change(f) {
131     defaultValue = currentValue = (v ? "true" : "false");
132 }
133
134 Option::Option(OnChange f) :
135     type("button"),
136     min(0),
137     max(0),
138     on_change(f) {}
139
140 Option::Option(double v, int minv, int maxv, OnChange f) :
141     type("spin"),
142     min(minv),
143     max(maxv),
144     on_change(f) {
145     defaultValue = currentValue = std::to_string(v);
146 }
147
148 Option::Option(const char* v, const char* cur, OnChange f) :
149     type("combo"),
150     min(0),
151     max(0),
152     on_change(f) {
153     defaultValue = v;
154     currentValue = cur;
155 }
156
157 Option::operator int() const {
158     assert(type == "check" || type == "spin");
159     return (type == "spin" ? std::stoi(currentValue) : currentValue == "true");
160 }
161
162 Option::operator std::string() const {
163     assert(type == "string");
164     return currentValue;
165 }
166
167 bool Option::operator==(const char* s) const {
168     assert(type == "combo");
169     return !CaseInsensitiveLess()(currentValue, s) && !CaseInsensitiveLess()(s, currentValue);
170 }
171
172
173 // Inits options and assigns idx in the correct printing order
174
175 void Option::operator<<(const Option& o) {
176
177     static size_t insert_order = 0;
178
179     *this = o;
180     idx   = insert_order++;
181 }
182
183
184 // Updates currentValue and triggers on_change() action. It's up to
185 // the GUI to check for option's limits, but we could receive the new value
186 // from the user by console window, so let's check the bounds anyway.
187 Option& Option::operator=(const string& v) {
188
189     assert(!type.empty());
190
191     if ((type != "button" && type != "string" && v.empty())
192         || (type == "check" && v != "true" && v != "false")
193         || (type == "spin" && (stof(v) < min || stof(v) > max)))
194         return *this;
195
196     if (type == "combo")
197     {
198         OptionsMap         comboMap;  // To have case insensitive compare
199         string             token;
200         std::istringstream ss(defaultValue);
201         while (ss >> token)
202             comboMap[token] << Option();
203         if (!comboMap.count(v) || v == "var")
204             return *this;
205     }
206
207     if (type != "button")
208         currentValue = v;
209
210     if (on_change)
211         on_change(*this);
212
213     return *this;
214 }
215
216 }  // namespace UCI
217
218 }  // namespace Stockfish