Remove even more redundancy in endgame functions handling
[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-2009 Marco Costalba
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
21 #if !defined(ENDGAME_H_INCLUDED)
22 #define ENDGAME_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "position.h"
29 #include "scale.h"
30 #include "value.h"
31
32
33 ////
34 //// Types
35 ////
36
37 enum EndgameType {
38
39     // Evaluation functions
40     KXK,   // Generic "mate lone king" eval
41     KBNK,  // KBN vs K
42     KPK,   // KP vs K
43     KRKP,  // KR vs KP
44     KRKB,  // KR vs KB
45     KRKN,  // KR vs KN
46     KQKR,  // KQ vs KR
47     KBBKN, // KBB vs KN
48     KmmKm, // K and two minors vs K and one or two minors
49
50     // Scaling functions
51     KBPK,    // KBP vs K
52     KQKRP,   // KQ vs KRP
53     KRPKR,   // KRP vs KR
54     KRPPKRP, // KRPP vs KRP
55     KPsK,    // King and pawns vs king
56     KBPKB,   // KBP vs KB
57     KBPPKB,  // KBPP vs KB
58     KBPKN,   // KBP vs KN
59     KNPK,    // KNP vs K
60     KPKP     // KP vs KP
61 };
62
63 /// Template abstract base class for all special endgame functions
64
65 template<typename T>
66 class EndgameFunctionBase {
67 public:
68   EndgameFunctionBase(Color c) : strongerSide(c), weakerSide(opposite_color(c)) {}
69   virtual ~EndgameFunctionBase() {}
70   virtual T apply(const Position&) = 0;
71   Color color() const { return strongerSide; }
72
73 protected:
74   Color strongerSide, weakerSide;
75 };
76
77 typedef EndgameFunctionBase<Value> EndgameEvaluationFunctionBase;
78 typedef EndgameFunctionBase<ScaleFactor> EndgameScalingFunctionBase;
79
80
81 /// Templates subclass for various concrete endgames
82
83 template<EndgameType>
84 struct EvaluationFunction : public EndgameEvaluationFunctionBase {
85   typedef EndgameEvaluationFunctionBase Base;
86   explicit EvaluationFunction(Color c): EndgameEvaluationFunctionBase(c) {}
87   Value apply(const Position&);
88 };
89
90 template<EndgameType>
91 struct ScalingFunction : public EndgameScalingFunctionBase {
92   typedef EndgameScalingFunctionBase Base;
93   explicit ScalingFunction(Color c) : EndgameScalingFunctionBase(c) {}
94   ScaleFactor apply(const Position&);
95 };
96
97
98 ////
99 //// Prototypes
100 ////
101
102 extern void init_bitbases();
103
104
105 #endif // !defined(ENDGAME_H_INCLUDED)