535c216c0742053ecaa852923be264f4d9068e19
[stockfish] / src / material.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-2010 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
21 #if !defined(MATERIAL_H_INCLUDED)
22 #define MATERIAL_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "endgame.h"
29 #include "position.h"
30
31
32 ////
33 //// Types
34 ////
35
36 const int MaterialTableSize = 1024;
37
38 /// MaterialInfo is a class which contains various information about a
39 /// material configuration. It contains a material balance evaluation,
40 /// a function pointer to a special endgame evaluation function (which in
41 /// most cases is NULL, meaning that the standard evaluation function will
42 /// be used), and "scale factors" for black and white.
43 ///
44 /// The scale factors are used to scale the evaluation score up or down.
45 /// For instance, in KRB vs KR endgames, the score is scaled down by a factor
46 /// of 4, which will result in scores of absolute value less than one pawn.
47
48 class MaterialInfo {
49
50   friend class MaterialInfoTable;
51
52 public:
53   Score material_value() const;
54   ScaleFactor scale_factor(const Position& pos, Color c) const;
55   int space_weight() const;
56   Phase game_phase() const;
57   bool specialized_eval_exists() const;
58   Value evaluate(const Position& pos) const;
59
60 private:
61   Key key;
62   int16_t value;
63   uint8_t factor[2];
64   EndgameEvaluationFunctionBase* evaluationFunction;
65   EndgameScalingFunctionBase* scalingFunction[2];
66   int spaceWeight;
67   Phase gamePhase;
68 };
69
70 /// The MaterialInfoTable class represents a pawn hash table. It is basically
71 /// just an array of MaterialInfo objects and a few methods for accessing these
72 /// objects. The most important method is get_material_info, which looks up a
73 /// position in the table and returns a pointer to a MaterialInfo object.
74 class EndgameFunctions;
75
76 class MaterialInfoTable {
77
78   MaterialInfoTable(const MaterialInfoTable&);
79   MaterialInfoTable& operator=(const MaterialInfoTable&);
80
81 public:
82   MaterialInfoTable();
83   ~MaterialInfoTable();
84   MaterialInfo* get_material_info(const Position& pos);
85
86   static Phase game_phase(const Position& pos);
87
88 private:
89   MaterialInfo* entries;
90   EndgameFunctions* funcs;
91 };
92
93
94 ////
95 //// Inline functions
96 ////
97
98
99 /// MaterialInfo::material_value simply returns the material balance
100 /// evaluation that is independent from game phase.
101
102 inline Score MaterialInfo::material_value() const {
103
104   return make_score(value, value);
105 }
106
107 /// MaterialInfo::scale_factor takes a position and a color as input, and
108 /// returns a scale factor for the given color. We have to provide the
109 /// position in addition to the color, because the scale factor need not
110 /// to be a constant: It can also be a function which should be applied to
111 /// the position. For instance, in KBP vs K endgames, a scaling function
112 /// which checks for draws with rook pawns and wrong-colored bishops.
113
114 inline ScaleFactor MaterialInfo::scale_factor(const Position& pos, Color c) const {
115
116   if (scalingFunction[c] != NULL)
117   {
118       ScaleFactor sf = scalingFunction[c]->apply(pos);
119       if (sf != SCALE_FACTOR_NONE)
120           return sf;
121   }
122   return ScaleFactor(factor[c]);
123 }
124
125
126 /// MaterialInfo::space_weight() simply returns the weight for the space
127 /// evaluation for this material configuration.
128
129 inline int MaterialInfo::space_weight() const {
130
131   return spaceWeight;
132 }
133
134 /// MaterialInfo::game_phase() returns the game phase according
135 /// to this material configuration.
136
137 inline Phase MaterialInfo::game_phase() const {
138
139   return gamePhase;
140 }
141
142
143 /// MaterialInfo::specialized_eval_exists decides whether there is a
144 /// specialized evaluation function for the current material configuration,
145 /// or if the normal evaluation function should be used.
146
147 inline bool MaterialInfo::specialized_eval_exists() const {
148
149   return evaluationFunction != NULL;
150 }
151
152
153 /// MaterialInfo::evaluate applies a specialized evaluation function
154 /// to a given position object. It should only be called when
155 /// specialized_eval_exists() returns 'true'.
156
157 inline Value MaterialInfo::evaluate(const Position& pos) const {
158
159   return evaluationFunction->apply(pos);
160 }
161
162 #endif // !defined(MATERIAL_H_INCLUDED)