Introduce SimpleHash class
[stockfish] / src / material.cpp
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 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cstring>
27 #include <map>
28
29 #include "material.h"
30
31 using namespace std;
32
33
34 ////
35 //// Local definitions
36 ////
37
38 namespace {
39
40   // Values modified by Joona Kiiski
41   const Value MidgameLimit = Value(15581);
42   const Value EndgameLimit = Value(3998);
43
44   // Polynomial material balance parameters
45   const Value RedundantQueenPenalty = Value(320);
46   const Value RedundantRookPenalty  = Value(554);
47
48   const int LinearCoefficients[6] = { 1617, -162, -1172, -190, 105, 26 };
49
50   const int QuadraticCoefficientsSameColor[][8] = {
51   { 7, 7, 7, 7, 7, 7 }, { 39, 2, 7, 7, 7, 7 }, { 35, 271, -4, 7, 7, 7 },
52   { 7, 25, 4, 7, 7, 7 }, { -27, -2, 46, 100, 56, 7 }, { 58, 29, 83, 148, -3, -25 } };
53
54   const int QuadraticCoefficientsOppositeColor[][8] = {
55   { 41, 41, 41, 41, 41, 41 }, { 37, 41, 41, 41, 41, 41 }, { 10, 62, 41, 41, 41, 41 },
56   { 57, 64, 39, 41, 41, 41 }, { 50, 40, 23, -22, 41, 41 }, { 106, 101, 3, 151, 171, 41 } };
57
58   typedef EndgameEvaluationFunctionBase EF;
59   typedef EndgameScalingFunctionBase SF;
60   typedef map<Key, EF*> EFMap;
61   typedef map<Key, SF*> SFMap;
62
63   // Endgame evaluation and scaling functions accessed direcly and not through
64   // the function maps because correspond to more then one material hash key.
65   EvaluationFunction<KmmKm> EvaluateKmmKm[] = { EvaluationFunction<KmmKm>(WHITE), EvaluationFunction<KmmKm>(BLACK) };
66   EvaluationFunction<KXK>   EvaluateKXK[]   = { EvaluationFunction<KXK>(WHITE),   EvaluationFunction<KXK>(BLACK) };
67   ScalingFunction<KBPsK>    ScaleKBPsK[]    = { ScalingFunction<KBPsK>(WHITE),    ScalingFunction<KBPsK>(BLACK) };
68   ScalingFunction<KQKRPs>   ScaleKQKRPs[]   = { ScalingFunction<KQKRPs>(WHITE),   ScalingFunction<KQKRPs>(BLACK) };
69   ScalingFunction<KPsK>     ScaleKPsK[]     = { ScalingFunction<KPsK>(WHITE),     ScalingFunction<KPsK>(BLACK) };
70   ScalingFunction<KPKP>     ScaleKPKP[]     = { ScalingFunction<KPKP>(WHITE),     ScalingFunction<KPKP>(BLACK) };
71
72   // Helper templates used to detect a given material distribution
73   template<Color Us> bool is_KXK(const Position& pos) {
74     const Color Them = (Us == WHITE ? BLACK : WHITE);
75     return   pos.non_pawn_material(Them) == VALUE_ZERO
76           && pos.piece_count(Them, PAWN) == 0
77           && pos.non_pawn_material(Us)   >= RookValueMidgame;
78   }
79
80   template<Color Us> bool is_KBPsK(const Position& pos) {
81     return   pos.non_pawn_material(Us)   == BishopValueMidgame
82           && pos.piece_count(Us, BISHOP) == 1
83           && pos.piece_count(Us, PAWN)   >= 1;
84   }
85
86   template<Color Us> bool is_KQKRPs(const Position& pos) {
87     const Color Them = (Us == WHITE ? BLACK : WHITE);
88     return   pos.piece_count(Us, PAWN)    == 0
89           && pos.non_pawn_material(Us)    == QueenValueMidgame
90           && pos.piece_count(Us, QUEEN)   == 1
91           && pos.piece_count(Them, ROOK)  == 1
92           && pos.piece_count(Them, PAWN)  >= 1;
93   }
94 }
95
96
97 ////
98 //// Classes
99 ////
100
101 /// EndgameFunctions class stores endgame evaluation and scaling functions
102 /// in two std::map. Because STL library is not guaranteed to be thread
103 /// safe even for read access, the maps, although with identical content,
104 /// are replicated for each thread. This is faster then using locks.
105
106 class EndgameFunctions {
107 public:
108   EndgameFunctions();
109   ~EndgameFunctions();
110   template<class T> T* get(Key key) const;
111
112 private:
113   template<class T> void add(const string& keyCode);
114
115   static Key buildKey(const string& keyCode);
116   static const string swapColors(const string& keyCode);
117
118   // Here we store two maps, for evaluate and scaling functions...
119   pair<EFMap, SFMap> maps;
120
121   // ...and here is the accessing template function
122   template<typename T> const map<Key, T*>& get() const;
123 };
124
125 // Explicit specializations of a member function shall be declared in
126 // the namespace of which the class template is a member.
127 template<> const EFMap& EndgameFunctions::get<EF>() const { return maps.first; }
128 template<> const SFMap& EndgameFunctions::get<SF>() const { return maps.second; }
129
130
131 ////
132 //// Functions
133 ////
134
135 MaterialInfoTable::MaterialInfoTable() { funcs = new EndgameFunctions(); }
136 MaterialInfoTable::~MaterialInfoTable() { delete funcs; }
137
138 /// MaterialInfoTable::game_phase() calculates the phase given the current
139 /// position. Because the phase is strictly a function of the material, it
140 /// is stored in MaterialInfo.
141
142 Phase MaterialInfoTable::game_phase(const Position& pos) {
143
144   Value npm = pos.non_pawn_material(WHITE) + pos.non_pawn_material(BLACK);
145
146   if (npm >= MidgameLimit)
147       return PHASE_MIDGAME;
148
149   if (npm <= EndgameLimit)
150       return PHASE_ENDGAME;
151
152   return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
153 }
154
155 /// MaterialInfoTable::get_material_info() takes a position object as input,
156 /// computes or looks up a MaterialInfo object, and returns a pointer to it.
157 /// If the material configuration is not already present in the table, it
158 /// is stored there, so we don't have to recompute everything when the
159 /// same material configuration occurs again.
160
161 MaterialInfo* MaterialInfoTable::get_material_info(const Position& pos) {
162
163   Key key = pos.get_material_key();
164   MaterialInfo* mi = find(key);
165
166   // If mi->key matches the position's material hash key, it means that we
167   // have analysed this material configuration before, and we can simply
168   // return the information we found the last time instead of recomputing it.
169   if (mi->key == key)
170       return mi;
171
172   // Clear the MaterialInfo object, and set its key
173   memset(mi, 0, sizeof(MaterialInfo));
174   mi->factor[WHITE] = mi->factor[BLACK] = (uint8_t)SCALE_FACTOR_NORMAL;
175   mi->key = key;
176
177   // Store game phase
178   mi->gamePhase = MaterialInfoTable::game_phase(pos);
179
180   // Let's look if we have a specialized evaluation function for this
181   // particular material configuration. First we look for a fixed
182   // configuration one, then a generic one if previous search failed.
183   if ((mi->evaluationFunction = funcs->get<EF>(key)) != NULL)
184       return mi;
185
186   if (is_KXK<WHITE>(pos) || is_KXK<BLACK>(pos))
187   {
188       mi->evaluationFunction = is_KXK<WHITE>(pos) ? &EvaluateKXK[WHITE] : &EvaluateKXK[BLACK];
189       return mi;
190   }
191
192   if (   pos.pieces(PAWN)  == EmptyBoardBB
193       && pos.pieces(ROOK)  == EmptyBoardBB
194       && pos.pieces(QUEEN) == EmptyBoardBB)
195   {
196       // Minor piece endgame with at least one minor piece per side and
197       // no pawns. Note that the case KmmK is already handled by KXK.
198       assert((pos.pieces(KNIGHT, WHITE) | pos.pieces(BISHOP, WHITE)));
199       assert((pos.pieces(KNIGHT, BLACK) | pos.pieces(BISHOP, BLACK)));
200
201       if (   pos.piece_count(WHITE, BISHOP) + pos.piece_count(WHITE, KNIGHT) <= 2
202           && pos.piece_count(BLACK, BISHOP) + pos.piece_count(BLACK, KNIGHT) <= 2)
203       {
204           mi->evaluationFunction = &EvaluateKmmKm[WHITE];
205           return mi;
206       }
207   }
208
209   // OK, we didn't find any special evaluation function for the current
210   // material configuration. Is there a suitable scaling function?
211   //
212   // We face problems when there are several conflicting applicable
213   // scaling functions and we need to decide which one to use.
214   SF* sf;
215
216   if ((sf = funcs->get<SF>(key)) != NULL)
217   {
218       mi->scalingFunction[sf->color()] = sf;
219       return mi;
220   }
221
222   // Generic scaling functions that refer to more then one material
223   // distribution. Should be probed after the specialized ones.
224   // Note that these ones don't return after setting the function.
225   if (is_KBPsK<WHITE>(pos))
226       mi->scalingFunction[WHITE] = &ScaleKBPsK[WHITE];
227
228   if (is_KBPsK<BLACK>(pos))
229       mi->scalingFunction[BLACK] = &ScaleKBPsK[BLACK];
230
231   if (is_KQKRPs<WHITE>(pos))
232       mi->scalingFunction[WHITE] = &ScaleKQKRPs[WHITE];
233
234   else if (is_KQKRPs<BLACK>(pos))
235       mi->scalingFunction[BLACK] = &ScaleKQKRPs[BLACK];
236
237   if (pos.non_pawn_material(WHITE) + pos.non_pawn_material(BLACK) == VALUE_ZERO)
238   {
239       if (pos.piece_count(BLACK, PAWN) == 0)
240       {
241           assert(pos.piece_count(WHITE, PAWN) >= 2);
242           mi->scalingFunction[WHITE] = &ScaleKPsK[WHITE];
243       }
244       else if (pos.piece_count(WHITE, PAWN) == 0)
245       {
246           assert(pos.piece_count(BLACK, PAWN) >= 2);
247           mi->scalingFunction[BLACK] = &ScaleKPsK[BLACK];
248       }
249       else if (pos.piece_count(WHITE, PAWN) == 1 && pos.piece_count(BLACK, PAWN) == 1)
250       {
251           // This is a special case because we set scaling functions
252           // for both colors instead of only one.
253           mi->scalingFunction[WHITE] = &ScaleKPKP[WHITE];
254           mi->scalingFunction[BLACK] = &ScaleKPKP[BLACK];
255       }
256   }
257
258   // Compute the space weight
259   if (pos.non_pawn_material(WHITE) + pos.non_pawn_material(BLACK) >=
260       2*QueenValueMidgame + 4*RookValueMidgame + 2*KnightValueMidgame)
261   {
262       int minorPieceCount =  pos.piece_count(WHITE, KNIGHT)
263                            + pos.piece_count(BLACK, KNIGHT)
264                            + pos.piece_count(WHITE, BISHOP)
265                            + pos.piece_count(BLACK, BISHOP);
266
267       mi->spaceWeight = minorPieceCount * minorPieceCount;
268   }
269
270   // Evaluate the material balance
271   const int pieceCount[2][8] = {
272   { pos.piece_count(WHITE, BISHOP) > 1, pos.piece_count(WHITE, PAWN), pos.piece_count(WHITE, KNIGHT),
273     pos.piece_count(WHITE, BISHOP), pos.piece_count(WHITE, ROOK), pos.piece_count(WHITE, QUEEN) },
274   { pos.piece_count(BLACK, BISHOP) > 1, pos.piece_count(BLACK, PAWN), pos.piece_count(BLACK, KNIGHT),
275     pos.piece_count(BLACK, BISHOP), pos.piece_count(BLACK, ROOK), pos.piece_count(BLACK, QUEEN) } };
276
277   Color c, them;
278   int sign, pt1, pt2, pc;
279   int v, vv, matValue = 0;
280
281   for (c = WHITE, sign = 1; c <= BLACK; c++, sign = -sign)
282   {
283     // No pawns makes it difficult to win, even with a material advantage
284     if (   pos.piece_count(c, PAWN) == 0
285         && pos.non_pawn_material(c) - pos.non_pawn_material(opposite_color(c)) <= BishopValueMidgame)
286     {
287         if (   pos.non_pawn_material(c) == pos.non_pawn_material(opposite_color(c))
288             || pos.non_pawn_material(c) < RookValueMidgame)
289             mi->factor[c] = 0;
290         else
291         {
292             switch (pos.piece_count(c, BISHOP)) {
293             case 2:
294                 mi->factor[c] = 32;
295                 break;
296             case 1:
297                 mi->factor[c] = 12;
298                 break;
299             case 0:
300                 mi->factor[c] = 6;
301                 break;
302             }
303         }
304     }
305
306     // Redundancy of major pieces, formula based on Kaufman's paper
307     // "The Evaluation of Material Imbalances in Chess"
308     // http://mywebpages.comcast.net/danheisman/Articles/evaluation_of_material_imbalance.htm
309     if (pieceCount[c][ROOK] >= 1)
310         matValue -= sign * ((pieceCount[c][ROOK] - 1) * RedundantRookPenalty + pieceCount[c][QUEEN] * RedundantQueenPenalty);
311
312     them = opposite_color(c);
313     v = 0;
314
315     // Second-degree polynomial material imbalance by Tord Romstad
316     //
317     // We use PIECE_TYPE_NONE as a place holder for the bishop pair "extended piece",
318     // this allow us to be more flexible in defining bishop pair bonuses.
319     for (pt1 = PIECE_TYPE_NONE; pt1 <= QUEEN; pt1++)
320     {
321         pc = pieceCount[c][pt1];
322         if (!pc)
323             continue;
324
325         vv = LinearCoefficients[pt1];
326
327         for (pt2 = PIECE_TYPE_NONE; pt2 <= pt1; pt2++)
328             vv +=  pieceCount[c][pt2] * QuadraticCoefficientsSameColor[pt1][pt2]
329                  + pieceCount[them][pt2] * QuadraticCoefficientsOppositeColor[pt1][pt2];
330
331         v += pc * vv;
332     }
333     matValue += sign * v;
334   }
335   mi->value = (int16_t)(matValue / 16);
336   return mi;
337 }
338
339
340 /// EndgameFunctions member definitions
341
342 EndgameFunctions::EndgameFunctions() {
343
344   add<EvaluationFunction<KNNK>  >("KNNK");
345   add<EvaluationFunction<KPK>   >("KPK");
346   add<EvaluationFunction<KBNK>  >("KBNK");
347   add<EvaluationFunction<KRKP>  >("KRKP");
348   add<EvaluationFunction<KRKB>  >("KRKB");
349   add<EvaluationFunction<KRKN>  >("KRKN");
350   add<EvaluationFunction<KQKR>  >("KQKR");
351   add<EvaluationFunction<KBBKN> >("KBBKN");
352
353   add<ScalingFunction<KNPK>    >("KNPK");
354   add<ScalingFunction<KRPKR>   >("KRPKR");
355   add<ScalingFunction<KBPKB>   >("KBPKB");
356   add<ScalingFunction<KBPPKB>  >("KBPPKB");
357   add<ScalingFunction<KBPKN>   >("KBPKN");
358   add<ScalingFunction<KRPPKRP> >("KRPPKRP");
359 }
360
361 EndgameFunctions::~EndgameFunctions() {
362
363     for (EFMap::const_iterator it = maps.first.begin(); it != maps.first.end(); ++it)
364         delete it->second;
365
366     for (SFMap::const_iterator it = maps.second.begin(); it != maps.second.end(); ++it)
367         delete it->second;
368 }
369
370 Key EndgameFunctions::buildKey(const string& keyCode) {
371
372     assert(keyCode.length() > 0 && keyCode.length() < 8);
373     assert(keyCode[0] == 'K');
374
375     string fen;
376     bool upcase = false;
377
378     // Build up a fen string with the given pieces, note that
379     // the fen string could be of an illegal position.
380     for (size_t i = 0; i < keyCode.length(); i++)
381     {
382         if (keyCode[i] == 'K')
383             upcase = !upcase;
384
385         fen += char(upcase ? toupper(keyCode[i]) : tolower(keyCode[i]));
386     }
387     fen += char(8 - keyCode.length() + '0');
388     fen += "/8/8/8/8/8/8/8 w - -";
389     return Position(fen, false, 0).get_material_key();
390 }
391
392 const string EndgameFunctions::swapColors(const string& keyCode) {
393
394     // Build corresponding key for the opposite color: "KBPKN" -> "KNKBP"
395     size_t idx = keyCode.find('K', 1);
396     return keyCode.substr(idx) + keyCode.substr(0, idx);
397 }
398
399 template<class T>
400 void EndgameFunctions::add(const string& keyCode) {
401
402   typedef typename T::Base F;
403   typedef map<Key, F*> M;
404
405   const_cast<M&>(get<F>()).insert(pair<Key, F*>(buildKey(keyCode), new T(WHITE)));
406   const_cast<M&>(get<F>()).insert(pair<Key, F*>(buildKey(swapColors(keyCode)), new T(BLACK)));
407 }
408
409 template<class T>
410 T* EndgameFunctions::get(Key key) const {
411
412   typename map<Key, T*>::const_iterator it = get<T>().find(key);
413   return it != get<T>().end() ? it->second : NULL;
414 }