Better naming in endgame code
[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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2017 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include <algorithm> // For std::min
22 #include <cassert>
23 #include <cstring>   // For std::memset
24
25 #include "material.h"
26 #include "thread.h"
27
28 using namespace std;
29
30 namespace {
31
32   // Polynomial material imbalance parameters
33
34   const int QuadraticOurs[][PIECE_TYPE_NB] = {
35     //            OUR PIECES
36     // pair pawn knight bishop rook queen
37     {1667                               }, // Bishop pair
38     {  40,    0                         }, // Pawn
39     {  32,  255,  -3                    }, // Knight      OUR PIECES
40     {   0,  104,   4,    0              }, // Bishop
41     { -26,   -2,  47,   105,  -149      }, // Rook
42     {-185,   24, 122,   137,  -134,   0 }  // Queen
43   };
44
45   const int QuadraticTheirs[][PIECE_TYPE_NB] = {
46     //           THEIR PIECES
47     // pair pawn knight bishop rook queen
48     {   0                               }, // Bishop pair
49     {  36,    0                         }, // Pawn
50     {   9,   63,   0                    }, // Knight      OUR PIECES
51     {  59,   65,  42,     0             }, // Bishop
52     {  46,   39,  24,   -24,    0       }, // Rook
53     { 101,  100, -37,   141,  268,    0 }  // Queen
54   };
55
56   // PawnSet[pawn count] contains a bonus/malus indexed by number of pawns
57   const int PawnSet[] = {
58     24, -32, 107, -51, 117, -9, -126, -21, 31
59   };
60
61   // Endgame evaluation and scaling functions are accessed directly and not through
62   // the function maps because they correspond to more than one material hash key.
63   Endgame<KXK>    EvaluateKXK[] = { Endgame<KXK>(WHITE),    Endgame<KXK>(BLACK) };
64
65   Endgame<KBPsK>  ScaleKBPsK[]  = { Endgame<KBPsK>(WHITE),  Endgame<KBPsK>(BLACK) };
66   Endgame<KQKRPs> ScaleKQKRPs[] = { Endgame<KQKRPs>(WHITE), Endgame<KQKRPs>(BLACK) };
67   Endgame<KPsK>   ScaleKPsK[]   = { Endgame<KPsK>(WHITE),   Endgame<KPsK>(BLACK) };
68   Endgame<KPKP>   ScaleKPKP[]   = { Endgame<KPKP>(WHITE),   Endgame<KPKP>(BLACK) };
69
70   // Helper used to detect a given material distribution
71   bool is_KXK(const Position& pos, Color us) {
72     return  !more_than_one(pos.pieces(~us))
73           && pos.non_pawn_material(us) >= RookValueMg;
74   }
75
76   bool is_KBPsKs(const Position& pos, Color us) {
77     return   pos.non_pawn_material(us) == BishopValueMg
78           && pos.count<BISHOP>(us) == 1
79           && pos.count<PAWN  >(us) >= 1;
80   }
81
82   bool is_KQKRPs(const Position& pos, Color us) {
83     return  !pos.count<PAWN>(us)
84           && pos.non_pawn_material(us) == QueenValueMg
85           && pos.count<QUEEN>(us)  == 1
86           && pos.count<ROOK>(~us) == 1
87           && pos.count<PAWN>(~us) >= 1;
88   }
89
90   /// imbalance() calculates the imbalance by comparing the piece count of each
91   /// piece type for both colors.
92   template<Color Us>
93   int imbalance(const int pieceCount[][PIECE_TYPE_NB]) {
94
95     const Color Them = (Us == WHITE ? BLACK : WHITE);
96
97     int bonus = PawnSet[pieceCount[Us][PAWN]];
98
99     // Second-degree polynomial material imbalance by Tord Romstad
100     for (int pt1 = NO_PIECE_TYPE; pt1 <= QUEEN; ++pt1)
101     {
102         if (!pieceCount[Us][pt1])
103             continue;
104
105         int v = 0;
106
107         for (int pt2 = NO_PIECE_TYPE; pt2 <= pt1; ++pt2)
108             v +=  QuadraticOurs[pt1][pt2] * pieceCount[Us][pt2]
109                 + QuadraticTheirs[pt1][pt2] * pieceCount[Them][pt2];
110
111         bonus += pieceCount[Us][pt1] * v;
112     }
113
114     return bonus;
115   }
116
117 } // namespace
118
119 namespace Material {
120
121 /// Material::probe() looks up the current position's material configuration in
122 /// the material hash table. It returns a pointer to the Entry if the position
123 /// is found. Otherwise a new Entry is computed and stored there, so we don't
124 /// have to recompute all when the same material configuration occurs again.
125
126 Entry* probe(const Position& pos) {
127
128   Key key = pos.material_key();
129   Entry* e = pos.this_thread()->materialTable[key];
130
131   if (e->key == key)
132       return e;
133
134   std::memset(e, 0, sizeof(Entry));
135   e->key = key;
136   e->factor[WHITE] = e->factor[BLACK] = (uint8_t)SCALE_FACTOR_NORMAL;
137   e->gamePhase = pos.game_phase();
138
139   // Let's look if we have a specialized evaluation function for this particular
140   // material configuration. Firstly we look for a fixed configuration one, then
141   // for a generic one if the previous search failed.
142   if ((e->evaluationFunction = pos.this_thread()->endgames.probe<Value>(key)) != nullptr)
143       return e;
144
145   for (Color c = WHITE; c <= BLACK; ++c)
146       if (is_KXK(pos, c))
147       {
148           e->evaluationFunction = &EvaluateKXK[c];
149           return e;
150       }
151
152   // OK, we didn't find any special evaluation function for the current material
153   // configuration. Is there a suitable specialized scaling function?
154   EndgameBase<ScaleFactor>* sf;
155
156   if ((sf = pos.this_thread()->endgames.probe<ScaleFactor>(key)) != nullptr)
157   {
158       e->scalingFunction[sf->strongSide] = sf; // Only strong color assigned
159       return e;
160   }
161
162   // We didn't find any specialized scaling function, so fall back on generic
163   // ones that refer to more than one material distribution. Note that in this
164   // case we don't return after setting the function.
165   for (Color c = WHITE; c <= BLACK; ++c)
166   {
167     if (is_KBPsKs(pos, c))
168         e->scalingFunction[c] = &ScaleKBPsK[c];
169
170     else if (is_KQKRPs(pos, c))
171         e->scalingFunction[c] = &ScaleKQKRPs[c];
172   }
173
174   Value npm_w = pos.non_pawn_material(WHITE);
175   Value npm_b = pos.non_pawn_material(BLACK);
176
177   if (npm_w + npm_b == VALUE_ZERO && pos.pieces(PAWN)) // Only pawns on the board
178   {
179       if (!pos.count<PAWN>(BLACK))
180       {
181           assert(pos.count<PAWN>(WHITE) >= 2);
182
183           e->scalingFunction[WHITE] = &ScaleKPsK[WHITE];
184       }
185       else if (!pos.count<PAWN>(WHITE))
186       {
187           assert(pos.count<PAWN>(BLACK) >= 2);
188
189           e->scalingFunction[BLACK] = &ScaleKPsK[BLACK];
190       }
191       else if (pos.count<PAWN>(WHITE) == 1 && pos.count<PAWN>(BLACK) == 1)
192       {
193           // This is a special case because we set scaling functions
194           // for both colors instead of only one.
195           e->scalingFunction[WHITE] = &ScaleKPKP[WHITE];
196           e->scalingFunction[BLACK] = &ScaleKPKP[BLACK];
197       }
198   }
199
200   // Zero or just one pawn makes it difficult to win, even with a small material
201   // advantage. This catches some trivial draws like KK, KBK and KNK and gives a
202   // drawish scale factor for cases such as KRKBP and KmmKm (except for KBBKN).
203   if (!pos.count<PAWN>(WHITE) && npm_w - npm_b <= BishopValueMg)
204       e->factor[WHITE] = uint8_t(npm_w <  RookValueMg   ? SCALE_FACTOR_DRAW :
205                                  npm_b <= BishopValueMg ? 4 : 14);
206
207   if (!pos.count<PAWN>(BLACK) && npm_b - npm_w <= BishopValueMg)
208       e->factor[BLACK] = uint8_t(npm_b <  RookValueMg   ? SCALE_FACTOR_DRAW :
209                                  npm_w <= BishopValueMg ? 4 : 14);
210
211   if (pos.count<PAWN>(WHITE) == 1 && npm_w - npm_b <= BishopValueMg)
212       e->factor[WHITE] = (uint8_t) SCALE_FACTOR_ONEPAWN;
213
214   if (pos.count<PAWN>(BLACK) == 1 && npm_b - npm_w <= BishopValueMg)
215       e->factor[BLACK] = (uint8_t) SCALE_FACTOR_ONEPAWN;
216
217   // Evaluate the material imbalance. We use PIECE_TYPE_NONE as a place holder
218   // for the bishop pair "extended piece", which allows us to be more flexible
219   // in defining bishop pair bonuses.
220   const int PieceCount[COLOR_NB][PIECE_TYPE_NB] = {
221   { pos.count<BISHOP>(WHITE) > 1, pos.count<PAWN>(WHITE), pos.count<KNIGHT>(WHITE),
222     pos.count<BISHOP>(WHITE)    , pos.count<ROOK>(WHITE), pos.count<QUEEN >(WHITE) },
223   { pos.count<BISHOP>(BLACK) > 1, pos.count<PAWN>(BLACK), pos.count<KNIGHT>(BLACK),
224     pos.count<BISHOP>(BLACK)    , pos.count<ROOK>(BLACK), pos.count<QUEEN >(BLACK) } };
225
226   e->value = int16_t((imbalance<WHITE>(PieceCount) - imbalance<BLACK>(PieceCount)) / 16);
227   return e;
228 }
229
230 } // namespace Material