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