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