Cleanup pawn storm code
[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-2010 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
21 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cstring>
27
28 #include "bitcount.h"
29 #include "pawns.h"
30 #include "position.h"
31
32
33 ////
34 //// Local definitions
35 ////
36
37 namespace {
38
39   /// Constants and variables
40
41   #define S(mg, eg) make_score(mg, eg)
42
43   // Doubled pawn penalty by file
44   const Score DoubledPawnPenalty[8] = {
45     S(13, 43), S(20, 48), S(23, 48), S(23, 48),
46     S(23, 48), S(23, 48), S(20, 48), S(13, 43)
47   };
48
49   // Isolated pawn penalty by file
50   const Score IsolatedPawnPenalty[8] = {
51     S(25, 30), S(36, 35), S(40, 35), S(40, 35),
52     S(40, 35), S(40, 35), S(36, 35), S(25, 30)
53   };
54
55   // Backward pawn penalty by file
56   const Score BackwardPawnPenalty[8] = {
57     S(20, 28), S(29, 31), S(33, 31), S(33, 31),
58     S(33, 31), S(33, 31), S(29, 31), S(20, 28)
59   };
60
61   // Pawn chain membership bonus by file
62   const Score ChainBonus[8] = {
63     S(11,-1), S(13,-1), S(13,-1), S(14,-1),
64     S(14,-1), S(13,-1), S(13,-1), S(11,-1)
65   };
66
67   // Candidate passed pawn bonus by rank
68   const Score CandidateBonus[8] = {
69     S( 0, 0), S( 6, 13), S(6,13), S(14,29),
70     S(34,68), S(83,166), S(0, 0), S( 0, 0)
71   };
72
73   // Pawn storm tables for positions with opposite castling
74   const int QStormTable[64] = {
75     0,  0,  0,  0, 0, 0, 0, 0,
76   -22,-22,-22,-14,-6, 0, 0, 0,
77    -6,-10,-10,-10,-6, 0, 0, 0,
78     4, 12, 16, 12, 4, 0, 0, 0,
79    16, 23, 23, 16, 0, 0, 0, 0,
80    23, 31, 31, 23, 0, 0, 0, 0,
81    23, 31, 31, 23, 0, 0, 0, 0,
82     0,  0,  0,  0, 0, 0, 0, 0
83   };
84
85   const int KStormTable[64] = {
86     0, 0, 0,  0,  0,  0,  0,  0,
87     0, 0, 0,-10,-19,-28,-33,-33,
88     0, 0, 0,-10,-15,-19,-24,-24,
89     0, 0, 0,  0,  1,  1,  1,  1,
90     0, 0, 0,  0,  1, 10, 19, 19,
91     0, 0, 0,  0,  1, 19, 31, 27,
92     0, 0, 0,  0,  0, 22, 31, 22,
93     0, 0, 0,  0,  0,  0,  0,  0
94   };
95
96   // Pawn storm open file bonuses by file
97   const int16_t KStormOpenFileBonus[8] = { 31, 31, 18, 0, 0, 0, 0, 0 };
98   const int16_t QStormOpenFileBonus[8] = { 0, 0, 0, 0, 0, 26, 42, 26 };
99
100   // Pawn storm lever bonuses by file
101   const int StormLeverBonus[8] = { -8, -8, -13, 0, 0, -13, -8, -8 };
102
103 }
104
105
106 ////
107 //// Functions
108 ////
109
110 /// Constructor
111
112 PawnInfoTable::PawnInfoTable(unsigned numOfEntries) {
113
114   size = numOfEntries;
115   entries = new PawnInfo[size];
116   if (!entries)
117   {
118       std::cerr << "Failed to allocate " << (numOfEntries * sizeof(PawnInfo))
119                 << " bytes for pawn hash table." << std::endl;
120       Application::exit_with_failure();
121   }
122 }
123
124
125 /// Destructor
126
127 PawnInfoTable::~PawnInfoTable() {
128   delete [] entries;
129 }
130
131
132 /// PawnInfo::clear() resets to zero the PawnInfo entry. Note that
133 /// kingSquares[] is initialized to SQ_NONE instead.
134
135 void PawnInfo::clear() {
136
137   memset(this, 0, sizeof(PawnInfo));
138   kingSquares[WHITE] = kingSquares[BLACK] = SQ_NONE;
139 }
140
141
142 /// PawnInfoTable::get_pawn_info() takes a position object as input, computes
143 /// a PawnInfo object, and returns a pointer to it.  The result is also
144 /// stored in a hash table, so we don't have to recompute everything when
145 /// the same pawn structure occurs again.
146
147 PawnInfo* PawnInfoTable::get_pawn_info(const Position& pos) {
148
149   assert(pos.is_ok());
150
151   Key key = pos.get_pawn_key();
152   int index = int(key & (size - 1));
153   PawnInfo* pi = entries + index;
154
155   // If pi->key matches the position's pawn hash key, it means that we
156   // have analysed this pawn structure before, and we can simply return
157   // the information we found the last time instead of recomputing it.
158   if (pi->key == key)
159       return pi;
160
161   // Clear the PawnInfo object, and set the key
162   pi->clear();
163   pi->key = key;
164
165   // Calculate pawn attacks
166   Bitboard whitePawns = pos.pieces(PAWN, WHITE);
167   Bitboard blackPawns = pos.pieces(PAWN, BLACK);
168   pi->pawnAttacks[WHITE] = ((whitePawns << 9) & ~FileABB) | ((whitePawns << 7) & ~FileHBB);
169   pi->pawnAttacks[BLACK] = ((blackPawns >> 7) & ~FileABB) | ((blackPawns >> 9) & ~FileHBB);
170
171   // Evaluate pawns for both colors
172   pi->value =  evaluate_pawns<WHITE>(pos, whitePawns, blackPawns, pi)
173              - evaluate_pawns<BLACK>(pos, blackPawns, whitePawns, pi);
174   return pi;
175 }
176
177
178 /// PawnInfoTable::evaluate_pawns() evaluates each pawn of the given color
179
180 template<Color Us>
181 Score PawnInfoTable::evaluate_pawns(const Position& pos, Bitboard ourPawns,
182                                     Bitboard theirPawns, PawnInfo* pi) {
183   Square s;
184   File f;
185   Rank r;
186   bool passed, isolated, doubled, chain, backward, candidate;
187   int bonus;
188   Score value = make_score(0, 0);
189   const Square* ptr = pos.piece_list_begin(Us, PAWN);
190
191   // Initialize pawn storm scores by giving bonuses for open files
192   for (f = FILE_A; f <= FILE_H; f++)
193       if (!(ourPawns & file_bb(f)))
194       {
195           pi->ksStormValue[Us] += KStormOpenFileBonus[f];
196           pi->qsStormValue[Us] += QStormOpenFileBonus[f];
197           pi->halfOpenFiles[Us] |= (1 << f);
198       }
199
200   // Loop through all pawns of the current color and score each pawn
201   while ((s = *ptr++) != SQ_NONE)
202   {
203       f = square_file(s);
204       r = square_rank(s);
205
206       assert(pos.piece_on(s) == piece_of_color_and_type(Us, PAWN));
207
208       // Passed, isolated or doubled pawn?
209       passed   = Position::pawn_is_passed(theirPawns, Us, s);
210       isolated = Position::pawn_is_isolated(ourPawns, s);
211       doubled  = Position::pawn_is_doubled(ourPawns, Us, s);
212
213       // We calculate kingside and queenside pawn storm
214       // scores for both colors. These are used when evaluating
215       // middle game positions with opposite side castling.
216       //
217       // Each pawn is given a base score given by a piece square table
218       // (KStormTable[] or QStormTable[]). Pawns which seem to have good
219       // chances of creating an open file by exchanging itself against an
220       // enemy pawn on an adjacent file gets an additional bonus.
221
222       // Kingside pawn storms
223       bonus = KStormTable[relative_square(Us, s)];
224       if (f >= FILE_F)
225       {
226           Bitboard b = outpost_mask(Us, s) & theirPawns & (FileFBB | FileGBB | FileHBB);
227           while (b)
228           {
229               // Give a bonus according to the distance of the nearest enemy pawn
230               Square s2 = pop_1st_bit(&b);
231               int v = StormLeverBonus[f] - 2 * square_distance(s, s2);
232
233               // If enemy pawn has no pawn beside itself is particularly vulnerable.
234               // Big bonus, especially against a weakness on the rook file
235               if (!(theirPawns & neighboring_files_bb(s2) & rank_bb(s2)))
236                   v *= (square_file(s2) == FILE_H ? 4 : 2);
237
238               bonus += v;
239           }
240       }
241       pi->ksStormValue[Us] += bonus;
242
243       // Queenside pawn storms
244       bonus = QStormTable[relative_square(Us, s)];
245       if (f <= FILE_C)
246       {
247           Bitboard b = outpost_mask(Us, s) & theirPawns & (FileABB | FileBBB | FileCBB);
248           while (b)
249           {
250               // Give a bonus according to the distance of the nearest enemy pawn
251               Square s2 = pop_1st_bit(&b);
252               int v = StormLeverBonus[f] - 4 * square_distance(s, s2);
253
254               // If enemy pawn has no pawn beside itself is particularly vulnerable.
255               // Big bonus, especially against a weakness on the rook file
256               if (!(theirPawns & neighboring_files_bb(s2) & rank_bb(s2)))
257                   v *= (square_file(s2) == FILE_A ? 4 : 2);
258
259               bonus += v;
260           }
261       }
262       pi->qsStormValue[Us] += bonus;
263
264       // Member of a pawn chain (but not the backward one)? We could speed up
265       // the test a little by introducing an array of masks indexed by color
266       // and square for doing the test, but because everything is hashed,
267       // it probably won't make any noticable difference.
268       chain =  ourPawns
269              & neighboring_files_bb(f)
270              & (rank_bb(r) | rank_bb(r - (Us == WHITE ? 1 : -1)));
271
272       // Test for backward pawn
273       //
274       // If the pawn is passed, isolated, or member of a pawn chain
275       // it cannot be backward. If can capture an enemy pawn or if
276       // there are friendly pawns behind on neighboring files it cannot
277       // be backward either.
278       if (   (passed | isolated | chain)
279           || (ourPawns & behind_bb(Us, r) & neighboring_files_bb(f))
280           || (pos.attacks_from<PAWN>(s, Us) & theirPawns))
281           backward = false;
282       else
283       {
284           // We now know that there are no friendly pawns beside or behind this
285           // pawn on neighboring files. We now check whether the pawn is
286           // backward by looking in the forward direction on the neighboring
287           // files, and seeing whether we meet a friendly or an enemy pawn first.
288           Bitboard b = pos.attacks_from<PAWN>(s, Us);
289
290           // Note that we are sure to find something because pawn is not passed
291           // nor isolated, so loop is potentially infinite, but it isn't.
292           while (!(b & (ourPawns | theirPawns)))
293               Us == WHITE ? b <<= 8 : b >>= 8;
294
295           // The friendly pawn needs to be at least two ranks closer than the enemy
296           // pawn in order to help the potentially backward pawn advance.
297           backward = (b | (Us == WHITE ? b << 8 : b >> 8)) & theirPawns;
298       }
299
300       // Test for candidate passed pawn
301       candidate =   !passed
302                  && !(theirPawns & file_bb(f))
303                  && (  count_1s_max_15(neighboring_files_bb(f) & (behind_bb(Us, r) | rank_bb(r)) & ourPawns)
304                      - count_1s_max_15(neighboring_files_bb(f) & in_front_bb(Us, r)              & theirPawns)
305                      >= 0);
306
307       // In order to prevent doubled passed pawns from receiving a too big
308       // bonus, only the frontmost passed pawn on each file is considered as
309       // a true passed pawn.
310       if (passed && (ourPawns & squares_in_front_of(Us, s)))
311           passed = false;
312
313       // Score this pawn
314       if (passed)
315           set_bit(&(pi->passedPawns), s);
316
317       if (isolated)
318       {
319           value -= IsolatedPawnPenalty[f];
320           if (!(theirPawns & file_bb(f)))
321               value -= IsolatedPawnPenalty[f] / 2;
322       }
323       if (doubled)
324           value -= DoubledPawnPenalty[f];
325
326       if (backward)
327       {
328           value -= BackwardPawnPenalty[f];
329           if (!(theirPawns & file_bb(f)))
330               value -= BackwardPawnPenalty[f] / 2;
331       }
332       if (chain)
333           value += ChainBonus[f];
334
335       if (candidate)
336           value += CandidateBonus[relative_rank(Us, s)];
337   }
338
339   return value;
340 }
341
342
343 /// PawnInfo::updateShelter calculates and caches king shelter. It is called
344 /// only when king square changes, about 20% of total get_king_shelter() calls.
345 int PawnInfo::updateShelter(const Position& pos, Color c, Square ksq) {
346
347   unsigned shelter = 0;
348   Bitboard pawns = pos.pieces(PAWN, c) & this_and_neighboring_files_bb(ksq);
349   unsigned r = ksq & (7 << 3);
350   for (int i = 1, k = (c ? -8 : 8); i < 4; i++)
351   {
352       r += k;
353       shelter += BitCount8Bit[(pawns >> r) & 0xFF] * (128 >> i);
354   }
355   kingSquares[c] = ksq;
356   kingShelters[c] = shelter;
357   return shelter;
358 }