11fd3c9b235cfe5ba8baaa542694186f69a6aa9a
[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 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 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cstring>
27 #include <map>
28
29 #include "material.h"
30
31
32 ////
33 //// Local definitions
34 ////
35
36 namespace {
37
38   const Value BishopPairMidgameBonus = Value(100);
39   const Value BishopPairEndgameBonus = Value(100);
40
41   Key KNNKMaterialKey, KKNNMaterialKey;
42
43 }
44
45 ////
46 //// Classes
47 ////
48
49
50 /// See header for a class description. It is declared here to avoid
51 /// to include <map> in the header file.
52
53 class EndgameFunctions {
54
55 public:
56   EndgameFunctions();
57   EndgameEvaluationFunction* getEEF(Key key) const;
58   ScalingFunction* getESF(Key key, Color* c) const;
59
60 private:
61   void add(Key k, EndgameEvaluationFunction* f);
62   void add(Key k, Color c, ScalingFunction* f);
63
64   struct ScalingInfo
65   {
66       Color col;
67       ScalingFunction* fun;
68   };
69
70   std::map<Key, EndgameEvaluationFunction*> EEFmap;
71   std::map<Key, ScalingInfo> ESFmap;
72 };
73
74
75 ////
76 //// Functions
77 ////
78
79
80 /// Constructor for the MaterialInfoTable class
81
82 MaterialInfoTable::MaterialInfoTable(unsigned int numOfEntries) {
83
84   size = numOfEntries;
85   entries = new MaterialInfo[size];
86   funcs = new EndgameFunctions();
87   if (!entries || !funcs)
88   {
89       std::cerr << "Failed to allocate " << (numOfEntries * sizeof(MaterialInfo))
90                 << " bytes for material hash table." << std::endl;
91       exit(EXIT_FAILURE);
92   }
93   clear();
94 }
95
96
97 /// Destructor for the MaterialInfoTable class
98
99 MaterialInfoTable::~MaterialInfoTable() {
100
101   delete [] entries;
102   delete funcs;
103 }
104
105
106 /// MaterialInfoTable::clear() clears a material hash table by setting
107 /// all entries to 0.
108
109 void MaterialInfoTable::clear() {
110
111   memset(entries, 0, size * sizeof(MaterialInfo));
112 }
113
114
115 /// MaterialInfoTable::get_material_info() takes a position object as input,
116 /// computes or looks up a MaterialInfo object, and returns a pointer to it.
117 /// If the material configuration is not already present in the table, it
118 /// is stored there, so we don't have to recompute everything when the
119 /// same material configuration occurs again.
120
121 MaterialInfo* MaterialInfoTable::get_material_info(const Position& pos) {
122
123   Key key = pos.get_material_key();
124   int index = key & (size - 1);
125   MaterialInfo* mi = entries + index;
126
127   // If mi->key matches the position's material hash key, it means that we
128   // have analysed this material configuration before, and we can simply
129   // return the information we found the last time instead of recomputing it.
130   if (mi->key == key)
131       return mi;
132
133   // Clear the MaterialInfo object, and set its key
134   mi->clear();
135   mi->key = key;
136
137   // A special case before looking for a specialized evaluation function
138   // KNN vs K is a draw.
139   if (key == KNNKMaterialKey || key == KKNNMaterialKey)
140   {
141       mi->factor[WHITE] = mi->factor[BLACK] = 0;
142       return mi;
143   }
144
145   // Let's look if we have a specialized evaluation function for this
146   // particular material configuration.
147   if ((mi->evaluationFunction = funcs->getEEF(key)) != NULL)
148       return mi;
149
150   else if (   pos.non_pawn_material(BLACK) == Value(0)
151            && pos.piece_count(BLACK, PAWN) == 0
152            && pos.non_pawn_material(WHITE) >= RookValueEndgame)
153   {
154       mi->evaluationFunction = &EvaluateKXK;
155       return mi;
156   }
157   else if (   pos.non_pawn_material(WHITE) == Value(0)
158            && pos.piece_count(WHITE, PAWN) == 0
159            && pos.non_pawn_material(BLACK) >= RookValueEndgame)
160   {
161       mi->evaluationFunction = &EvaluateKKX;
162       return mi;
163   }
164   else if (   pos.pawns() == EmptyBoardBB
165            && pos.rooks() == EmptyBoardBB
166            && pos.queens() == EmptyBoardBB)
167   {
168       // Minor piece endgame with at least one minor piece per side,
169       // and no pawns.
170       assert(pos.knights(WHITE) | pos.bishops(WHITE));
171       assert(pos.knights(BLACK) | pos.bishops(BLACK));
172
173       if (   pos.piece_count(WHITE, BISHOP) + pos.piece_count(WHITE, KNIGHT) <= 2
174           && pos.piece_count(BLACK, BISHOP) + pos.piece_count(BLACK, KNIGHT) <= 2)
175       {
176           mi->evaluationFunction = &EvaluateKmmKm;
177           return mi;
178       }
179   }
180
181   // OK, we didn't find any special evaluation function for the current
182   // material configuration. Is there a suitable scaling function?
183   //
184   // The code below is rather messy, and it could easily get worse later,
185   // if we decide to add more special cases.  We face problems when there
186   // are several conflicting applicable scaling functions and we need to
187   // decide which one to use.
188   Color c;
189   ScalingFunction* sf;
190
191   if ((sf = funcs->getESF(key, &c)) != NULL)
192   {
193       mi->scalingFunction[c] = sf;
194       return mi;
195   }
196
197   if (   pos.non_pawn_material(WHITE) == BishopValueMidgame
198       && pos.piece_count(WHITE, BISHOP) == 1
199       && pos.piece_count(WHITE, PAWN) >= 1)
200       mi->scalingFunction[WHITE] = &ScaleKBPK;
201
202   if (   pos.non_pawn_material(BLACK) == BishopValueMidgame
203       && pos.piece_count(BLACK, BISHOP) == 1
204       && pos.piece_count(BLACK, PAWN) >= 1)
205       mi->scalingFunction[BLACK] = &ScaleKKBP;
206
207   if (   pos.piece_count(WHITE, PAWN) == 0
208       && pos.non_pawn_material(WHITE) == QueenValueMidgame
209       && pos.piece_count(WHITE, QUEEN) == 1
210       && pos.piece_count(BLACK, ROOK) == 1
211       && pos.piece_count(BLACK, PAWN) >= 1)
212       mi->scalingFunction[WHITE] = &ScaleKQKRP;
213
214   else if (   pos.piece_count(BLACK, PAWN) == 0
215            && pos.non_pawn_material(BLACK) == QueenValueMidgame
216            && pos.piece_count(BLACK, QUEEN) == 1
217            && pos.piece_count(WHITE, ROOK) == 1
218            && pos.piece_count(WHITE, PAWN) >= 1)
219       mi->scalingFunction[BLACK] = &ScaleKRPKQ;
220
221   if (pos.non_pawn_material(WHITE) + pos.non_pawn_material(BLACK) == Value(0))
222   {
223       if (pos.piece_count(BLACK, PAWN) == 0)
224       {
225           assert(pos.piece_count(WHITE, PAWN) >= 2);
226           mi->scalingFunction[WHITE] = &ScaleKPsK;
227       }
228       else if (pos.piece_count(WHITE, PAWN) == 0)
229       {
230           assert(pos.piece_count(BLACK, PAWN) >= 2);
231           mi->scalingFunction[BLACK] = &ScaleKKPs;
232       }
233       else if (pos.piece_count(WHITE, PAWN) == 1 && pos.piece_count(BLACK, PAWN) == 1)
234       {
235           mi->scalingFunction[WHITE] = &ScaleKPKPw;
236           mi->scalingFunction[BLACK] = &ScaleKPKPb;
237       }
238   }
239
240   // Evaluate the material balance
241
242   int sign;
243   Value egValue = Value(0);
244   Value mgValue = Value(0);
245
246   for (c = WHITE, sign = 1; c <= BLACK; c++, sign = -sign)
247   {
248     // No pawns makes it difficult to win, even with a material advantage
249     if (   pos.piece_count(c, PAWN) == 0
250         && pos.non_pawn_material(c) - pos.non_pawn_material(opposite_color(c)) <= BishopValueMidgame)
251     {
252         if (   pos.non_pawn_material(c) == pos.non_pawn_material(opposite_color(c))
253             || pos.non_pawn_material(c) < RookValueMidgame)
254             mi->factor[c] = 0;
255         else
256         {
257             switch (pos.piece_count(c, BISHOP)) {
258             case 2:
259                 mi->factor[c] = 32;
260                 break;
261             case 1:
262                 mi->factor[c] = 12;
263                 break;
264             case 0:
265                 mi->factor[c] = 6;
266                 break;
267             }
268         }
269     }
270
271     // Bishop pair
272     if (pos.piece_count(c, BISHOP) >= 2)
273     {
274         mgValue += sign * BishopPairMidgameBonus;
275         egValue += sign * BishopPairEndgameBonus;
276     }
277
278     // Knights are stronger when there are many pawns on the board.  The
279     // formula is taken from Larry Kaufman's paper "The Evaluation of Material
280     // Imbalances in Chess":
281     // http://mywebpages.comcast.net/danheisman/Articles/evaluation_of_material_imbalance.htm
282     mgValue += sign * Value(pos.piece_count(c, KNIGHT)*(pos.piece_count(c, PAWN)-5)*16);
283     egValue += sign * Value(pos.piece_count(c, KNIGHT)*(pos.piece_count(c, PAWN)-5)*16);
284
285     // Redundancy of major pieces, again based on Kaufman's paper:
286     if (pos.piece_count(c, ROOK) >= 1)
287     {
288         Value v = Value((pos.piece_count(c, ROOK) - 1) * 32 + pos.piece_count(c, QUEEN) * 16);
289         mgValue -= sign * v;
290         egValue -= sign * v;
291     }
292   }
293   mi->mgValue = int16_t(mgValue);
294   mi->egValue = int16_t(egValue);
295   return mi;
296 }
297
298
299 /// EndgameFunctions member definitions. This class is used to store the maps
300 /// of end game and scaling functions that MaterialInfoTable will query for 
301 /// each key. The maps are constant and are populated only at construction,
302 /// but are per-thread instead of globals to avoid expensive locks.
303
304 EndgameFunctions::EndgameFunctions() {
305
306   typedef Key ZM[2][8][16];
307   const ZM& z = Position::zobMaterial;
308
309   static const Color W = WHITE;
310   static const Color B = BLACK;
311
312   KNNKMaterialKey = z[W][KNIGHT][1] ^ z[W][KNIGHT][2];
313   KKNNMaterialKey = z[B][KNIGHT][1] ^ z[B][KNIGHT][2];
314
315   add(z[W][PAWN][1], &EvaluateKPK);
316   add(z[B][PAWN][1], &EvaluateKKP);
317
318   add(z[W][BISHOP][1] ^ z[W][KNIGHT][1], &EvaluateKBNK);
319   add(z[B][BISHOP][1] ^ z[B][KNIGHT][1], &EvaluateKKBN);
320   add(z[W][ROOK][1]   ^ z[B][PAWN][1],   &EvaluateKRKP);
321   add(z[W][PAWN][1]   ^ z[B][ROOK][1],   &EvaluateKPKR);
322   add(z[W][ROOK][1]   ^ z[B][BISHOP][1], &EvaluateKRKB);
323   add(z[W][BISHOP][1] ^ z[B][ROOK][1],   &EvaluateKBKR);
324   add(z[W][ROOK][1]   ^ z[B][KNIGHT][1], &EvaluateKRKN);
325   add(z[W][KNIGHT][1] ^ z[B][ROOK][1],   &EvaluateKNKR);
326   add(z[W][QUEEN][1]  ^ z[B][ROOK][1],   &EvaluateKQKR);
327   add(z[W][ROOK][1]   ^ z[B][QUEEN][1],  &EvaluateKRKQ);
328   add(z[W][BISHOP][2] ^ z[B][KNIGHT][1], &EvaluateKBBKN);
329   add(z[W][KNIGHT][1] ^ z[B][BISHOP][2], &EvaluateKNKBB);
330
331   add(z[W][KNIGHT][1] ^ z[W][PAWN][1], W, &ScaleKNPK);
332   add(z[B][KNIGHT][1] ^ z[B][PAWN][1], B, &ScaleKKNP);
333
334   add(z[W][ROOK][1]   ^ z[W][PAWN][1]   ^ z[B][ROOK][1]  , W, &ScaleKRPKR);
335   add(z[W][ROOK][1]   ^ z[B][ROOK][1]   ^ z[B][PAWN][1]  , B, &ScaleKRKRP);
336   add(z[W][BISHOP][1] ^ z[W][PAWN][1]   ^ z[B][BISHOP][1], W, &ScaleKBPKB);
337   add(z[W][BISHOP][1] ^ z[B][BISHOP][1] ^ z[B][PAWN][1]  , B, &ScaleKBKBP);
338   add(z[W][BISHOP][1] ^ z[W][PAWN][1]   ^ z[B][KNIGHT][1], W, &ScaleKBPKN);
339   add(z[W][KNIGHT][1] ^ z[B][BISHOP][1] ^ z[B][PAWN][1]  , B, &ScaleKNKBP);
340
341   add(z[W][ROOK][1] ^ z[W][PAWN][1] ^ z[W][PAWN][2] ^ z[B][ROOK][1] ^ z[B][PAWN][1], W, &ScaleKRPPKRP);
342   add(z[W][ROOK][1] ^ z[W][PAWN][1] ^ z[B][ROOK][1] ^ z[B][PAWN][1] ^ z[B][PAWN][2], B, &ScaleKRPKRPP);
343 }
344
345 void EndgameFunctions::add(Key k, EndgameEvaluationFunction* f) {
346
347   EEFmap.insert(std::pair<Key, EndgameEvaluationFunction*>(k, f));
348 }
349
350 void EndgameFunctions::add(Key k, Color c, ScalingFunction* f) {
351
352   ScalingInfo s = {c, f};
353   ESFmap.insert(std::pair<Key, ScalingInfo>(k, s));
354 }
355
356 EndgameEvaluationFunction* EndgameFunctions::getEEF(Key key) const {
357
358   std::map<Key, EndgameEvaluationFunction*>::const_iterator it(EEFmap.find(key));
359   return (it != EEFmap.end() ? it->second : NULL);
360 }
361
362 ScalingFunction* EndgameFunctions::getESF(Key key, Color* c) const {
363
364   std::map<Key, ScalingInfo>::const_iterator it(ESFmap.find(key));
365   if (it == ESFmap.end())
366       return NULL;
367
368   *c = it->second.col;
369   return it->second.fun;
370 }