Add helper function verify_material
[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-2013 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 #ifndef ENDGAME_H_INCLUDED
21 #define ENDGAME_H_INCLUDED
22
23 #include <map>
24 #include <string>
25
26 #include "position.h"
27 #include "types.h"
28
29
30 /// EndgameType lists all supported endgames
31
32 enum EndgameType {
33
34   // Evaluation functions
35
36   KNNK,  // KNN vs K
37   KXK,   // Generic "mate lone king" eval
38   KBNK,  // KBN vs K
39   KPK,   // KP vs K
40   KRKP,  // KR vs KP
41   KRKB,  // KR vs KB
42   KRKN,  // KR vs KN
43   KQKP,  // KQ vs KP
44   KQKR,  // KQ vs KR
45   KBBKN, // KBB vs KN
46   KmmKm, // K and two minors vs K and one or two minors
47
48
49   // Scaling functions
50   SCALE_FUNS,
51
52   KBPsK,   // KB+pawns vs K
53   KQKRPs,  // KQ vs KR+pawns
54   KRPKR,   // KRP vs KR
55   KRPKB,   // KRP vs KB
56   KRPPKRP, // KRPP vs KRP
57   KPsK,    // King and pawns vs king
58   KBPKB,   // KBP vs KB
59   KBPPKB,  // KBPP vs KB
60   KBPKN,   // KBP vs KN
61   KNPK,    // KNP vs K
62   KNPKB,   // KNP vs KB
63   KPKP     // KP vs KP
64 };
65
66
67 /// Endgame functions can be of two types according if return a Value or a
68 /// ScaleFactor. Type eg_fun<int>::type equals to either ScaleFactor or Value
69 /// depending if the template parameter is 0 or 1.
70
71 template<int> struct eg_fun { typedef Value type; };
72 template<> struct eg_fun<1> { typedef ScaleFactor type; };
73
74
75 /// Base and derived templates for endgame evaluation and scaling functions
76
77 template<typename T>
78 struct EndgameBase {
79
80   virtual ~EndgameBase() {}
81   virtual Color color() const = 0;
82   virtual T operator()(const Position&) const = 0;
83 };
84
85
86 template<EndgameType E, typename T = typename eg_fun<(E > SCALE_FUNS)>::type>
87 struct Endgame : public EndgameBase<T> {
88
89   explicit Endgame(Color c) : strongerSide(c), weakerSide(~c) {}
90   Color color() const { return strongerSide; }
91   T operator()(const Position&) const;
92
93 private:
94   Color strongerSide, weakerSide;
95 };
96
97
98 /// Endgames class stores in two std::map the pointers to endgame evaluation
99 /// and scaling base objects. Then we use polymorphism to invoke the actual
100 /// endgame function calling its operator() that is virtual.
101
102 class Endgames {
103
104   typedef std::map<Key, EndgameBase<eg_fun<0>::type>*> M1;
105   typedef std::map<Key, EndgameBase<eg_fun<1>::type>*> M2;
106
107   M1 m1;
108   M2 m2;
109
110   M1& map(M1::mapped_type) { return m1; }
111   M2& map(M2::mapped_type) { return m2; }
112
113   template<EndgameType E> void add(const std::string& code);
114
115 public:
116   Endgames();
117  ~Endgames();
118
119   template<typename T> T probe(Key key, T& eg)
120   { return eg = map(eg).count(key) ? map(eg)[key] : NULL; }
121 };
122
123 #endif // #ifndef ENDGAME_H_INCLUDED