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 <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 namespace Stockfish {
  34
  35 /// StateInfo struct stores information needed to restore a Position object to
  36 /// its previous state when we retract a move. Whenever a move is made on the
  37 /// board (by calling Position::do_move), a StateInfo object must be passed.
  38
  39 struct StateInfo {
  40
  41   // Copied when making a move
  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   StateInfo* previous;
  53   Bitboard   blockersForKing[COLOR_NB];
  54   Bitboard   pinners[COLOR_NB];
  55   Bitboard   checkSquares[PIECE_TYPE_NB];
  56   Piece      capturedPiece;
  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 using StateListPtr = std::unique_ptr<std::deque<StateInfo>>;
  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   std::string fen() const;
  90
  91   // Position representation
  92   Bitboard pieces(PieceType pt = ALL_PIECES) const;
  93   template<typename ...PieceTypes> Bitboard pieces(PieceType pt, PieceTypes... pts) const;
  94   Bitboard pieces(Color c) const;
  95   template<typename ...PieceTypes> Bitboard pieces(Color c, PieceTypes... pts) const;
  96   Piece piece_on(Square s) const;
  97   Square ep_square() const;
  98   bool empty(Square s) const;
  99   template<PieceType Pt> int count(Color c) const;
 100   template<PieceType Pt> int count() const;
 101   template<PieceType Pt> Square square(Color c) const;
 102
 103   // Castling
 104   CastlingRights castling_rights(Color c) const;
 105   bool can_castle(CastlingRights cr) const;
 106   bool castling_impeded(CastlingRights cr) const;
 107   Square castling_rook_square(CastlingRights cr) const;
 108
 109   // Checking
 110   Bitboard checkers() const;
 111   Bitboard blockers_for_king(Color c) const;
 112   Bitboard check_squares(PieceType pt) const;
 113   Bitboard pinners(Color c) const;
 114
 115   // Attacks to/from a given square
 116   Bitboard attackers_to(Square s) const;
 117   Bitboard attackers_to(Square s, Bitboard occupied) const;
 118   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 119   template<PieceType Pt> Bitboard attacks_by(Color c) const;
 120
 121   // Properties of moves
 122   bool legal(Move m) const;
 123   bool pseudo_legal(const Move m) const;
 124   bool capture(Move m) const;
 125   bool capture_stage(Move m) const;
 126   bool gives_check(Move m) const;
 127   Piece moved_piece(Move m) const;
 128   Piece captured_piece() const;
 129
 130   // Doing and undoing moves
 131   void do_move(Move m, StateInfo& newSt);
 132   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 133   void undo_move(Move m);
 134   void do_null_move(StateInfo& newSt);
 135   void undo_null_move();
 136
 137   // Static Exchange Evaluation
 138   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 139   bool see_ge(Move m, Bitboard& occupied, Value threshold = VALUE_ZERO) const;
 140
 141   // Accessing hash keys
 142   Key key() const;
 143   Key key_after(Move m) const;
 144   Key material_key() const;
 145
 146   // Other properties of the position
 147   Color side_to_move() const;
 148   int game_ply() const;
 149   bool is_chess960() const;
 150   Thread* this_thread() const;
 151   bool is_draw(int ply) const;
 152   bool has_game_cycle(int ply) const;
 153   bool has_repeated() const;
 154   int rule50_count() const;
 155   Value non_pawn_material(Color c) const;
 156   Value non_pawn_material() const;
 157
 158   // Position consistency check, for debugging
 159   bool pos_is_ok() const;
 160   void flip();
 161
 162   // Used by NNUE
 163   StateInfo* state() const;
 164
 165   void put_piece(Piece pc, Square s);
 166   void remove_piece(Square s);
 167
 168 private:
 169   // Initialization helpers (used while setting up a position)
 170   void set_castling_right(Color c, Square rfrom);
 171   void set_state() const;
 172   void set_check_info() const;
 173
 174   // Other helpers
 175   void move_piece(Square from, Square to);
 176   template<bool Do>
 177   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 178   template<bool AfterMove>
 179   Key adjust_key50(Key k) const;
 180
 181   // Data members
 182   Piece board[SQUARE_NB];
 183   Bitboard byTypeBB[PIECE_TYPE_NB];
 184   Bitboard byColorBB[COLOR_NB];
 185   int pieceCount[PIECE_NB];
 186   int castlingRightsMask[SQUARE_NB];
 187   Square castlingRookSquare[CASTLING_RIGHT_NB];
 188   Bitboard castlingPath[CASTLING_RIGHT_NB];
 189   Thread* thisThread;
 190   StateInfo* st;
 191   int gamePly;
 192   Color sideToMove;
 193   bool chess960;
 194 };
 195
 196 std::ostream& operator<<(std::ostream& os, const Position& pos);
 197
 198 inline Color Position::side_to_move() const {
 199   return sideToMove;
 200 }
 201
 202 inline Piece Position::piece_on(Square s) const {
 203   assert(is_ok(s));
 204   return board[s];
 205 }
 206
 207 inline bool Position::empty(Square s) const {
 208   return piece_on(s) == NO_PIECE;
 209 }
 210
 211 inline Piece Position::moved_piece(Move m) const {
 212   return piece_on(from_sq(m));
 213 }
 214
 215 inline Bitboard Position::pieces(PieceType pt) const {
 216   return byTypeBB[pt];
 217 }
 218
 219 template<typename ...PieceTypes>
 220 inline Bitboard Position::pieces(PieceType pt, PieceTypes... pts) const {
 221   return pieces(pt) | pieces(pts...);
 222 }
 223
 224 inline Bitboard Position::pieces(Color c) const {
 225   return byColorBB[c];
 226 }
 227
 228 template<typename ...PieceTypes>
 229 inline Bitboard Position::pieces(Color c, PieceTypes... pts) const {
 230   return pieces(c) & pieces(pts...);
 231 }
 232
 233 template<PieceType Pt> inline int Position::count(Color c) const {
 234   return pieceCount[make_piece(c, Pt)];
 235 }
 236
 237 template<PieceType Pt> inline int Position::count() const {
 238   return count<Pt>(WHITE) + count<Pt>(BLACK);
 239 }
 240
 241 template<PieceType Pt> inline Square Position::square(Color c) const {
 242   assert(count<Pt>(c) == 1);
 243   return lsb(pieces(c, Pt));
 244 }
 245
 246 inline Square Position::ep_square() const {
 247   return st->epSquare;
 248 }
 249
 250 inline bool Position::can_castle(CastlingRights cr) const {
 251   return st->castlingRights & cr;
 252 }
 253
 254 inline CastlingRights Position::castling_rights(Color c) const {
 255   return c & CastlingRights(st->castlingRights);
 256 }
 257
 258 inline bool Position::castling_impeded(CastlingRights cr) const {
 259   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 260
 261   return pieces() & castlingPath[cr];
 262 }
 263
 264 inline Square Position::castling_rook_square(CastlingRights cr) const {
 265   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 266
 267   return castlingRookSquare[cr];
 268 }
 269
 270 inline Bitboard Position::attackers_to(Square s) const {
 271   return attackers_to(s, pieces());
 272 }
 273
 274 template<PieceType Pt>
 275 inline Bitboard Position::attacks_by(Color c) const {
 276
 277   if constexpr (Pt == PAWN)
 278       return c == WHITE ? pawn_attacks_bb<WHITE>(pieces(WHITE, PAWN))
 279                         : pawn_attacks_bb<BLACK>(pieces(BLACK, PAWN));
 280   else
 281   {
 282       Bitboard threats = 0;
 283       Bitboard attackers = pieces(c, Pt);
 284       while (attackers)
 285           threats |= attacks_bb<Pt>(pop_lsb(attackers), pieces());
 286       return threats;
 287   }
 288 }
 289
 290 inline Bitboard Position::checkers() const {
 291   return st->checkersBB;
 292 }
 293
 294 inline Bitboard Position::blockers_for_king(Color c) const {
 295   return st->blockersForKing[c];
 296 }
 297
 298 inline Bitboard Position::pinners(Color c) const {
 299   return st->pinners[c];
 300 }
 301
 302 inline Bitboard Position::check_squares(PieceType pt) const {
 303   return st->checkSquares[pt];
 304 }
 305
 306 inline Key Position::key() const {
 307   return adjust_key50<false>(st->key);
 308 }
 309
 310 template<bool AfterMove>
 311 inline Key Position::adjust_key50(Key k) const
 312 {
 313   return st->rule50 < 14 - AfterMove
 314       ? k : k ^ make_key((st->rule50 - (14 - AfterMove)) / 8);
 315 }
 316
 317 inline Key Position::material_key() const {
 318   return st->materialKey;
 319 }
 320
 321 inline Value Position::non_pawn_material(Color c) const {
 322   return st->nonPawnMaterial[c];
 323 }
 324
 325 inline Value Position::non_pawn_material() const {
 326   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 327 }
 328
 329 inline int Position::game_ply() const {
 330   return gamePly;
 331 }
 332
 333 inline int Position::rule50_count() const {
 334   return st->rule50;
 335 }
 336
 337 inline bool Position::is_chess960() const {
 338   return chess960;
 339 }
 340
 341 inline bool Position::capture(Move m) const {
 342   assert(is_ok(m));
 343   return     (!empty(to_sq(m)) && type_of(m) != CASTLING)
 344           ||  type_of(m) == EN_PASSANT;
 345 }
 346
 347 // returns true if a move is generated from the capture stage
 348 // having also queen promotions covered, i.e. consistency with the capture stage move generation
 349 // is needed to avoid the generation of duplicate moves.
 350 inline bool Position::capture_stage(Move m) const {
 351   assert(is_ok(m));
 352   return  capture(m) || promotion_type(m) == QUEEN;
 353 }
 354
 355 inline Piece Position::captured_piece() const {
 356   return st->capturedPiece;
 357 }
 358
 359 inline Thread* Position::this_thread() const {
 360   return thisThread;
 361 }
 362
 363 inline void Position::put_piece(Piece pc, Square s) {
 364
 365   board[s] = pc;
 366   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 367   byColorBB[color_of(pc)] |= s;
 368   pieceCount[pc]++;
 369   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 370 }
 371
 372 inline void Position::remove_piece(Square s) {
 373
 374   Piece pc = board[s];
 375   byTypeBB[ALL_PIECES] ^= s;
 376   byTypeBB[type_of(pc)] ^= s;
 377   byColorBB[color_of(pc)] ^= s;
 378   board[s] = NO_PIECE;
 379   pieceCount[pc]--;
 380   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 381 }
 382
 383 inline void Position::move_piece(Square from, Square to) {
 384
 385   Piece pc = board[from];
 386   Bitboard fromTo = from | to;
 387   byTypeBB[ALL_PIECES] ^= fromTo;
 388   byTypeBB[type_of(pc)] ^= fromTo;
 389   byColorBB[color_of(pc)] ^= fromTo;
 390   board[from] = NO_PIECE;
 391   board[to] = pc;
 392 }
 393
 394 inline void Position::do_move(Move m, StateInfo& newSt) {
 395   do_move(m, newSt, gives_check(m));
 396 }
 397
 398 inline StateInfo* Position::state() const {
 399
 400   return st;
 401 }
 402
 403 } // namespace Stockfish
 404
 405 #endif // #ifndef POSITION_H_INCLUDED