Retire 'Cowardice' and 'Aggressiveness' UCI options
[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-2012 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include <algorithm>
21 #include <cassert>
22 #include <cstdlib>
23 #include <sstream>
24
25 #include "evaluate.h"
26 #include "misc.h"
27 #include "thread.h"
28 #include "tt.h"
29 #include "ucioption.h"
30
31 using std::string;
32
33 UCI::OptionsMap Options; // Global object
34
35 namespace UCI {
36
37 /// 'On change' actions, triggered by an option's value change
38 void on_logger(const Option& o) { start_logger(o); }
39 void on_eval(const Option&) { Eval::init(); }
40 void on_threads(const Option&) { Threads.read_uci_options(); }
41 void on_hash_size(const Option& o) { TT.set_size(o); }
42 void on_clear_hash(const Option&) { TT.clear(); }
43
44
45 /// Our case insensitive less() function as required by UCI protocol
46 bool ci_less(char c1, char c2) { return tolower(c1) < tolower(c2); }
47
48 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
49   return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(), ci_less);
50 }
51
52
53 /// init() initializes the UCI options to their hard coded default values
54 /// and initializes the default value of "Threads" and "Min Split Depth"
55 /// parameters according to the number of CPU cores detected.
56
57 void init(OptionsMap& o) {
58
59   int cpus = std::min(cpu_count(), MAX_THREADS);
60   int msd = cpus < 8 ? 4 : 7;
61
62   o["Use Debug Log"]               = Option(false, on_logger);
63   o["Use Search Log"]              = Option(false);
64   o["Search Log Filename"]         = Option("SearchLog.txt");
65   o["Book File"]                   = Option("book.bin");
66   o["Best Book Move"]              = Option(false);
67   o["Contempt Factor"]             = Option(0, -50,  50);
68   o["Mobility (Middle Game)"]      = Option(100, 0, 200, on_eval);
69   o["Mobility (Endgame)"]          = Option(100, 0, 200, on_eval);
70   o["Passed Pawns (Middle Game)"]  = Option(100, 0, 200, on_eval);
71   o["Passed Pawns (Endgame)"]      = Option(100, 0, 200, on_eval);
72   o["Space"]                       = Option(100, 0, 200, on_eval);
73   o["Min Split Depth"]             = Option(msd, 4, 7, on_threads);
74   o["Max Threads per Split Point"] = Option(5, 4, 8, on_threads);
75   o["Threads"]                     = Option(cpus, 1, MAX_THREADS, on_threads);
76   o["Use Sleeping Threads"]        = Option(true, on_threads);
77   o["Hash"]                        = Option(32, 4, 8192, on_hash_size);
78   o["Clear Hash"]                  = Option(on_clear_hash);
79   o["Ponder"]                      = Option(true);
80   o["OwnBook"]                     = Option(false);
81   o["MultiPV"]                     = Option(1, 1, 500);
82   o["Skill Level"]                 = Option(20, 0, 20);
83   o["Emergency Move Horizon"]      = Option(40, 0, 50);
84   o["Emergency Base Time"]         = Option(200, 0, 30000);
85   o["Emergency Move Time"]         = Option(70, 0, 5000);
86   o["Minimum Thinking Time"]       = Option(20, 0, 5000);
87   o["Slow Mover"]                  = Option(100, 10, 1000);
88   o["UCI_Chess960"]                = Option(false);
89   o["UCI_AnalyseMode"]             = Option(false, on_eval);
90 }
91
92
93 /// operator<<() is used to print all the options default values in chronological
94 /// insertion order (the idx field) and in the format defined by the UCI protocol.
95
96 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
97
98   for (size_t idx = 0; idx < om.size(); idx++)
99       for (OptionsMap::const_iterator it = om.begin(); it != om.end(); ++it)
100           if (it->second.idx == idx)
101           {
102               const Option& o = it->second;
103               os << "\noption name " << it->first << " type " << o.type;
104
105               if (o.type != "button")
106                   os << " default " << o.defaultValue;
107
108               if (o.type == "spin")
109                   os << " min " << o.min << " max " << o.max;
110
111               break;
112           }
113   return os;
114 }
115
116
117 /// Option c'tors and conversion operators
118
119 Option::Option(const char* v, Fn* f) : type("string"), min(0), max(0), idx(Options.size()), on_change(f)
120 { defaultValue = currentValue = v; }
121
122 Option::Option(bool v, Fn* f) : type("check"), min(0), max(0), idx(Options.size()), on_change(f)
123 { defaultValue = currentValue = (v ? "true" : "false"); }
124
125 Option::Option(Fn* f) : type("button"), min(0), max(0), idx(Options.size()), on_change(f)
126 {}
127
128 Option::Option(int v, int minv, int maxv, Fn* f) : type("spin"), min(minv), max(maxv), idx(Options.size()), on_change(f)
129 { std::ostringstream ss; ss << v; defaultValue = currentValue = ss.str(); }
130
131
132 Option::operator int() const {
133   assert(type == "check" || type == "spin");
134   return (type == "spin" ? atoi(currentValue.c_str()) : currentValue == "true");
135 }
136
137 Option::operator std::string() const {
138   assert(type == "string");
139   return currentValue;
140 }
141
142
143 /// operator=() updates currentValue and triggers on_change() action. It's up to
144 /// the GUI to check for option's limits, but we could receive the new value from
145 /// the user by console window, so let's check the bounds anyway.
146
147 Option& Option::operator=(const string& v) {
148
149   assert(!type.empty());
150
151   if (   (type != "button" && v.empty())
152       || (type == "check" && v != "true" && v != "false")
153       || (type == "spin" && (atoi(v.c_str()) < min || atoi(v.c_str()) > max)))
154       return *this;
155
156   if (type != "button")
157       currentValue = v;
158
159   if (on_change)
160       (*on_change)(*this);
161
162   return *this;
163 }
164
165 } // namespace UCI