2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
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.
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.
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/>.
19 #ifndef POSITION_H_INCLUDED
20 #define POSITION_H_INCLUDED
24 #include <memory> // For std::unique_ptr
32 #include "nnue/nnue_accumulator.h"
36 /// StateInfo struct stores information needed to restore a Position object to
37 /// its previous state when we retract a move. Whenever a move is made on the
38 /// board (by calling Position::do_move), a StateInfo object must be passed.
42 // Copied when making a move
45 Value nonPawnMaterial[COLOR_NB];
51 // Not copied when making a move (will be recomputed anyhow)
55 Bitboard blockersForKing[COLOR_NB];
56 Bitboard pinners[COLOR_NB];
57 Bitboard checkSquares[PIECE_TYPE_NB];
62 Eval::NNUE::Accumulator accumulator;
63 DirtyPiece dirtyPiece;
67 /// A list to keep track of the position states along the setup moves (from the
68 /// start position to the position just before the search starts). Needed by
69 /// 'draw by repetition' detection. Use a std::deque because pointers to
70 /// elements are not invalidated upon list resizing.
71 using StateListPtr = std::unique_ptr<std::deque<StateInfo>>;
74 /// Position class stores information regarding the board representation as
75 /// pieces, side to move, hash keys, castling info, etc. Important methods are
76 /// do_move() and undo_move(), used by the search to update node info when
77 /// traversing the search tree.
85 Position(const Position&) = delete;
86 Position& operator=(const Position&) = delete;
88 // FEN string input/output
89 Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
90 Position& set(const std::string& code, Color c, StateInfo* si);
91 std::string fen() const;
93 // Position representation
94 Bitboard pieces(PieceType pt) const;
95 template<typename ...PieceTypes> Bitboard pieces(PieceType pt, PieceTypes... pts) const;
96 Bitboard pieces(Color c) const;
97 template<typename ...PieceTypes> Bitboard pieces(Color c, PieceTypes... pts) const;
98 Piece piece_on(Square s) const;
99 Square ep_square() const;
100 bool empty(Square s) const;
101 template<PieceType Pt> int count(Color c) const;
102 template<PieceType Pt> int count() const;
103 template<PieceType Pt> Square square(Color c) const;
104 bool is_on_semiopen_file(Color c, Square s) const;
107 CastlingRights castling_rights(Color c) const;
108 bool can_castle(CastlingRights cr) const;
109 bool castling_impeded(CastlingRights cr) const;
110 Square castling_rook_square(CastlingRights cr) const;
113 Bitboard checkers() const;
114 Bitboard blockers_for_king(Color c) const;
115 Bitboard check_squares(PieceType pt) const;
116 Bitboard pinners(Color c) const;
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 template<PieceType Pt> Bitboard attacks_by(Color c) const;
124 // Properties of moves
125 bool legal(Move m) const;
126 bool pseudo_legal(const Move m) const;
127 bool capture(Move m) const;
128 bool capture_stage(Move m) const;
129 bool gives_check(Move m) const;
130 Piece moved_piece(Move m) const;
131 Piece captured_piece() const;
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;
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();
145 // Static Exchange Evaluation
146 bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
148 // Accessing hash keys
150 Key key_after(Move m) const;
151 Key material_key() const;
152 Key pawn_key() const;
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 psq_eg_stm() const;
165 Value non_pawn_material(Color c) const;
166 Value non_pawn_material() const;
168 // Position consistency check, for debugging
169 bool pos_is_ok() const;
173 StateInfo* state() const;
175 void put_piece(Piece pc, Square s);
176 void remove_piece(Square s);
179 // Initialization helpers (used while setting up a position)
180 void set_castling_right(Color c, Square rfrom);
181 void set_state() const;
182 void set_check_info() const;
185 void move_piece(Square from, Square to);
187 void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
188 template<bool AfterMove>
189 Key adjust_key50(Key k) const;
192 Piece board[SQUARE_NB];
193 Bitboard byTypeBB[PIECE_TYPE_NB];
194 Bitboard byColorBB[COLOR_NB];
195 int pieceCount[PIECE_NB];
196 int castlingRightsMask[SQUARE_NB];
197 Square castlingRookSquare[CASTLING_RIGHT_NB];
198 Bitboard castlingPath[CASTLING_RIGHT_NB];
207 std::ostream& operator<<(std::ostream& os, const Position& pos);
209 inline Color Position::side_to_move() const {
213 inline Piece Position::piece_on(Square s) const {
218 inline bool Position::empty(Square s) const {
219 return piece_on(s) == NO_PIECE;
222 inline Piece Position::moved_piece(Move m) const {
223 return piece_on(from_sq(m));
226 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
230 template<typename ...PieceTypes>
231 inline Bitboard Position::pieces(PieceType pt, PieceTypes... pts) const {
232 return pieces(pt) | pieces(pts...);
235 inline Bitboard Position::pieces(Color c) const {
239 template<typename ...PieceTypes>
240 inline Bitboard Position::pieces(Color c, PieceTypes... pts) const {
241 return pieces(c) & pieces(pts...);
244 template<PieceType Pt> inline int Position::count(Color c) const {
245 return pieceCount[make_piece(c, Pt)];
248 template<PieceType Pt> inline int Position::count() const {
249 return count<Pt>(WHITE) + count<Pt>(BLACK);
252 template<PieceType Pt> inline Square Position::square(Color c) const {
253 assert(count<Pt>(c) == 1);
254 return lsb(pieces(c, Pt));
257 inline Square Position::ep_square() const {
261 inline bool Position::is_on_semiopen_file(Color c, Square s) const {
262 return !(pieces(c, PAWN) & file_bb(s));
265 inline bool Position::can_castle(CastlingRights cr) const {
266 return st->castlingRights & cr;
269 inline CastlingRights Position::castling_rights(Color c) const {
270 return c & CastlingRights(st->castlingRights);
273 inline bool Position::castling_impeded(CastlingRights cr) const {
274 assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
276 return pieces() & castlingPath[cr];
279 inline Square Position::castling_rook_square(CastlingRights cr) const {
280 assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
282 return castlingRookSquare[cr];
285 inline Bitboard Position::attackers_to(Square s) const {
286 return attackers_to(s, pieces());
289 template<PieceType Pt>
290 inline Bitboard Position::attacks_by(Color c) const {
292 if constexpr (Pt == PAWN)
293 return c == WHITE ? pawn_attacks_bb<WHITE>(pieces(WHITE, PAWN))
294 : pawn_attacks_bb<BLACK>(pieces(BLACK, PAWN));
297 Bitboard threats = 0;
298 Bitboard attackers = pieces(c, Pt);
300 threats |= attacks_bb<Pt>(pop_lsb(attackers), pieces());
305 inline Bitboard Position::checkers() const {
306 return st->checkersBB;
309 inline Bitboard Position::blockers_for_king(Color c) const {
310 return st->blockersForKing[c];
313 inline Bitboard Position::pinners(Color c) const {
314 return st->pinners[c];
317 inline Bitboard Position::check_squares(PieceType pt) const {
318 return st->checkSquares[pt];
321 inline bool Position::pawn_passed(Color c, Square s) const {
322 return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
325 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
326 return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
329 inline Key Position::key() const {
330 return adjust_key50<false>(st->key);
333 template<bool AfterMove>
334 inline Key Position::adjust_key50(Key k) const
336 return st->rule50 < 14 - AfterMove
337 ? k : k ^ make_key((st->rule50 - (14 - AfterMove)) / 8);
340 inline Key Position::pawn_key() const {
344 inline Key Position::material_key() const {
345 return st->materialKey;
348 inline Score Position::psq_score() const {
352 inline Value Position::psq_eg_stm() const {
353 return (sideToMove == WHITE ? 1 : -1) * eg_value(psq);
356 inline Value Position::non_pawn_material(Color c) const {
357 return st->nonPawnMaterial[c];
360 inline Value Position::non_pawn_material() const {
361 return non_pawn_material(WHITE) + non_pawn_material(BLACK);
364 inline int Position::game_ply() const {
368 inline int Position::rule50_count() const {
372 inline bool Position::opposite_bishops() const {
373 return count<BISHOP>(WHITE) == 1
374 && count<BISHOP>(BLACK) == 1
375 && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
378 inline bool Position::is_chess960() const {
382 inline bool Position::capture(Move m) const {
384 return (!empty(to_sq(m)) && type_of(m) != CASTLING)
385 || type_of(m) == EN_PASSANT;
388 // returns true if a move is generated from the capture stage
389 // having also queen promotions covered, i.e. consistency with the capture stage move generation
390 // is needed to avoid the generation of duplicate moves.
391 inline bool Position::capture_stage(Move m) const {
393 return capture(m) || promotion_type(m) == QUEEN;
396 inline Piece Position::captured_piece() const {
397 return st->capturedPiece;
400 inline Thread* Position::this_thread() const {
404 inline void Position::put_piece(Piece pc, Square s) {
407 byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
408 byColorBB[color_of(pc)] |= s;
410 pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
411 psq += PSQT::psq[pc][s];
414 inline void Position::remove_piece(Square s) {
417 byTypeBB[ALL_PIECES] ^= s;
418 byTypeBB[type_of(pc)] ^= s;
419 byColorBB[color_of(pc)] ^= s;
422 pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
423 psq -= PSQT::psq[pc][s];
426 inline void Position::move_piece(Square from, Square to) {
428 Piece pc = board[from];
429 Bitboard fromTo = from | to;
430 byTypeBB[ALL_PIECES] ^= fromTo;
431 byTypeBB[type_of(pc)] ^= fromTo;
432 byColorBB[color_of(pc)] ^= fromTo;
433 board[from] = NO_PIECE;
435 psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
438 inline void Position::do_move(Move m, StateInfo& newSt) {
439 do_move(m, newSt, gives_check(m));
442 inline StateInfo* Position::state() const {
447 } // namespace Stockfish
449 #endif // #ifndef POSITION_H_INCLUDED