Tidy up
[stockfish] / src / pawns.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>
22 #include <cassert>
23
24 #include "bitboard.h"
25 #include "pawns.h"
26 #include "position.h"
27 #include "thread.h"
28
29 namespace {
30
31   #define V Value
32   #define S(mg, eg) make_score(mg, eg)
33
34   // Isolated pawn penalty by opposed flag
35   const Score Isolated[] = { S(45, 40), S(30, 27) };
36
37   // Backward pawn penalty by opposed flag
38   const Score Backward[] = { S(56, 33), S(41, 19) };
39
40   // Unsupported pawn penalty for pawns which are neither isolated or backward
41   const Score Unsupported = S(17, 8);
42
43   // Connected pawn bonus by opposed, phalanx, twice supported and rank
44   Score Connected[2][2][2][RANK_NB];
45
46   // Doubled pawn penalty
47   const Score Doubled = S(18, 38);
48
49   // Lever bonus by rank
50   const Score Lever[RANK_NB] = {
51     S( 0,  0), S( 0,  0), S(0, 0), S(0, 0),
52     S(17, 16), S(33, 32), S(0, 0), S(0, 0)
53   };
54
55   // Weakness of our pawn shelter in front of the king by [distance from edge][rank].
56   // RANK_1 = 0 is used for files where we have no pawns or our pawn is behind our king.
57   const Value ShelterWeakness[][RANK_NB] = {
58     { V(100), V(20), V(10), V(46), V(82), V( 86), V( 98) },
59     { V(116), V( 4), V(28), V(87), V(94), V(108), V(104) },
60     { V(109), V( 1), V(59), V(87), V(62), V( 91), V(116) },
61     { V( 75), V(12), V(43), V(59), V(90), V( 84), V(112) }
62   };
63
64   // Danger of enemy pawns moving toward our king by [type][distance from edge][rank].
65   // For the unopposed and unblocked cases, RANK_1 = 0 is used when opponent has no pawn
66   // on the given file, or their pawn is behind our king.
67   const Value StormDanger[][4][RANK_NB] = {
68     { { V( 0),  V(-290), V(-274), V(57), V(41) },  //BlockedByKing
69       { V( 0),  V(  60), V( 144), V(39), V(13) },
70       { V( 0),  V(  65), V( 141), V(41), V(34) },
71       { V( 0),  V(  53), V( 127), V(56), V(14) } },
72     { { V( 4),  V(  73), V( 132), V(46), V(31) },  //Unopposed
73       { V( 1),  V(  64), V( 143), V(26), V(13) },
74       { V( 1),  V(  47), V( 110), V(44), V(24) },
75       { V( 0),  V(  72), V( 127), V(50), V(31) } },
76     { { V( 0),  V(   0), V(  79), V(23), V( 1) },  //BlockedByPawn
77       { V( 0),  V(   0), V( 148), V(27), V( 2) },
78       { V( 0),  V(   0), V( 161), V(16), V( 1) },
79       { V( 0),  V(   0), V( 171), V(22), V(15) } },
80     { { V(22),  V(  45), V( 104), V(62), V( 6) },  //Unblocked
81       { V(31),  V(  30), V(  99), V(39), V(19) },
82       { V(23),  V(  29), V(  96), V(41), V(15) },
83       { V(21),  V(  23), V( 116), V(41), V(15) } }
84   };
85
86   // Max bonus for king safety. Corresponds to start position with all the pawns
87   // in front of the king and no enemy pawn on the horizon.
88   const Value MaxSafetyBonus = V(258);
89
90   #undef S
91   #undef V
92
93   template<Color Us>
94   Score evaluate(const Position& pos, Pawns::Entry* e) {
95
96     const Color  Them  = (Us == WHITE ? BLACK      : WHITE);
97     const Square Up    = (Us == WHITE ? NORTH      : SOUTH);
98     const Square Right = (Us == WHITE ? NORTH_EAST : SOUTH_WEST);
99     const Square Left  = (Us == WHITE ? NORTH_WEST : SOUTH_EAST);
100
101     Bitboard b, neighbours, stoppers, doubled, supported, phalanx;
102     Bitboard lever, leverPush, connected;
103     Square s;
104     bool opposed, backward;
105     Score score = SCORE_ZERO;
106     const Square* pl = pos.squares<PAWN>(Us);
107
108     Bitboard ourPawns   = pos.pieces(  Us, PAWN);
109     Bitboard theirPawns = pos.pieces(Them, PAWN);
110
111     e->passedPawns[Us]   = e->pawnAttacksSpan[Us] = 0;
112     e->semiopenFiles[Us] = 0xFF;
113     e->kingSquares[Us]   = SQ_NONE;
114     e->pawnAttacks[Us]   = shift<Right>(ourPawns) | shift<Left>(ourPawns);
115     e->pawnsOnSquares[Us][BLACK] = popcount(ourPawns & DarkSquares);
116     e->pawnsOnSquares[Us][WHITE] = pos.count<PAWN>(Us) - e->pawnsOnSquares[Us][BLACK];
117
118     // Loop through all pawns of the current color and score each pawn
119     while ((s = *pl++) != SQ_NONE)
120     {
121         assert(pos.piece_on(s) == make_piece(Us, PAWN));
122
123         File f = file_of(s);
124
125         e->semiopenFiles[Us]   &= ~(1 << f);
126         e->pawnAttacksSpan[Us] |= pawn_attack_span(Us, s);
127
128         // Flag the pawn
129         opposed    = theirPawns & forward_file_bb(Us, s);
130         stoppers   = theirPawns & passed_pawn_mask(Us, s);
131         lever      = theirPawns & PawnAttacks[Us][s];
132         leverPush  = theirPawns & PawnAttacks[Us][s + Up];
133         doubled    = ourPawns   & (s - Up);
134         neighbours = ourPawns   & adjacent_files_bb(f);
135         phalanx    = neighbours & rank_bb(s);
136         supported  = neighbours & rank_bb(s - Up);
137         connected  = supported | phalanx;
138
139         // A pawn is backward when it is behind all pawns of the same color on the
140         // adjacent files and cannot be safely advanced.
141         if (!neighbours || lever || relative_rank(Us, s) >= RANK_5)
142             backward = false;
143         else
144         {
145             // Find the backmost rank with neighbours or stoppers
146             b = rank_bb(backmost_sq(Us, neighbours | stoppers));
147
148             // The pawn is backward when it cannot safely progress to that rank:
149             // either there is a stopper in the way on this rank, or there is a
150             // stopper on adjacent file which controls the way to that rank.
151             backward = (b | shift<Up>(b & adjacent_files_bb(f))) & stoppers;
152
153             assert(!backward || !(pawn_attack_span(Them, s + Up) & neighbours));
154         }
155
156         // Passed pawns will be properly scored in evaluation because we need
157         // full attack info to evaluate them. Include also not passed pawns
158         // which could become passed after one or two pawn pushes when are
159         // not attacked more times than defended.
160         if (   !(stoppers ^ lever ^ leverPush)
161             && !(ourPawns & forward_file_bb(Us, s))
162             && popcount(supported) >= popcount(lever)
163             && popcount(phalanx)   >= popcount(leverPush))
164             e->passedPawns[Us] |= s;
165
166         else if (   stoppers == SquareBB[s + Up]
167                  && relative_rank(Us, s) >= RANK_5)
168         {
169             b = shift<Up>(supported) & ~theirPawns;
170             while (b)
171                 if (!more_than_one(theirPawns & PawnAttacks[Us][pop_lsb(&b)]))
172                     e->passedPawns[Us] |= s;
173         }
174
175         // Score this pawn
176         if (!neighbours)
177             score -= Isolated[opposed];
178
179         else if (backward)
180             score -= Backward[opposed];
181
182         else if (!supported)
183             score -= Unsupported;
184
185         if (connected)
186             score += Connected[opposed][!!phalanx][more_than_one(supported)][relative_rank(Us, s)];
187
188         if (doubled && !supported)
189             score -= Doubled;
190
191         if (lever)
192             score += Lever[relative_rank(Us, s)];
193     }
194
195     return score;
196   }
197
198 } // namespace
199
200 namespace Pawns {
201
202 /// Pawns::init() initializes some tables needed by evaluation. Instead of using
203 /// hard-coded tables, when makes sense, we prefer to calculate them with a formula
204 /// to reduce independent parameters and to allow easier tuning and better insight.
205
206 void init() {
207
208   static const int Seed[RANK_NB] = { 0, 8, 19, 13, 71, 94, 169, 324 };
209
210   for (int opposed = 0; opposed <= 1; ++opposed)
211       for (int phalanx = 0; phalanx <= 1; ++phalanx)
212           for (int apex = 0; apex <= 1; ++apex)
213               for (Rank r = RANK_2; r < RANK_8; ++r)
214   {
215       int v = (Seed[r] + (phalanx ? (Seed[r + 1] - Seed[r]) / 2 : 0)) >> opposed;
216       v += (apex ? v / 2 : 0);
217       Connected[opposed][phalanx][apex][r] = make_score(v, v * (r-2) / 4);
218   }
219 }
220
221
222 /// Pawns::probe() looks up the current position's pawns configuration in
223 /// the pawns hash table. It returns a pointer to the Entry if the position
224 /// is found. Otherwise a new Entry is computed and stored there, so we don't
225 /// have to recompute all when the same pawns configuration occurs again.
226
227 Entry* probe(const Position& pos) {
228
229   Key key = pos.pawn_key();
230   Entry* e = pos.this_thread()->pawnsTable[key];
231
232   if (e->key == key)
233       return e;
234
235   e->key = key;
236   e->score = evaluate<WHITE>(pos, e) - evaluate<BLACK>(pos, e);
237   e->asymmetry = popcount(e->semiopenFiles[WHITE] ^ e->semiopenFiles[BLACK]);
238   e->openFiles = popcount(e->semiopenFiles[WHITE] & e->semiopenFiles[BLACK]);
239   return e;
240 }
241
242
243 /// Entry::shelter_storm() calculates shelter and storm penalties for the file
244 /// the king is on, as well as the two closest files.
245
246 template<Color Us>
247 Value Entry::shelter_storm(const Position& pos, Square ksq) {
248
249   const Color Them = (Us == WHITE ? BLACK : WHITE);
250
251   enum { BlockedByKing, Unopposed, BlockedByPawn, Unblocked };
252
253   Bitboard b = pos.pieces(PAWN) & (forward_ranks_bb(Us, ksq) | rank_bb(ksq));
254   Bitboard ourPawns = b & pos.pieces(Us);
255   Bitboard theirPawns = b & pos.pieces(Them);
256   Value safety = MaxSafetyBonus;
257   File center = std::max(FILE_B, std::min(FILE_G, file_of(ksq)));
258
259   for (File f = center - File(1); f <= center + File(1); ++f)
260   {
261       b = ourPawns & file_bb(f);
262       Rank rkUs = b ? relative_rank(Us, backmost_sq(Us, b)) : RANK_1;
263
264       b = theirPawns & file_bb(f);
265       Rank rkThem = b ? relative_rank(Us, frontmost_sq(Them, b)) : RANK_1;
266
267       int d = std::min(f, FILE_H - f);
268       safety -=  ShelterWeakness[d][rkUs]
269                + StormDanger
270                  [f == file_of(ksq) && rkThem == relative_rank(Us, ksq) + 1 ? BlockedByKing  :
271                   rkUs   == RANK_1                                          ? Unopposed :
272                   rkThem == rkUs + 1                                        ? BlockedByPawn  : Unblocked]
273                  [d][rkThem];
274   }
275
276   return safety;
277 }
278
279
280 /// Entry::do_king_safety() calculates a bonus for king safety. It is called only
281 /// when king square changes, which is about 20% of total king_safety() calls.
282
283 template<Color Us>
284 Score Entry::do_king_safety(const Position& pos, Square ksq) {
285
286   kingSquares[Us] = ksq;
287   castlingRights[Us] = pos.can_castle(Us);
288   int minKingPawnDistance = 0;
289
290   Bitboard pawns = pos.pieces(Us, PAWN);
291   if (pawns)
292       while (!(DistanceRingBB[ksq][minKingPawnDistance++] & pawns)) {}
293
294   Value bonus = shelter_storm<Us>(pos, ksq);
295
296   // If we can castle use the bonus after the castling if it is bigger
297   if (pos.can_castle(MakeCastling<Us, KING_SIDE>::right))
298       bonus = std::max(bonus, shelter_storm<Us>(pos, relative_square(Us, SQ_G1)));
299
300   if (pos.can_castle(MakeCastling<Us, QUEEN_SIDE>::right))
301       bonus = std::max(bonus, shelter_storm<Us>(pos, relative_square(Us, SQ_C1)));
302
303   return make_score(bonus, -16 * minKingPawnDistance);
304 }
305
306 // Explicit template instantiation
307 template Score Entry::do_king_safety<WHITE>(const Position& pos, Square ksq);
308 template Score Entry::do_king_safety<BLACK>(const Position& pos, Square ksq);
309
310 } // namespace Pawns