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