Small code style in headers
[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   Value mg_value() const;
53   Value eg_value() const;
54   ScaleFactor scale_factor(const Position& pos, Color c) const;
55   int space_weight() const;
56   bool specialized_eval_exists() const;
57   Value evaluate(const Position& pos) const;
58
59 private:
60   void clear();
61
62   Key key;
63   int16_t mgValue;
64   int16_t egValue;
65   uint8_t factor[2];
66   EndgameEvaluationFunctionBase* evaluationFunction;
67   EndgameScalingFunctionBase* scalingFunction[2];
68   int spaceWeight;
69 };
70
71
72 /// EndgameFunctions class stores the endgame evaluation functions std::map.
73 /// Because STL library is not thread safe even for read access, the maps,
74 /// although with identical content, are replicated for each thread. This
75 /// is faster then using locks with an unique set of global maps.
76
77 class EndgameFunctions;
78
79
80 /// The MaterialInfoTable class represents a pawn hash table. It is basically
81 /// just an array of MaterialInfo objects and a few methods for accessing these
82 /// objects. The most important method is get_material_info, which looks up a
83 /// position in the table and returns a pointer to a MaterialInfo object.
84
85 class MaterialInfoTable {
86
87 public:
88   MaterialInfoTable(unsigned numOfEntries);
89   ~MaterialInfoTable();
90   void clear();
91   MaterialInfo* get_material_info(const Position& pos);
92
93 private:
94   unsigned size;
95   MaterialInfo* entries;
96   EndgameFunctions* funcs;
97 };
98
99
100 ////
101 //// Inline functions
102 ////
103
104 /// MaterialInfo::mg_value and MaterialInfo::eg_value simply returns the
105 /// material balance evaluation for the middle game and the endgame.
106
107 inline Value MaterialInfo::mg_value() const {
108
109   return Value(mgValue);
110 }
111
112 inline Value MaterialInfo::eg_value() const {
113
114   return Value(egValue);
115 }
116
117
118 /// MaterialInfo::clear() resets a MaterialInfo object to an empty state,
119 /// with all slots at their default values.
120
121 inline void MaterialInfo::clear() {
122
123   mgValue = egValue = 0;
124   factor[WHITE] = factor[BLACK] = uint8_t(SCALE_FACTOR_NORMAL);
125   spaceWeight = 0;
126   evaluationFunction = NULL;
127   scalingFunction[WHITE] = scalingFunction[BLACK] = NULL;
128 }
129
130
131 /// MaterialInfo::scale_factor takes a position and a color as input, and
132 /// returns a scale factor for the given color. We have to provide the
133 /// position in addition to the color, because the scale factor need not
134 /// to be a constant: It can also be a function which should be applied to
135 /// the position. For instance, in KBP vs K endgames, a scaling function
136 /// which checks for draws with rook pawns and wrong-colored bishops.
137
138 inline ScaleFactor MaterialInfo::scale_factor(const Position& pos, Color c) const {
139
140   if (scalingFunction[c] != NULL)
141   {
142       ScaleFactor sf = scalingFunction[c]->apply(pos);
143       if (sf != SCALE_FACTOR_NONE)
144           return sf;
145   }
146   return ScaleFactor(factor[c]);
147 }
148
149
150 /// MaterialInfo::space_weight() simply returns the weight for the space
151 /// evaluation for this material configuration.
152
153 inline int MaterialInfo::space_weight() const {
154
155   return spaceWeight;
156 }
157
158
159 /// MaterialInfo::specialized_eval_exists decides whether there is a
160 /// specialized evaluation function for the current material configuration,
161 /// or if the normal evaluation function should be used.
162
163 inline bool MaterialInfo::specialized_eval_exists() const {
164
165   return evaluationFunction != NULL;
166 }
167
168
169 /// MaterialInfo::evaluate applies a specialized evaluation function
170 /// to a given position object. It should only be called when
171 /// specialized_eval_exists() returns 'true'.
172
173 inline Value MaterialInfo::evaluate(const Position& pos) const {
174
175   return evaluationFunction->apply(pos);
176 }
177
178 #endif // !defined(MATERIAL_H_INCLUDED)