]> git.sesse.net Git - stockfish/blob - src/endgame.h
Merge remote-tracking branch 'upstream/master' into HEAD
[stockfish] / src / endgame.h
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-2020 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 #ifndef ENDGAME_H_INCLUDED
22 #define ENDGAME_H_INCLUDED
23
24 #include <memory>
25 #include <string>
26 #include <type_traits>
27 #include <unordered_map>
28 #include <utility>
29
30 #include "position.h"
31 #include "types.h"
32
33
34 /// EndgameCode lists all supported endgame functions by corresponding codes
35
36 enum EndgameCode {
37
38   EVALUATION_FUNCTIONS,
39   KNNK,  // KNN vs K
40   KNNKP, // KNN vs KP
41   KXK,   // Generic "mate lone king" eval
42   KBNK,  // KBN vs K
43   KPK,   // KP vs K
44   KRKP,  // KR vs KP
45   KRKB,  // KR vs KB
46   KRKN,  // KR vs KN
47   KQKP,  // KQ vs KP
48   KQKR,  // KQ vs KR
49
50   SCALING_FUNCTIONS,
51   KBPsK,   // KB and pawns vs K
52   KQKRPs,  // KQ vs KR and pawns
53   KRPKR,   // KRP vs KR
54   KRPKB,   // KRP vs KB
55   KRPPKRP, // KRPP vs KRP
56   KPsK,    // K and pawns vs K
57   KBPKB,   // KBP vs KB
58   KBPPKB,  // KBPP vs KB
59   KBPKN,   // KBP vs KN
60   KPKP     // KP vs KP
61 };
62
63
64 /// Endgame functions can be of two types depending on whether they return a
65 /// Value or a ScaleFactor.
66
67 template<EndgameCode E> using
68 eg_type = typename std::conditional<(E < SCALING_FUNCTIONS), Value, ScaleFactor>::type;
69
70
71 /// Base and derived functors for endgame evaluation and scaling functions
72
73 template<typename T>
74 struct EndgameBase {
75
76   explicit EndgameBase(Color c) : strongSide(c), weakSide(~c) {}
77   virtual ~EndgameBase() = default;
78   virtual T operator()(const Position&) const = 0;
79
80   const Color strongSide, weakSide;
81 };
82
83
84 template<EndgameCode E, typename T = eg_type<E>>
85 struct Endgame : public EndgameBase<T> {
86
87   explicit Endgame(Color c) : EndgameBase<T>(c) {}
88   T operator()(const Position&) const override;
89 };
90
91
92 /// The Endgames namespace handles the pointers to endgame evaluation and scaling
93 /// base objects in two std::map. We use polymorphism to invoke the actual
94 /// endgame function by calling its virtual operator().
95
96 namespace Endgames {
97
98   template<typename T> using Ptr = std::unique_ptr<EndgameBase<T>>;
99   template<typename T> using Map = std::unordered_map<Key, Ptr<T>>;
100
101   extern std::pair<Map<Value>, Map<ScaleFactor>> maps;
102
103   void init();
104
105   template<typename T>
106   Map<T>& map() {
107     return std::get<std::is_same<T, ScaleFactor>::value>(maps);
108   }
109
110   template<EndgameCode E, typename T = eg_type<E>>
111   void add(const std::string& code) {
112
113     StateInfo st;
114     map<T>()[Position().set(code, WHITE, &st).material_key()] = Ptr<T>(new Endgame<E>(WHITE));
115     map<T>()[Position().set(code, BLACK, &st).material_key()] = Ptr<T>(new Endgame<E>(BLACK));
116   }
117
118   template<typename T>
119   const EndgameBase<T>* probe(Key key) {
120     auto it = map<T>().find(key);
121     return it != map<T>().end() ? it->second.get() : nullptr;
122   }
123 }
124
125 #endif // #ifndef ENDGAME_H_INCLUDED