Move game_phase() to material.cpp
[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   // QueenMinorsImbalance[opp_minor_count] is applied when only one side has a queen.
62   // It contains a bonus/malus for the side with the queen.
63   const int QueenMinorsImbalance[13] = {
64     31, -8, -15, -25, -5
65   };
66
67   // Endgame evaluation and scaling functions are accessed directly and not through
68   // the function maps because they correspond to more than one material hash key.
69   Endgame<KXK>    EvaluateKXK[] = { Endgame<KXK>(WHITE),    Endgame<KXK>(BLACK) };
70
71   Endgame<KBPsK>  ScaleKBPsK[]  = { Endgame<KBPsK>(WHITE),  Endgame<KBPsK>(BLACK) };
72   Endgame<KQKRPs> ScaleKQKRPs[] = { Endgame<KQKRPs>(WHITE), Endgame<KQKRPs>(BLACK) };
73   Endgame<KPsK>   ScaleKPsK[]   = { Endgame<KPsK>(WHITE),   Endgame<KPsK>(BLACK) };
74   Endgame<KPKP>   ScaleKPKP[]   = { Endgame<KPKP>(WHITE),   Endgame<KPKP>(BLACK) };
75
76   // Helper used to detect a given material distribution
77   bool is_KXK(const Position& pos, Color us) {
78     return  !more_than_one(pos.pieces(~us))
79           && pos.non_pawn_material(us) >= RookValueMg;
80   }
81
82   bool is_KBPsKs(const Position& pos, Color us) {
83     return   pos.non_pawn_material(us) == BishopValueMg
84           && pos.count<BISHOP>(us) == 1
85           && pos.count<PAWN  >(us) >= 1;
86   }
87
88   bool is_KQKRPs(const Position& pos, Color us) {
89     return  !pos.count<PAWN>(us)
90           && pos.non_pawn_material(us) == QueenValueMg
91           && pos.count<QUEEN>(us)  == 1
92           && pos.count<ROOK>(~us) == 1
93           && pos.count<PAWN>(~us) >= 1;
94   }
95
96   /// imbalance() calculates the imbalance by comparing the piece count of each
97   /// piece type for both colors.
98   template<Color Us>
99   int imbalance(const int pieceCount[][PIECE_TYPE_NB]) {
100
101     const Color Them = (Us == WHITE ? BLACK : WHITE);
102
103     int bonus = PawnSet[pieceCount[Us][PAWN]];
104
105     // Second-degree polynomial material imbalance by Tord Romstad
106     for (int pt1 = NO_PIECE_TYPE; pt1 <= QUEEN; ++pt1)
107     {
108         if (!pieceCount[Us][pt1])
109             continue;
110
111         int v = 0;
112
113         for (int pt2 = NO_PIECE_TYPE; pt2 <= pt1; ++pt2)
114             v +=  QuadraticOurs[pt1][pt2] * pieceCount[Us][pt2]
115                 + QuadraticTheirs[pt1][pt2] * pieceCount[Them][pt2];
116
117         bonus += pieceCount[Us][pt1] * v;
118     }
119
120     // Special handling of Queen vs. Minors
121     if  (pieceCount[Us][QUEEN] == 1 && pieceCount[Them][QUEEN] == 0)
122          bonus += QueenMinorsImbalance[pieceCount[Them][KNIGHT] + pieceCount[Them][BISHOP]];
123
124     return bonus;
125   }
126
127 } // namespace
128
129 namespace Material {
130
131 /// Material::probe() looks up the current position's material configuration in
132 /// the material hash table. It returns a pointer to the Entry if the position
133 /// is found. Otherwise a new Entry is computed and stored there, so we don't
134 /// have to recompute all when the same material configuration occurs again.
135
136 Entry* probe(const Position& pos) {
137
138   Key key = pos.material_key();
139   Entry* e = pos.this_thread()->materialTable[key];
140
141   if (e->key == key)
142       return e;
143
144   std::memset(e, 0, sizeof(Entry));
145   e->key = key;
146   e->factor[WHITE] = e->factor[BLACK] = (uint8_t)SCALE_FACTOR_NORMAL;
147
148   Value npm_w = pos.non_pawn_material(WHITE);
149   Value npm_b = pos.non_pawn_material(BLACK);
150   Value npm = std::max(EndgameLimit, std::min(npm_w + npm_b, MidgameLimit));
151
152   // Map total non-pawn material into [PHASE_ENDGAME, PHASE_MIDGAME]
153   e->gamePhase = Phase(((npm - EndgameLimit) * PHASE_MIDGAME) / (MidgameLimit - EndgameLimit));
154
155   // Let's look if we have a specialized evaluation function for this particular
156   // material configuration. Firstly we look for a fixed configuration one, then
157   // for a generic one if the previous search failed.
158   if ((e->evaluationFunction = pos.this_thread()->endgames.probe<Value>(key)) != nullptr)
159       return e;
160
161   for (Color c = WHITE; c <= BLACK; ++c)
162       if (is_KXK(pos, c))
163       {
164           e->evaluationFunction = &EvaluateKXK[c];
165           return e;
166       }
167
168   // OK, we didn't find any special evaluation function for the current material
169   // configuration. Is there a suitable specialized scaling function?
170   EndgameBase<ScaleFactor>* sf;
171
172   if ((sf = pos.this_thread()->endgames.probe<ScaleFactor>(key)) != nullptr)
173   {
174       e->scalingFunction[sf->strongSide] = sf; // Only strong color assigned
175       return e;
176   }
177
178   // We didn't find any specialized scaling function, so fall back on generic
179   // ones that refer to more than one material distribution. Note that in this
180   // case we don't return after setting the function.
181   for (Color c = WHITE; c <= BLACK; ++c)
182   {
183     if (is_KBPsKs(pos, c))
184         e->scalingFunction[c] = &ScaleKBPsK[c];
185
186     else if (is_KQKRPs(pos, c))
187         e->scalingFunction[c] = &ScaleKQKRPs[c];
188   }
189
190   if (npm_w + npm_b == VALUE_ZERO && pos.pieces(PAWN)) // Only pawns on the board
191   {
192       if (!pos.count<PAWN>(BLACK))
193       {
194           assert(pos.count<PAWN>(WHITE) >= 2);
195
196           e->scalingFunction[WHITE] = &ScaleKPsK[WHITE];
197       }
198       else if (!pos.count<PAWN>(WHITE))
199       {
200           assert(pos.count<PAWN>(BLACK) >= 2);
201
202           e->scalingFunction[BLACK] = &ScaleKPsK[BLACK];
203       }
204       else if (pos.count<PAWN>(WHITE) == 1 && pos.count<PAWN>(BLACK) == 1)
205       {
206           // This is a special case because we set scaling functions
207           // for both colors instead of only one.
208           e->scalingFunction[WHITE] = &ScaleKPKP[WHITE];
209           e->scalingFunction[BLACK] = &ScaleKPKP[BLACK];
210       }
211   }
212
213   // Zero or just one pawn makes it difficult to win, even with a small material
214   // advantage. This catches some trivial draws like KK, KBK and KNK and gives a
215   // drawish scale factor for cases such as KRKBP and KmmKm (except for KBBKN).
216   if (!pos.count<PAWN>(WHITE) && npm_w - npm_b <= BishopValueMg)
217       e->factor[WHITE] = uint8_t(npm_w <  RookValueMg   ? SCALE_FACTOR_DRAW :
218                                  npm_b <= BishopValueMg ? 4 : 14);
219
220   if (!pos.count<PAWN>(BLACK) && npm_b - npm_w <= BishopValueMg)
221       e->factor[BLACK] = uint8_t(npm_b <  RookValueMg   ? SCALE_FACTOR_DRAW :
222                                  npm_w <= BishopValueMg ? 4 : 14);
223
224   if (pos.count<PAWN>(WHITE) == 1 && npm_w - npm_b <= BishopValueMg)
225       e->factor[WHITE] = (uint8_t) SCALE_FACTOR_ONEPAWN;
226
227   if (pos.count<PAWN>(BLACK) == 1 && npm_b - npm_w <= BishopValueMg)
228       e->factor[BLACK] = (uint8_t) SCALE_FACTOR_ONEPAWN;
229
230   // Evaluate the material imbalance. We use PIECE_TYPE_NONE as a place holder
231   // for the bishop pair "extended piece", which allows us to be more flexible
232   // in defining bishop pair bonuses.
233   const int PieceCount[COLOR_NB][PIECE_TYPE_NB] = {
234   { pos.count<BISHOP>(WHITE) > 1, pos.count<PAWN>(WHITE), pos.count<KNIGHT>(WHITE),
235     pos.count<BISHOP>(WHITE)    , pos.count<ROOK>(WHITE), pos.count<QUEEN >(WHITE) },
236   { pos.count<BISHOP>(BLACK) > 1, pos.count<PAWN>(BLACK), pos.count<KNIGHT>(BLACK),
237     pos.count<BISHOP>(BLACK)    , pos.count<ROOK>(BLACK), pos.count<QUEEN >(BLACK) } };
238
239   e->value = int16_t((imbalance<WHITE>(PieceCount) - imbalance<BLACK>(PieceCount)) / 16);
240   return e;
241 }
242
243 } // namespace Material