7-pieces Syzygy tablebase support
[stockfish] / 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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include <algorithm>
22 #include <cassert>
23 #include <ostream>
24
25 #include "misc.h"
26 #include "search.h"
27 #include "thread.h"
28 #include "tt.h"
29 #include "uci.h"
30 #include "syzygy/tbprobe.h"
31
32 using std::string;
33
34 UCI::OptionsMap Options; // Global object
35
36 namespace UCI {
37
38 /// 'On change' actions, triggered by an option's value change
39 void on_clear_hash(const Option&) { Search::clear(); }
40 void on_hash_size(const Option& o) { TT.resize(o); }
41 void on_logger(const Option& o) { start_logger(o); }
42 void on_threads(const Option& o) { Threads.set(o); }
43 void on_tb_path(const Option& o) { Tablebases::init(o); }
44
45
46 /// Our case insensitive less() function as required by UCI protocol
47 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
48
49   return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
50          [](char c1, char c2) { return tolower(c1) < tolower(c2); });
51 }
52
53
54 /// init() initializes the UCI options to their hard-coded default values
55
56 void init(OptionsMap& o) {
57
58   // at most 2^32 clusters.
59   constexpr int MaxHashMB = Is64Bit ? 131072 : 2048;
60
61   o["Debug Log File"]        << Option("", on_logger);
62   o["Contempt"]              << Option(21, -100, 100);
63   o["Analysis Contempt"]     << Option("Both var Off var White var Black var Both", "Both");
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(30, 0, 5000);
71   o["Minimum Thinking Time"] << Option(20, 0, 5000);
72   o["Slow Mover"]            << Option(84, 10, 1000);
73   o["nodestime"]             << Option(0, 0, 10000);
74   o["UCI_Chess960"]          << Option(false);
75   o["UCI_AnalyseMode"]       << Option(false);
76   o["SyzygyPath"]            << Option("<empty>", on_tb_path);
77   o["SyzygyProbeDepth"]      << Option(1, 1, 100);
78   o["Syzygy50MoveRule"]      << Option(true);
79   o["SyzygyProbeLimit"]      << Option(7, 0, 7);
80 }
81
82
83 /// operator<<() is used to print all the options default values in chronological
84 /// insertion order (the idx field) and in the format defined by the UCI protocol.
85
86 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
87
88   for (size_t idx = 0; idx < om.size(); ++idx)
89       for (const auto& it : om)
90           if (it.second.idx == idx)
91           {
92               const Option& o = it.second;
93               os << "\noption name " << it.first << " type " << o.type;
94
95               if (o.type == "string" || o.type == "check" || o.type == "combo")
96                   os << " default " << o.defaultValue;
97
98               if (o.type == "spin")
99                   os << " default " << int(stof(o.defaultValue))
100                      << " min "     << o.min
101                      << " max "     << o.max;
102
103               break;
104           }
105
106   return os;
107 }
108
109
110 /// Option class constructors and conversion operators
111
112 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
113 { defaultValue = currentValue = v; }
114
115 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
116 { defaultValue = currentValue = (v ? "true" : "false"); }
117
118 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
119 {}
120
121 Option::Option(double v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
122 { defaultValue = currentValue = std::to_string(v); }
123
124 Option::Option(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
125 { defaultValue = v; currentValue = cur; }
126
127 Option::operator double() const {
128   assert(type == "check" || type == "spin");
129   return (type == "spin" ? stof(currentValue) : currentValue == "true");
130 }
131
132 Option::operator std::string() const {
133   assert(type == "string");
134   return currentValue;
135 }
136
137 bool Option::operator==(const char* s) const {
138   assert(type == "combo");
139   return    !CaseInsensitiveLess()(currentValue, s)
140          && !CaseInsensitiveLess()(s, currentValue);
141 }
142
143
144 /// operator<<() inits options and assigns idx in the correct printing order
145
146 void Option::operator<<(const Option& o) {
147
148   static size_t insert_order = 0;
149
150   *this = o;
151   idx = insert_order++;
152 }
153
154
155 /// operator=() updates currentValue and triggers on_change() action. It's up to
156 /// the GUI to check for option's limits, but we could receive the new value from
157 /// the user by console window, so let's check the bounds anyway.
158
159 Option& Option::operator=(const string& v) {
160
161   assert(!type.empty());
162
163   if (   (type != "button" && v.empty())
164       || (type == "check" && v != "true" && v != "false")
165       || (type == "spin" && (stof(v) < min || stof(v) > max)))
166       return *this;
167
168   if (type != "button")
169       currentValue = v;
170
171   if (on_change)
172       on_change(*this);
173
174   return *this;
175 }
176
177 } // namespace UCI