Assorted code style and comments in pawns.cpp and pawns.h
[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 #include <cassert>
21
22 #include "bitboard.h"
23 #include "bitcount.h"
24 #include "pawns.h"
25 #include "position.h"
26
27 namespace {
28
29   #define S(mg, eg) make_score(mg, eg)
30
31   // Doubled pawn penalty by opposed flag and file
32   const Score DoubledPawnPenalty[2][8] = {
33   { S(13, 43), S(20, 48), S(23, 48), S(23, 48),
34     S(23, 48), S(23, 48), S(20, 48), S(13, 43) },
35   { S(13, 43), S(20, 48), S(23, 48), S(23, 48),
36     S(23, 48), S(23, 48), S(20, 48), S(13, 43) }};
37
38   // Isolated pawn penalty by opposed flag and file
39   const Score IsolatedPawnPenalty[2][8] = {
40   { S(37, 45), S(54, 52), S(60, 52), S(60, 52),
41     S(60, 52), S(60, 52), S(54, 52), S(37, 45) },
42   { S(25, 30), S(36, 35), S(40, 35), S(40, 35),
43     S(40, 35), S(40, 35), S(36, 35), S(25, 30) }};
44
45   // Backward pawn penalty by opposed flag and file
46   const Score BackwardPawnPenalty[2][8] = {
47   { S(30, 42), S(43, 46), S(49, 46), S(49, 46),
48     S(49, 46), S(49, 46), S(43, 46), S(30, 42) },
49   { S(20, 28), S(29, 31), S(33, 31), S(33, 31),
50     S(33, 31), S(33, 31), S(29, 31), S(20, 28) }};
51
52   // Pawn chain membership bonus by file
53   const Score ChainBonus[8] = {
54     S(11,-1), S(13,-1), S(13,-1), S(14,-1),
55     S(14,-1), S(13,-1), S(13,-1), S(11,-1)
56   };
57
58   // Candidate passed pawn bonus by rank
59   const Score CandidateBonus[8] = {
60     S( 0, 0), S( 6, 13), S(6,13), S(14,29),
61     S(34,68), S(83,166), S(0, 0), S( 0, 0)
62   };
63
64   #undef S
65 }
66
67
68 /// PawnInfoTable::get_pawn_info() takes a position object as input, computes
69 /// a PawnInfo object, and returns a pointer to it. The result is also stored
70 /// in an hash table, so we don't have to recompute everything when the same
71 /// pawn structure occurs again.
72
73 PawnInfo* PawnInfoTable::get_pawn_info(const Position& pos) const {
74
75   assert(pos.is_ok());
76
77   Key key = pos.get_pawn_key();
78   PawnInfo* pi = find(key);
79
80   // If pi->key matches the position's pawn hash key, it means that we
81   // have analysed this pawn structure before, and we can simply return
82   // the information we found the last time instead of recomputing it.
83   if (pi->key == key)
84       return pi;
85
86   // Initialize PawnInfo entry
87   pi->key = key;
88   pi->passedPawns[WHITE] = pi->passedPawns[BLACK] = 0;
89   pi->kingSquares[WHITE] = pi->kingSquares[BLACK] = SQ_NONE;
90   pi->halfOpenFiles[WHITE] = pi->halfOpenFiles[BLACK] = 0xFF;
91
92   // Calculate pawn attacks
93   Bitboard wPawns = pos.pieces(PAWN, WHITE);
94   Bitboard bPawns = pos.pieces(PAWN, BLACK);
95   pi->pawnAttacks[WHITE] = ((wPawns << 9) & ~FileABB) | ((wPawns << 7) & ~FileHBB);
96   pi->pawnAttacks[BLACK] = ((bPawns >> 7) & ~FileABB) | ((bPawns >> 9) & ~FileHBB);
97
98   // Evaluate pawns for both colors
99   pi->value =  evaluate_pawns<WHITE>(pos, wPawns, bPawns, pi)
100              - evaluate_pawns<BLACK>(pos, bPawns, wPawns, pi);
101   return pi;
102 }
103
104
105 /// PawnInfoTable::evaluate_pawns() evaluates each pawn of the given color
106
107 template<Color Us>
108 Score PawnInfoTable::evaluate_pawns(const Position& pos, Bitboard ourPawns,
109                                     Bitboard theirPawns, PawnInfo* pi) const {
110
111   const BitCountType Max15 = CpuIs64Bit ? CNT64_MAX15 : CNT32_MAX15;
112   const Color Them = (Us == WHITE ? BLACK : WHITE);
113
114   Bitboard b;
115   Square s;
116   File f;
117   Rank r;
118   bool passed, isolated, doubled, opposed, chain, backward, candidate;
119   Score value = SCORE_ZERO;
120   const Square* ptr = pos.piece_list_begin(Us, PAWN);
121
122   // Loop through all pawns of the current color and score each pawn
123   while ((s = *ptr++) != SQ_NONE)
124   {
125       assert(pos.piece_on(s) == make_piece(Us, PAWN));
126
127       f = square_file(s);
128       r = square_rank(s);
129
130       // This file cannot be half open
131       pi->halfOpenFiles[Us] &= ~(1 << f);
132
133       // Our rank plus previous one. Used for chain detection
134       b = rank_bb(r) | rank_bb(Us == WHITE ? r - Rank(1) : r + Rank(1));
135
136       // Flag the pawn as passed, isolated, doubled or member of a pawn
137       // chain (but not the backward one).
138       passed   = !(theirPawns & passed_pawn_mask(Us, s));
139       doubled  =   ourPawns   & squares_in_front_of(Us, s);
140       opposed  =   theirPawns & squares_in_front_of(Us, s);
141       isolated = !(ourPawns   & neighboring_files_bb(f));
142       chain    =   ourPawns   & neighboring_files_bb(f) & b;
143
144       // Test for backward pawn
145       backward = false;
146
147       // If the pawn is passed, isolated, or member of a pawn chain it cannot
148       // be backward. If there are friendly pawns behind on neighboring files
149       // or if can capture an enemy pawn it cannot be backward either.
150       if (   !(passed | isolated | chain)
151           && !(ourPawns & attack_span_mask(Them, s))
152           && !(pos.attacks_from<PAWN>(s, Us) & theirPawns))
153       {
154           // We now know that there are no friendly pawns beside or behind this
155           // pawn on neighboring files. We now check whether the pawn is
156           // backward by looking in the forward direction on the neighboring
157           // files, and seeing whether we meet a friendly or an enemy pawn first.
158           b = pos.attacks_from<PAWN>(s, Us);
159
160           // Note that we are sure to find something because pawn is not passed
161           // nor isolated, so loop is potentially infinite, but it isn't.
162           while (!(b & (ourPawns | theirPawns)))
163               Us == WHITE ? b <<= 8 : b >>= 8;
164
165           // The friendly pawn needs to be at least two ranks closer than the
166           // enemy pawn in order to help the potentially backward pawn advance.
167           backward = (b | (Us == WHITE ? b << 8 : b >> 8)) & theirPawns;
168       }
169
170       assert(opposed | passed | (attack_span_mask(Us, s) & theirPawns));
171
172       // A not passed pawn is a candidate to become passed if it is free to
173       // advance and if the number of friendly pawns beside or behind this
174       // pawn on neighboring files is higher or equal than the number of
175       // enemy pawns in the forward direction on the neighboring files.
176       candidate =   !(opposed | passed | backward | isolated)
177                  && (b = attack_span_mask(Them, s + pawn_push(Us)) & ourPawns) != EmptyBoardBB
178                  &&  count_1s<Max15>(b) >= count_1s<Max15>(attack_span_mask(Us, s) & theirPawns);
179
180       // Passed pawns will be properly scored in evaluation because we need
181       // full attack info to evaluate passed pawns. Only the frontmost passed
182       // pawn on each file is considered a true passed pawn.
183       if (passed && !doubled)
184           set_bit(&(pi->passedPawns[Us]), s);
185
186       // Score this pawn
187       if (isolated)
188           value -= IsolatedPawnPenalty[opposed][f];
189
190       if (doubled)
191           value -= DoubledPawnPenalty[opposed][f];
192
193       if (backward)
194           value -= BackwardPawnPenalty[opposed][f];
195
196       if (chain)
197           value += ChainBonus[f];
198
199       if (candidate)
200           value += CandidateBonus[relative_rank(Us, s)];
201   }
202   return value;
203 }
204
205
206 /// PawnInfo::updateShelter() calculates and caches king shelter. It is called
207 /// only when king square changes, about 20% of total king_shelter() calls.
208 template<Color Us>
209 Score PawnInfo::updateShelter(const Position& pos, Square ksq) {
210
211   const int Shift = (Us == WHITE ? 8 : -8);
212
213   Bitboard pawns;
214   int r, shelter = 0;
215
216   if (relative_rank(Us, ksq) <= RANK_4)
217   {
218       pawns = pos.pieces(PAWN, Us) & this_and_neighboring_files_bb(ksq);
219       r = ksq & (7 << 3);
220       for (int i = 0; i < 3; i++)
221       {
222           r += Shift;
223           shelter += BitCount8Bit[(pawns >> r) & 0xFF] * (64 >> i);
224       }
225   }
226   kingSquares[Us] = ksq;
227   kingShelters[Us] = make_score(shelter, 0);
228   return kingShelters[Us];
229 }
230
231 // Explicit template instantiation
232 template Score PawnInfo::updateShelter<WHITE>(const Position& pos, Square ksq);
233 template Score PawnInfo::updateShelter<BLACK>(const Position& pos, Square ksq);