Fix typos in comments, adjust readme
[stockfish] / src / tune.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2021 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 #ifndef TUNE_H_INCLUDED
20 #define TUNE_H_INCLUDED
21
22 #include <memory>
23 #include <string>
24 #include <type_traits>
25 #include <vector>
26
27 namespace Stockfish {
28
29 typedef std::pair<int, int> Range; // Option's min-max values
30 typedef Range (RangeFun) (int);
31
32 // Default Range function, to calculate Option's min-max values
33 inline Range default_range(int v) {
34   return v > 0 ? Range(0, 2 * v) : Range(2 * v, 0);
35 }
36
37 struct SetRange {
38   explicit SetRange(RangeFun f) : fun(f) {}
39   SetRange(int min, int max) : fun(nullptr), range(min, max) {}
40   Range operator()(int v) const { return fun ? fun(v) : range; }
41
42   RangeFun* fun;
43   Range range;
44 };
45
46 #define SetDefaultRange SetRange(default_range)
47
48
49 /// Tune class implements the 'magic' code that makes the setup of a fishtest
50 /// tuning session as easy as it can be. Mainly you have just to remove const
51 /// qualifiers from the variables you want to tune and flag them for tuning, so
52 /// if you have:
53 ///
54 ///   const Score myScore = S(10, 15);
55 ///   const Value myValue[][2] = { { V(100), V(20) }, { V(7), V(78) } };
56 ///
57 /// If you have a my_post_update() function to run after values have been updated,
58 /// and a my_range() function to set custom Option's min-max values, then you just
59 /// remove the 'const' qualifiers and write somewhere below in the file:
60 ///
61 ///   TUNE(SetRange(my_range), myScore, myValue, my_post_update);
62 ///
63 /// You can also set the range directly, and restore the default at the end
64 ///
65 ///   TUNE(SetRange(-100, 100), myScore, SetDefaultRange);
66 ///
67 /// In case update function is slow and you have many parameters, you can add:
68 ///
69 ///   UPDATE_ON_LAST();
70 ///
71 /// And the values update, including post update function call, will be done only
72 /// once, after the engine receives the last UCI option, that is the one defined
73 /// and created as the last one, so the GUI should send the options in the same
74 /// order in which have been defined.
75
76 class Tune {
77
78   typedef void (PostUpdate) (); // Post-update function
79
80   Tune() { read_results(); }
81   Tune(const Tune&) = delete;
82   void operator=(const Tune&) = delete;
83   void read_results();
84
85   static Tune& instance() { static Tune t; return t; } // Singleton
86
87   // Use polymorphism to accommodate Entry of different types in the same vector
88   struct EntryBase {
89     virtual ~EntryBase() = default;
90     virtual void init_option() = 0;
91     virtual void read_option() = 0;
92   };
93
94   template<typename T>
95   struct Entry : public EntryBase {
96
97     static_assert(!std::is_const<T>::value, "Parameter cannot be const!");
98
99     static_assert(   std::is_same<T,   int>::value
100                   || std::is_same<T, Value>::value
101                   || std::is_same<T, Score>::value
102                   || std::is_same<T, PostUpdate>::value, "Parameter type not supported!");
103
104     Entry(const std::string& n, T& v, const SetRange& r) : name(n), value(v), range(r) {}
105     void operator=(const Entry&) = delete; // Because 'value' is a reference
106     void init_option() override;
107     void read_option() override;
108
109     std::string name;
110     T& value;
111     SetRange range;
112   };
113
114   // Our facility to fill the container, each Entry corresponds to a parameter
115   // to tune. We use variadic templates to deal with an unspecified number of
116   // entries, each one of a possible different type.
117   static std::string next(std::string& names, bool pop = true);
118
119   int add(const SetRange&, std::string&&) { return 0; }
120
121   template<typename T, typename... Args>
122   int add(const SetRange& range, std::string&& names, T& value, Args&&... args) {
123     list.push_back(std::unique_ptr<EntryBase>(new Entry<T>(next(names), value, range)));
124     return add(range, std::move(names), args...);
125   }
126
127   // Template specialization for arrays: recursively handle multi-dimensional arrays
128   template<typename T, size_t N, typename... Args>
129   int add(const SetRange& range, std::string&& names, T (&value)[N], Args&&... args) {
130     for (size_t i = 0; i < N; i++)
131         add(range, next(names, i == N - 1) + "[" + std::to_string(i) + "]", value[i]);
132     return add(range, std::move(names), args...);
133   }
134
135   // Template specialization for SetRange
136   template<typename... Args>
137   int add(const SetRange&, std::string&& names, SetRange& value, Args&&... args) {
138     return add(value, (next(names), std::move(names)), args...);
139   }
140
141   std::vector<std::unique_ptr<EntryBase>> list;
142
143 public:
144   template<typename... Args>
145   static int add(const std::string& names, Args&&... args) {
146     return instance().add(SetDefaultRange, names.substr(1, names.size() - 2), args...); // Remove trailing parenthesis
147   }
148   static void init() { for (auto& e : instance().list) e->init_option(); read_options(); } // Deferred, due to UCI::Options access
149   static void read_options() { for (auto& e : instance().list) e->read_option(); }
150   static bool update_on_last;
151 };
152
153 // Some macro magic :-) we define a dummy int variable that compiler initializes calling Tune::add()
154 #define STRINGIFY(x) #x
155 #define UNIQUE2(x, y) x ## y
156 #define UNIQUE(x, y) UNIQUE2(x, y) // Two indirection levels to expand __LINE__
157 #define TUNE(...) int UNIQUE(p, __LINE__) = Tune::add(STRINGIFY((__VA_ARGS__)), __VA_ARGS__)
158
159 #define UPDATE_ON_LAST() bool UNIQUE(p, __LINE__) = Tune::update_on_last = true
160
161 } // namespace Stockfish
162
163 #endif // #ifndef TUNE_H_INCLUDED