git.sesse.net Git - stockfish/blob - src/position.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 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 <iosfwd>
  25 #include <memory>
  26 #include <string>
  27
  28 #include "bitboard.h"
  29 #include "nnue/nnue_accumulator.h"
  30 #include "types.h"
  31
  32 namespace Stockfish {
  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    materialKey;
  42   Value  nonPawnMaterial[COLOR_NB];
  43   int    castlingRights;
  44   int    rule50;
  45   int    pliesFromNull;
  46   Square epSquare;
  47
  48   // Not copied when making a move (will be recomputed anyhow)
  49   Key        key;
  50   Bitboard   checkersBB;
  51   StateInfo* previous;
  52   Bitboard   blockersForKing[COLOR_NB];
  53   Bitboard   pinners[COLOR_NB];
  54   Bitboard   checkSquares[PIECE_TYPE_NB];
  55   Piece      capturedPiece;
  56   int        repetition;
  57
  58   // Used by NNUE
  59   Eval::NNUE::Accumulator accumulator;
  60   DirtyPiece dirtyPiece;
  61 };
  62
  63
  64 // A list to keep track of the position states along the setup moves (from the
  65 // start position to the position just before the search starts). Needed by
  66 // 'draw by repetition' detection. Use a std::deque because pointers to
  67 // elements are not invalidated upon list resizing.
  68 using StateListPtr = std::unique_ptr<std::deque<StateInfo>>;
  69
  70
  71 // Position class stores information regarding the board representation as
  72 // pieces, side to move, hash keys, castling info, etc. Important methods are
  73 // do_move() and undo_move(), used by the search to update node info when
  74 // traversing the search tree.
  75 class Thread;
  76
  77 class Position {
  78 public:
  79   static void init();
  80
  81   Position() = default;
  82   Position(const Position&) = delete;
  83   Position& operator=(const Position&) = delete;
  84
  85   // FEN string input/output
  86   Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
  87   Position& set(const std::string& code, Color c, StateInfo* si);
  88   std::string fen() const;
  89
  90   // Position representation
  91   Bitboard pieces(PieceType pt = ALL_PIECES) const;
  92   template<typename ...PieceTypes> Bitboard pieces(PieceType pt, PieceTypes... pts) const;
  93   Bitboard pieces(Color c) const;
  94   template<typename ...PieceTypes> Bitboard pieces(Color c, PieceTypes... pts) const;
  95   Piece piece_on(Square s) const;
  96   Square ep_square() const;
  97   bool empty(Square s) const;
  98   template<PieceType Pt> int count(Color c) const;
  99   template<PieceType Pt> int count() const;
 100   template<PieceType Pt> Square square(Color c) const;
 101
 102   // Castling
 103   CastlingRights castling_rights(Color c) const;
 104   bool can_castle(CastlingRights cr) const;
 105   bool castling_impeded(CastlingRights cr) const;
 106   Square castling_rook_square(CastlingRights cr) const;
 107
 108   // Checking
 109   Bitboard checkers() const;
 110   Bitboard blockers_for_king(Color c) const;
 111   Bitboard check_squares(PieceType pt) const;
 112   Bitboard pinners(Color c) const;
 113
 114   // Attacks to/from a given square
 115   Bitboard attackers_to(Square s) const;
 116   Bitboard attackers_to(Square s, Bitboard occupied) const;
 117   void update_slider_blockers(Color c) const;
 118   template<PieceType Pt> Bitboard attacks_by(Color c) const;
 119
 120   // Properties of moves
 121   bool legal(Move m) const;
 122   bool pseudo_legal(const Move m) const;
 123   bool capture(Move m) const;
 124   bool capture_stage(Move m) const;
 125   bool gives_check(Move m) const;
 126   Piece moved_piece(Move m) const;
 127   Piece captured_piece() const;
 128
 129   // Doing and undoing moves
 130   void do_move(Move m, StateInfo& newSt);
 131   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 132   void undo_move(Move m);
 133   void do_null_move(StateInfo& newSt);
 134   void undo_null_move();
 135
 136   // Static Exchange Evaluation
 137   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 138
 139   // Accessing hash keys
 140   Key key() const;
 141   Key key_after(Move m) const;
 142   Key material_key() const;
 143
 144   // Other properties of the position
 145   Color side_to_move() const;
 146   int game_ply() const;
 147   bool is_chess960() const;
 148   Thread* this_thread() const;
 149   bool is_draw(int ply) const;
 150   bool has_game_cycle(int ply) const;
 151   bool has_repeated() const;
 152   int rule50_count() const;
 153   Value non_pawn_material(Color c) const;
 154   Value non_pawn_material() const;
 155
 156   // Position consistency check, for debugging
 157   bool pos_is_ok() const;
 158   void flip();
 159
 160   // Used by NNUE
 161   StateInfo* state() const;
 162
 163   void put_piece(Piece pc, Square s);
 164   void remove_piece(Square s);
 165
 166 private:
 167   // Initialization helpers (used while setting up a position)
 168   void set_castling_right(Color c, Square rfrom);
 169   void set_state() const;
 170   void set_check_info() const;
 171
 172   // Other helpers
 173   void move_piece(Square from, Square to);
 174   template<bool Do>
 175   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 176   template<bool AfterMove>
 177   Key adjust_key50(Key k) const;
 178
 179   // Data members
 180   Piece board[SQUARE_NB];
 181   Bitboard byTypeBB[PIECE_TYPE_NB];
 182   Bitboard byColorBB[COLOR_NB];
 183   int pieceCount[PIECE_NB];
 184   int castlingRightsMask[SQUARE_NB];
 185   Square castlingRookSquare[CASTLING_RIGHT_NB];
 186   Bitboard castlingPath[CASTLING_RIGHT_NB];
 187   Thread* thisThread;
 188   StateInfo* st;
 189   int gamePly;
 190   Color sideToMove;
 191   bool chess960;
 192 };
 193
 194 std::ostream& operator<<(std::ostream& os, const Position& pos);
 195
 196 inline Color Position::side_to_move() const {
 197   return sideToMove;
 198 }
 199
 200 inline Piece Position::piece_on(Square s) const {
 201   assert(is_ok(s));
 202   return board[s];
 203 }
 204
 205 inline bool Position::empty(Square s) const {
 206   return piece_on(s) == NO_PIECE;
 207 }
 208
 209 inline Piece Position::moved_piece(Move m) const {
 210   return piece_on(from_sq(m));
 211 }
 212
 213 inline Bitboard Position::pieces(PieceType pt) const {
 214   return byTypeBB[pt];
 215 }
 216
 217 template<typename ...PieceTypes>
 218 inline Bitboard Position::pieces(PieceType pt, PieceTypes... pts) const {
 219   return pieces(pt) | pieces(pts...);
 220 }
 221
 222 inline Bitboard Position::pieces(Color c) const {
 223   return byColorBB[c];
 224 }
 225
 226 template<typename ...PieceTypes>
 227 inline Bitboard Position::pieces(Color c, PieceTypes... pts) const {
 228   return pieces(c) & pieces(pts...);
 229 }
 230
 231 template<PieceType Pt> inline int Position::count(Color c) const {
 232   return pieceCount[make_piece(c, Pt)];
 233 }
 234
 235 template<PieceType Pt> inline int Position::count() const {
 236   return count<Pt>(WHITE) + count<Pt>(BLACK);
 237 }
 238
 239 template<PieceType Pt> inline Square Position::square(Color c) const {
 240   assert(count<Pt>(c) == 1);
 241   return lsb(pieces(c, Pt));
 242 }
 243
 244 inline Square Position::ep_square() const {
 245   return st->epSquare;
 246 }
 247
 248 inline bool Position::can_castle(CastlingRights cr) const {
 249   return st->castlingRights & cr;
 250 }
 251
 252 inline CastlingRights Position::castling_rights(Color c) const {
 253   return c & CastlingRights(st->castlingRights);
 254 }
 255
 256 inline bool Position::castling_impeded(CastlingRights cr) const {
 257   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 258
 259   return pieces() & castlingPath[cr];
 260 }
 261
 262 inline Square Position::castling_rook_square(CastlingRights cr) const {
 263   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 264
 265   return castlingRookSquare[cr];
 266 }
 267
 268 inline Bitboard Position::attackers_to(Square s) const {
 269   return attackers_to(s, pieces());
 270 }
 271
 272 template<PieceType Pt>
 273 inline Bitboard Position::attacks_by(Color c) const {
 274
 275   if constexpr (Pt == PAWN)
 276       return c == WHITE ? pawn_attacks_bb<WHITE>(pieces(WHITE, PAWN))
 277                         : pawn_attacks_bb<BLACK>(pieces(BLACK, PAWN));
 278   else
 279   {
 280       Bitboard threats = 0;
 281       Bitboard attackers = pieces(c, Pt);
 282       while (attackers)
 283           threats |= attacks_bb<Pt>(pop_lsb(attackers), pieces());
 284       return threats;
 285   }
 286 }
 287
 288 inline Bitboard Position::checkers() const {
 289   return st->checkersBB;
 290 }
 291
 292 inline Bitboard Position::blockers_for_king(Color c) const {
 293   return st->blockersForKing[c];
 294 }
 295
 296 inline Bitboard Position::pinners(Color c) const {
 297   return st->pinners[c];
 298 }
 299
 300 inline Bitboard Position::check_squares(PieceType pt) const {
 301   return st->checkSquares[pt];
 302 }
 303
 304 inline Key Position::key() const {
 305   return adjust_key50<false>(st->key);
 306 }
 307
 308 template<bool AfterMove>
 309 inline Key Position::adjust_key50(Key k) const
 310 {
 311   return st->rule50 < 14 - AfterMove
 312       ? k : k ^ make_key((st->rule50 - (14 - AfterMove)) / 8);
 313 }
 314
 315 inline Key Position::material_key() const {
 316   return st->materialKey;
 317 }
 318
 319 inline Value Position::non_pawn_material(Color c) const {
 320   return st->nonPawnMaterial[c];
 321 }
 322
 323 inline Value Position::non_pawn_material() const {
 324   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 325 }
 326
 327 inline int Position::game_ply() const {
 328   return gamePly;
 329 }
 330
 331 inline int Position::rule50_count() const {
 332   return st->rule50;
 333 }
 334
 335 inline bool Position::is_chess960() const {
 336   return chess960;
 337 }
 338
 339 inline bool Position::capture(Move m) const {
 340   assert(is_ok(m));
 341   return     (!empty(to_sq(m)) && type_of(m) != CASTLING)
 342           ||  type_of(m) == EN_PASSANT;
 343 }
 344
 345 // Returns true if a move is generated from the capture stage, having also
 346 // queen promotions covered, i.e. consistency with the capture stage move generation
 347 // is needed to avoid the generation of duplicate moves.
 348 inline bool Position::capture_stage(Move m) const {
 349   assert(is_ok(m));
 350   return  capture(m) || promotion_type(m) == QUEEN;
 351 }
 352
 353 inline Piece Position::captured_piece() const {
 354   return st->capturedPiece;
 355 }
 356
 357 inline Thread* Position::this_thread() const {
 358   return thisThread;
 359 }
 360
 361 inline void Position::put_piece(Piece pc, Square s) {
 362
 363   board[s] = pc;
 364   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 365   byColorBB[color_of(pc)] |= s;
 366   pieceCount[pc]++;
 367   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 368 }
 369
 370 inline void Position::remove_piece(Square s) {
 371
 372   Piece pc = board[s];
 373   byTypeBB[ALL_PIECES] ^= s;
 374   byTypeBB[type_of(pc)] ^= s;
 375   byColorBB[color_of(pc)] ^= s;
 376   board[s] = NO_PIECE;
 377   pieceCount[pc]--;
 378   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 379 }
 380
 381 inline void Position::move_piece(Square from, Square to) {
 382
 383   Piece pc = board[from];
 384   Bitboard fromTo = from | to;
 385   byTypeBB[ALL_PIECES] ^= fromTo;
 386   byTypeBB[type_of(pc)] ^= fromTo;
 387   byColorBB[color_of(pc)] ^= fromTo;
 388   board[from] = NO_PIECE;
 389   board[to] = pc;
 390 }
 391
 392 inline void Position::do_move(Move m, StateInfo& newSt) {
 393   do_move(m, newSt, gives_check(m));
 394 }
 395
 396 inline StateInfo* Position::state() const {
 397
 398   return st;
 399 }
 400
 401 } // namespace Stockfish
 402
 403 #endif // #ifndef POSITION_H_INCLUDED