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