Fix a typo
[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-2014 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 #include <algorithm>  // For std::min
21 #include <cassert>
22 #include <cstring>
23
24 #include "material.h"
25
26 using namespace std;
27
28 namespace {
29
30   // Values modified by Joona Kiiski
31   const Value MidgameLimit = Value(15581);
32   const Value EndgameLimit = Value(3998);
33
34   // Polynomial material balance parameters
35
36   //                                  pair  pawn knight bishop rook queen
37   const int LinearCoefficients[6] = { 1852, -162, -1122, -183,  249, -52 };
38
39   const int QuadraticCoefficientsSameColor[][PIECE_TYPE_NB] = {
40     // pair pawn knight bishop rook queen
41     {   0                               }, // Bishop pair
42     {  39,    2                         }, // Pawn
43     {  35,  271,  -4                    }, // Knight
44     {   0,  105,   4,    0              }, // Bishop
45     { -27,   -2,  46,   100,  -141      }, // Rook
46     {  58,   29,  83,   148,  -163,   0 }  // Queen
47   };
48
49   const int QuadraticCoefficientsOppositeColor[][PIECE_TYPE_NB] = {
50     //           THEIR PIECES
51     // pair pawn knight bishop rook queen
52     {   0                               }, // Bishop pair
53     {  37,    0                         }, // Pawn
54     {  10,   62,   0                    }, // Knight      OUR PIECES
55     {  57,   64,  39,     0             }, // Bishop
56     {  50,   40,  23,   -22,    0       }, // Rook
57     { 106,  101,   3,   151,  171,    0 }  // Queen
58   };
59
60   // Endgame evaluation and scaling functions are accessed directly and not through
61   // the function maps because they correspond to more than one material hash key.
62   Endgame<KXK>   EvaluateKXK[]   = { Endgame<KXK>(WHITE),   Endgame<KXK>(BLACK) };
63
64   Endgame<KBPsK>  ScaleKBPsK[]  = { Endgame<KBPsK>(WHITE),  Endgame<KBPsK>(BLACK) };
65   Endgame<KQKRPs> ScaleKQKRPs[] = { Endgame<KQKRPs>(WHITE), Endgame<KQKRPs>(BLACK) };
66   Endgame<KPsK>   ScaleKPsK[]   = { Endgame<KPsK>(WHITE),   Endgame<KPsK>(BLACK) };
67   Endgame<KPKP>   ScaleKPKP[]   = { Endgame<KPKP>(WHITE),   Endgame<KPKP>(BLACK) };
68
69   // Helper templates used to detect a given material distribution
70   template<Color Us> bool is_KXK(const Position& pos) {
71     const Color Them = (Us == WHITE ? BLACK : WHITE);
72     return  !pos.count<PAWN>(Them)
73           && pos.non_pawn_material(Them) == VALUE_ZERO
74           && pos.non_pawn_material(Us) >= RookValueMg;
75   }
76
77   template<Color Us> bool is_KBPsKs(const Position& pos) {
78     return   pos.non_pawn_material(Us) == BishopValueMg
79           && pos.count<BISHOP>(Us) == 1
80           && pos.count<PAWN  >(Us) >= 1;
81   }
82
83   template<Color Us> bool is_KQKRPs(const Position& pos) {
84     const Color Them = (Us == WHITE ? BLACK : WHITE);
85     return  !pos.count<PAWN>(Us)
86           && pos.non_pawn_material(Us) == QueenValueMg
87           && pos.count<QUEEN>(Us)  == 1
88           && pos.count<ROOK>(Them) == 1
89           && pos.count<PAWN>(Them) >= 1;
90   }
91
92   /// imbalance() calculates the imbalance by comparing the piece count of each
93   /// piece type for both colors.
94
95   template<Color Us>
96   int imbalance(const int pieceCount[][PIECE_TYPE_NB]) {
97
98     const Color Them = (Us == WHITE ? BLACK : WHITE);
99
100     int pt1, pt2, pc, v;
101     int value = 0;
102
103     // Second-degree polynomial material imbalance by Tord Romstad
104     for (pt1 = NO_PIECE_TYPE; pt1 <= QUEEN; ++pt1)
105     {
106         pc = pieceCount[Us][pt1];
107         if (!pc)
108             continue;
109
110         v = LinearCoefficients[pt1];
111
112         for (pt2 = NO_PIECE_TYPE; pt2 <= pt1; ++pt2)
113             v +=  QuadraticCoefficientsSameColor[pt1][pt2] * pieceCount[Us][pt2]
114                 + QuadraticCoefficientsOppositeColor[pt1][pt2] * pieceCount[Them][pt2];
115
116         value += pc * v;
117     }
118     return value;
119   }
120
121 } // namespace
122
123 namespace Material {
124
125 /// Material::probe() takes a position object as input, looks up a MaterialEntry
126 /// object, and returns a pointer to it. If the material configuration is not
127 /// already present in the table, it is computed and stored there, so we don't
128 /// have to recompute everything when the same material configuration occurs again.
129
130 Entry* probe(const Position& pos, Table& entries, Endgames& endgames) {
131
132   Key key = pos.material_key();
133   Entry* e = entries[key];
134
135   // If e->key matches the position's material hash key, it means that we
136   // have analysed this material configuration before, and we can simply
137   // return the information we found the last time instead of recomputing it.
138   if (e->key == key)
139       return e;
140
141   std::memset(e, 0, sizeof(Entry));
142   e->key = key;
143   e->factor[WHITE] = e->factor[BLACK] = (uint8_t)SCALE_FACTOR_NORMAL;
144   e->gamePhase = game_phase(pos);
145
146   // Let's look if we have a specialized evaluation function for this particular
147   // material configuration. Firstly we look for a fixed configuration one, then
148   // for a generic one if the previous search failed.
149   if (endgames.probe(key, e->evaluationFunction))
150       return e;
151
152   if (is_KXK<WHITE>(pos))
153   {
154       e->evaluationFunction = &EvaluateKXK[WHITE];
155       return e;
156   }
157
158   if (is_KXK<BLACK>(pos))
159   {
160       e->evaluationFunction = &EvaluateKXK[BLACK];
161       return e;
162   }
163
164   // OK, we didn't find any special evaluation function for the current
165   // material configuration. Is there a suitable scaling function?
166   //
167   // We face problems when there are several conflicting applicable
168   // scaling functions and we need to decide which one to use.
169   EndgameBase<ScaleFactor>* sf;
170
171   if (endgames.probe(key, sf))
172   {
173       e->scalingFunction[sf->color()] = sf;
174       return e;
175   }
176
177   // Generic scaling functions that refer to more than one material
178   // distribution. They should be probed after the specialized ones.
179   // Note that these ones don't return after setting the function.
180   if (is_KBPsKs<WHITE>(pos))
181       e->scalingFunction[WHITE] = &ScaleKBPsK[WHITE];
182
183   if (is_KBPsKs<BLACK>(pos))
184       e->scalingFunction[BLACK] = &ScaleKBPsK[BLACK];
185
186   if (is_KQKRPs<WHITE>(pos))
187       e->scalingFunction[WHITE] = &ScaleKQKRPs[WHITE];
188
189   else if (is_KQKRPs<BLACK>(pos))
190       e->scalingFunction[BLACK] = &ScaleKQKRPs[BLACK];
191
192   Value npm_w = pos.non_pawn_material(WHITE);
193   Value npm_b = pos.non_pawn_material(BLACK);
194
195   if (npm_w + npm_b == VALUE_ZERO && pos.pieces(PAWN))
196   {
197       if (!pos.count<PAWN>(BLACK))
198       {
199           assert(pos.count<PAWN>(WHITE) >= 2);
200           e->scalingFunction[WHITE] = &ScaleKPsK[WHITE];
201       }
202       else if (!pos.count<PAWN>(WHITE))
203       {
204           assert(pos.count<PAWN>(BLACK) >= 2);
205           e->scalingFunction[BLACK] = &ScaleKPsK[BLACK];
206       }
207       else if (pos.count<PAWN>(WHITE) == 1 && pos.count<PAWN>(BLACK) == 1)
208       {
209           // This is a special case because we set scaling functions
210           // for both colors instead of only one.
211           e->scalingFunction[WHITE] = &ScaleKPKP[WHITE];
212           e->scalingFunction[BLACK] = &ScaleKPKP[BLACK];
213       }
214   }
215
216   // No pawns makes it difficult to win, even with a material advantage. This
217   // catches some trivial draws like KK, KBK and KNK and gives a very drawish
218   // scale factor for cases such as KRKBP and KmmKm (except for KBBKN).
219   if (!pos.count<PAWN>(WHITE) && npm_w - npm_b <= BishopValueMg)
220       e->factor[WHITE] = uint8_t(npm_w < RookValueMg ? SCALE_FACTOR_DRAW : npm_b <= BishopValueMg ? 4 : 12);
221
222   if (!pos.count<PAWN>(BLACK) && npm_b - npm_w <= BishopValueMg)
223       e->factor[BLACK] = uint8_t(npm_b < RookValueMg ? SCALE_FACTOR_DRAW : npm_w <= BishopValueMg ? 4 : 12);
224
225   if (pos.count<PAWN>(WHITE) == 1 && npm_w - npm_b <= BishopValueMg)
226       e->factor[WHITE] = (uint8_t) SCALE_FACTOR_ONEPAWN;
227
228   if (pos.count<PAWN>(BLACK) == 1 && npm_b - npm_w <= BishopValueMg)
229       e->factor[BLACK] = (uint8_t) SCALE_FACTOR_ONEPAWN;
230
231   // Compute the space weight
232   if (npm_w + npm_b >= 2 * QueenValueMg + 4 * RookValueMg + 2 * KnightValueMg)
233   {
234       int minorPieceCount =  pos.count<KNIGHT>(WHITE) + pos.count<BISHOP>(WHITE)
235                            + pos.count<KNIGHT>(BLACK) + pos.count<BISHOP>(BLACK);
236
237       e->spaceWeight = make_score(minorPieceCount * minorPieceCount, 0);
238   }
239
240   // Evaluate the material imbalance. We use PIECE_TYPE_NONE as a place holder
241   // for the bishop pair "extended piece", which allows us to be more flexible
242   // in defining bishop pair bonuses.
243   const int pieceCount[COLOR_NB][PIECE_TYPE_NB] = {
244   { pos.count<BISHOP>(WHITE) > 1, pos.count<PAWN>(WHITE), pos.count<KNIGHT>(WHITE),
245     pos.count<BISHOP>(WHITE)    , pos.count<ROOK>(WHITE), pos.count<QUEEN >(WHITE) },
246   { pos.count<BISHOP>(BLACK) > 1, pos.count<PAWN>(BLACK), pos.count<KNIGHT>(BLACK),
247     pos.count<BISHOP>(BLACK)    , pos.count<ROOK>(BLACK), pos.count<QUEEN >(BLACK) } };
248
249   e->value = (int16_t)((imbalance<WHITE>(pieceCount) - imbalance<BLACK>(pieceCount)) / 16);
250   return e;
251 }
252
253
254 /// Material::game_phase() calculates the phase given the current
255 /// position. Because the phase is strictly a function of the material, it
256 /// is stored in MaterialEntry.
257
258 Phase game_phase(const Position& pos) {
259
260   Value npm = pos.non_pawn_material(WHITE) + pos.non_pawn_material(BLACK);
261
262   return  npm >= MidgameLimit ? PHASE_MIDGAME
263         : npm <= EndgameLimit ? PHASE_ENDGAME
264         : Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
265 }
266
267 } // namespace Material