Improve play for closed positions
[stockfish] / src / position.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2021 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #ifndef POSITION_H_INCLUDED
20 #define POSITION_H_INCLUDED
21
22 #include <cassert>
23 #include <deque>
24 #include <memory> // For std::unique_ptr
25 #include <string>
26
27 #include "bitboard.h"
28 #include "evaluate.h"
29 #include "types.h"
30
31 #include "nnue/nnue_accumulator.h"
32
33
34 /// StateInfo struct stores information needed to restore a Position object to
35 /// its previous state when we retract a move. Whenever a move is made on the
36 /// board (by calling Position::do_move), a StateInfo object must be passed.
37
38 struct StateInfo {
39
40   // Copied when making a move
41   Key    pawnKey;
42   Key    materialKey;
43   Value  nonPawnMaterial[COLOR_NB];
44   int    castlingRights;
45   int    rule50;
46   int    pliesFromNull;
47   Square epSquare;
48
49   // Not copied when making a move (will be recomputed anyhow)
50   Key        key;
51   Bitboard   checkersBB;
52   Piece      capturedPiece;
53   StateInfo* previous;
54   Bitboard   blockersForKing[COLOR_NB];
55   Bitboard   pinners[COLOR_NB];
56   Bitboard   checkSquares[PIECE_TYPE_NB];
57   int        repetition;
58
59   // Used by NNUE
60   Eval::NNUE::Accumulator accumulator;
61   DirtyPiece dirtyPiece;
62 };
63
64
65 /// A list to keep track of the position states along the setup moves (from the
66 /// start position to the position just before the search starts). Needed by
67 /// 'draw by repetition' detection. Use a std::deque because pointers to
68 /// elements are not invalidated upon list resizing.
69 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
70
71
72 /// Position class stores information regarding the board representation as
73 /// pieces, side to move, hash keys, castling info, etc. Important methods are
74 /// do_move() and undo_move(), used by the search to update node info when
75 /// traversing the search tree.
76 class Thread;
77
78 class Position {
79 public:
80   static void init();
81
82   Position() = default;
83   Position(const Position&) = delete;
84   Position& operator=(const Position&) = delete;
85
86   // FEN string input/output
87   Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
88   Position& set(const std::string& code, Color c, StateInfo* si);
89   const std::string fen() const;
90
91   // Position representation
92   Bitboard pieces(PieceType pt) const;
93   Bitboard pieces(PieceType pt1, PieceType pt2) const;
94   Bitboard pieces(Color c) const;
95   Bitboard pieces(Color c, PieceType pt) const;
96   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
97   Piece piece_on(Square s) const;
98   Square ep_square() const;
99   bool empty(Square s) const;
100   template<PieceType Pt> int count(Color c) const;
101   template<PieceType Pt> int count() const;
102   template<PieceType Pt> Square square(Color c) const;
103   bool is_on_semiopen_file(Color c, Square s) const;
104
105   // Castling
106   CastlingRights castling_rights(Color c) const;
107   bool can_castle(CastlingRights cr) const;
108   bool castling_impeded(CastlingRights cr) const;
109   Square castling_rook_square(CastlingRights cr) const;
110
111   // Checking
112   Bitboard checkers() const;
113   Bitboard blockers_for_king(Color c) const;
114   Bitboard check_squares(PieceType pt) const;
115   Bitboard pinners(Color c) const;
116   bool is_discovered_check_on_king(Color c, Move m) const;
117
118   // Attacks to/from a given square
119   Bitboard attackers_to(Square s) const;
120   Bitboard attackers_to(Square s, Bitboard occupied) const;
121   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
122
123   // Properties of moves
124   bool legal(Move m) const;
125   bool pseudo_legal(const Move m) const;
126   bool capture(Move m) const;
127   bool capture_or_promotion(Move m) const;
128   bool gives_check(Move m) const;
129   bool advanced_pawn_push(Move m) const;
130   Piece moved_piece(Move m) const;
131   Piece captured_piece() const;
132
133   // Piece specific
134   bool pawn_passed(Color c, Square s) const;
135   bool opposite_bishops() const;
136   int  pawns_on_same_color_squares(Color c, Square s) const;
137
138   // Doing and undoing moves
139   void do_move(Move m, StateInfo& newSt);
140   void do_move(Move m, StateInfo& newSt, bool givesCheck);
141   void undo_move(Move m);
142   void do_null_move(StateInfo& newSt);
143   void undo_null_move();
144
145   // Static Exchange Evaluation
146   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
147
148   // Accessing hash keys
149   Key key() const;
150   Key key_after(Move m) const;
151   Key material_key() const;
152   Key pawn_key() const;
153
154   // Other properties of the position
155   Color side_to_move() const;
156   int game_ply() const;
157   bool is_chess960() const;
158   Thread* this_thread() const;
159   bool is_draw(int ply) const;
160   bool has_game_cycle(int ply) const;
161   bool has_repeated() const;
162   int rule50_count() const;
163   Score psq_score() const;
164   Value non_pawn_material(Color c) const;
165   Value non_pawn_material() const;
166
167   // Position consistency check, for debugging
168   bool pos_is_ok() const;
169   void flip();
170
171   // Used by NNUE
172   StateInfo* state() const;
173
174 private:
175   // Initialization helpers (used while setting up a position)
176   void set_castling_right(Color c, Square rfrom);
177   void set_state(StateInfo* si) const;
178   void set_check_info(StateInfo* si) const;
179
180   // Other helpers
181   void put_piece(Piece pc, Square s);
182   void remove_piece(Square s);
183   void move_piece(Square from, Square to);
184   template<bool Do>
185   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
186
187   // Data members
188   Piece board[SQUARE_NB];
189   Bitboard byTypeBB[PIECE_TYPE_NB];
190   Bitboard byColorBB[COLOR_NB];
191   int pieceCount[PIECE_NB];
192   int castlingRightsMask[SQUARE_NB];
193   Square castlingRookSquare[CASTLING_RIGHT_NB];
194   Bitboard castlingPath[CASTLING_RIGHT_NB];
195   int gamePly;
196   Color sideToMove;
197   Score psq;
198   Thread* thisThread;
199   StateInfo* st;
200   bool chess960;
201 };
202
203 namespace PSQT {
204   extern Score psq[PIECE_NB][SQUARE_NB];
205 }
206
207 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
208
209 inline Color Position::side_to_move() const {
210   return sideToMove;
211 }
212
213 inline Piece Position::piece_on(Square s) const {
214   assert(is_ok(s));
215   return board[s];
216 }
217
218 inline bool Position::empty(Square s) const {
219   return piece_on(s) == NO_PIECE;
220 }
221
222 inline Piece Position::moved_piece(Move m) const {
223   return piece_on(from_sq(m));
224 }
225
226 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
227   return byTypeBB[pt];
228 }
229
230 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
231   return pieces(pt1) | pieces(pt2);
232 }
233
234 inline Bitboard Position::pieces(Color c) const {
235   return byColorBB[c];
236 }
237
238 inline Bitboard Position::pieces(Color c, PieceType pt) const {
239   return pieces(c) & pieces(pt);
240 }
241
242 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
243   return pieces(c) & (pieces(pt1) | pieces(pt2));
244 }
245
246 template<PieceType Pt> inline int Position::count(Color c) const {
247   return pieceCount[make_piece(c, Pt)];
248 }
249
250 template<PieceType Pt> inline int Position::count() const {
251   return count<Pt>(WHITE) + count<Pt>(BLACK);
252 }
253
254 template<PieceType Pt> inline Square Position::square(Color c) const {
255   assert(count<Pt>(c) == 1);
256   return lsb(pieces(c, Pt));
257 }
258
259 inline Square Position::ep_square() const {
260   return st->epSquare;
261 }
262
263 inline bool Position::is_on_semiopen_file(Color c, Square s) const {
264   return !(pieces(c, PAWN) & file_bb(s));
265 }
266
267 inline bool Position::can_castle(CastlingRights cr) const {
268   return st->castlingRights & cr;
269 }
270
271 inline CastlingRights Position::castling_rights(Color c) const {
272   return c & CastlingRights(st->castlingRights);
273 }
274
275 inline bool Position::castling_impeded(CastlingRights cr) const {
276   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
277
278   return pieces() & castlingPath[cr];
279 }
280
281 inline Square Position::castling_rook_square(CastlingRights cr) const {
282   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
283
284   return castlingRookSquare[cr];
285 }
286
287 inline Bitboard Position::attackers_to(Square s) const {
288   return attackers_to(s, pieces());
289 }
290
291 inline Bitboard Position::checkers() const {
292   return st->checkersBB;
293 }
294
295 inline Bitboard Position::blockers_for_king(Color c) const {
296   return st->blockersForKing[c];
297 }
298
299 inline Bitboard Position::pinners(Color c) const {
300   return st->pinners[c];
301 }
302
303 inline Bitboard Position::check_squares(PieceType pt) const {
304   return st->checkSquares[pt];
305 }
306
307 inline bool Position::is_discovered_check_on_king(Color c, Move m) const {
308   return st->blockersForKing[c] & from_sq(m);
309 }
310
311 inline bool Position::pawn_passed(Color c, Square s) const {
312   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
313 }
314
315 inline bool Position::advanced_pawn_push(Move m) const {
316   return   type_of(moved_piece(m)) == PAWN
317         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
318 }
319
320 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
321   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
322 }
323
324 inline Key Position::key() const {
325   return st->rule50 < 14 ? st->key
326                          : st->key ^ make_key((st->rule50 - 14) / 8);
327 }
328
329 inline Key Position::pawn_key() const {
330   return st->pawnKey;
331 }
332
333 inline Key Position::material_key() const {
334   return st->materialKey;
335 }
336
337 inline Score Position::psq_score() const {
338   return psq;
339 }
340
341 inline Value Position::non_pawn_material(Color c) const {
342   return st->nonPawnMaterial[c];
343 }
344
345 inline Value Position::non_pawn_material() const {
346   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
347 }
348
349 inline int Position::game_ply() const {
350   return gamePly;
351 }
352
353 inline int Position::rule50_count() const {
354   return st->rule50;
355 }
356
357 inline bool Position::opposite_bishops() const {
358   return   count<BISHOP>(WHITE) == 1
359         && count<BISHOP>(BLACK) == 1
360         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
361 }
362
363 inline bool Position::is_chess960() const {
364   return chess960;
365 }
366
367 inline bool Position::capture_or_promotion(Move m) const {
368   assert(is_ok(m));
369   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
370 }
371
372 inline bool Position::capture(Move m) const {
373   assert(is_ok(m));
374   // Castling is encoded as "king captures rook"
375   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == EN_PASSANT;
376 }
377
378 inline Piece Position::captured_piece() const {
379   return st->capturedPiece;
380 }
381
382 inline Thread* Position::this_thread() const {
383   return thisThread;
384 }
385
386 inline void Position::put_piece(Piece pc, Square s) {
387
388   board[s] = pc;
389   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
390   byColorBB[color_of(pc)] |= s;
391   pieceCount[pc]++;
392   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
393   psq += PSQT::psq[pc][s];
394 }
395
396 inline void Position::remove_piece(Square s) {
397
398   Piece pc = board[s];
399   byTypeBB[ALL_PIECES] ^= s;
400   byTypeBB[type_of(pc)] ^= s;
401   byColorBB[color_of(pc)] ^= s;
402   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
403   pieceCount[pc]--;
404   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
405   psq -= PSQT::psq[pc][s];
406 }
407
408 inline void Position::move_piece(Square from, Square to) {
409
410   Piece pc = board[from];
411   Bitboard fromTo = from | to;
412   byTypeBB[ALL_PIECES] ^= fromTo;
413   byTypeBB[type_of(pc)] ^= fromTo;
414   byColorBB[color_of(pc)] ^= fromTo;
415   board[from] = NO_PIECE;
416   board[to] = pc;
417   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
418 }
419
420 inline void Position::do_move(Move m, StateInfo& newSt) {
421   do_move(m, newSt, gives_check(m));
422 }
423
424 inline StateInfo* Position::state() const {
425
426   return st;
427 }
428
429 #endif // #ifndef POSITION_H_INCLUDED