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