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    pawnKey;
  44   Key    materialKey;
  45   Value  nonPawnMaterial[COLOR_NB];
  46   int    castlingRights;
  47   int    rule50;
  48   int    pliesFromNull;
  49   Square epSquare;
  50
  51   // Not copied when making a move (will be recomputed anyhow)
  52   Key        key;
  53   Bitboard   checkersBB;
  54   StateInfo* previous;
  55   Bitboard   blockersForKing[COLOR_NB];
  56   Bitboard   pinners[COLOR_NB];
  57   Bitboard   checkSquares[PIECE_TYPE_NB];
  58   Piece      capturedPiece;
  59   int        repetition;
  60
  61   // Used by NNUE
  62   Eval::NNUE::Accumulator accumulator;
  63   DirtyPiece dirtyPiece;
  64 };
  65
  66
  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>>;
  72
  73
  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.
  78 class Thread;
  79
  80 class Position {
  81 public:
  82   static void init();
  83
  84   Position() = default;
  85   Position(const Position&) = delete;
  86   Position& operator=(const Position&) = delete;
  87
  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;
  92
  93   // Position representation
  94   Bitboard pieces(PieceType pt) const;
  95   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  96   Bitboard pieces(Color c) const;
  97   Bitboard pieces(Color c, PieceType pt) const;
  98   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  99   Piece piece_on(Square s) const;
 100   Square ep_square() const;
 101   bool empty(Square s) const;
 102   template<PieceType Pt> int count(Color c) const;
 103   template<PieceType Pt> int count() const;
 104   template<PieceType Pt> Square square(Color c) const;
 105   bool is_on_semiopen_file(Color c, Square s) const;
 106
 107   // Castling
 108   CastlingRights castling_rights(Color c) const;
 109   bool can_castle(CastlingRights cr) const;
 110   bool castling_impeded(CastlingRights cr) const;
 111   Square castling_rook_square(CastlingRights cr) const;
 112
 113   // Checking
 114   Bitboard checkers() const;
 115   Bitboard blockers_for_king(Color c) const;
 116   Bitboard check_squares(PieceType pt) const;
 117   Bitboard pinners(Color c) const;
 118
 119   // Attacks to/from a given square
 120   Bitboard attackers_to(Square s) const;
 121   Bitboard attackers_to(Square s, Bitboard occupied) const;
 122   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 123   template<PieceType Pt> Bitboard attacks_by(Color c) const;
 124
 125   // Properties of moves
 126   bool legal(Move m) const;
 127   bool pseudo_legal(const 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;
 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 psq_eg_stm() const;
 165   Value non_pawn_material(Color c) const;
 166   Value non_pawn_material() const;
 167
 168   // Position consistency check, for debugging
 169   bool pos_is_ok() const;
 170   void flip();
 171
 172   // Used by NNUE
 173   StateInfo* state() const;
 174
 175   void put_piece(Piece pc, Square s);
 176   void remove_piece(Square s);
 177
 178 private:
 179   // Initialization helpers (used while setting up a position)
 180   void set_castling_right(Color c, Square rfrom);
 181   void set_state(StateInfo* si) const;
 182   void set_check_info(StateInfo* si) const;
 183
 184   // Other helpers
 185   void move_piece(Square from, Square to);
 186   template<bool Do>
 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;
 190
 191   // Data members
 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];
 199   Thread* thisThread;
 200   StateInfo* st;
 201   int gamePly;
 202   Color sideToMove;
 203   Score psq;
 204   bool chess960;
 205 };
 206
 207 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 template<PieceType Pt>
 292 inline Bitboard Position::attacks_by(Color c) const {
 293
 294   if constexpr (Pt == PAWN)
 295       return c == WHITE ? pawn_attacks_bb<WHITE>(pieces(WHITE, PAWN))
 296                         : pawn_attacks_bb<BLACK>(pieces(BLACK, PAWN));
 297   else
 298   {
 299       Bitboard threats = 0;
 300       Bitboard attackers = pieces(c, Pt);
 301       while (attackers)
 302           threats |= attacks_bb<Pt>(pop_lsb(attackers), pieces());
 303       return threats;
 304   }
 305 }
 306
 307 inline Bitboard Position::checkers() const {
 308   return st->checkersBB;
 309 }
 310
 311 inline Bitboard Position::blockers_for_king(Color c) const {
 312   return st->blockersForKing[c];
 313 }
 314
 315 inline Bitboard Position::pinners(Color c) const {
 316   return st->pinners[c];
 317 }
 318
 319 inline Bitboard Position::check_squares(PieceType pt) const {
 320   return st->checkSquares[pt];
 321 }
 322
 323 inline bool Position::pawn_passed(Color c, Square s) const {
 324   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 325 }
 326
 327 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 328   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 329 }
 330
 331 inline Key Position::key() const {
 332   return adjust_key50<false>(st->key);
 333 }
 334
 335 template<bool AfterMove>
 336 inline Key Position::adjust_key50(Key k) const
 337 {
 338   return st->rule50 < 14 - AfterMove
 339       ? k : k ^ make_key((st->rule50 - (14 - AfterMove)) / 8);
 340 }
 341
 342 inline Key Position::pawn_key() const {
 343   return st->pawnKey;
 344 }
 345
 346 inline Key Position::material_key() const {
 347   return st->materialKey;
 348 }
 349
 350 inline Score Position::psq_score() const {
 351   return psq;
 352 }
 353
 354 inline Value Position::psq_eg_stm() const {
 355   return (sideToMove == WHITE ? 1 : -1) * eg_value(psq);
 356 }
 357
 358 inline Value Position::non_pawn_material(Color c) const {
 359   return st->nonPawnMaterial[c];
 360 }
 361
 362 inline Value Position::non_pawn_material() const {
 363   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 364 }
 365
 366 inline int Position::game_ply() const {
 367   return gamePly;
 368 }
 369
 370 inline int Position::rule50_count() const {
 371   return st->rule50;
 372 }
 373
 374 inline bool Position::opposite_bishops() const {
 375   return   count<BISHOP>(WHITE) == 1
 376         && count<BISHOP>(BLACK) == 1
 377         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 378 }
 379
 380 inline bool Position::is_chess960() const {
 381   return chess960;
 382 }
 383
 384 // returns true if a move is generated from the capture stage
 385 // having also queen promotions covered, i.e. consistency with the capture stage move generation
 386 // is needed to avoid the generation of duplicate moves.
 387 inline bool Position::capture_stage(Move m) const {
 388   assert(is_ok(m));
 389   return     (!empty(to_sq(m)) && type_of(m) != CASTLING)
 390           || (type_of(m) == PROMOTION && promotion_type(m) == QUEEN)
 391           ||  type_of(m) == EN_PASSANT;
 392 }
 393
 394 inline Piece Position::captured_piece() const {
 395   return st->capturedPiece;
 396 }
 397
 398 inline Thread* Position::this_thread() const {
 399   return thisThread;
 400 }
 401
 402 inline void Position::put_piece(Piece pc, Square s) {
 403
 404   board[s] = pc;
 405   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 406   byColorBB[color_of(pc)] |= s;
 407   pieceCount[pc]++;
 408   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 409   psq += PSQT::psq[pc][s];
 410 }
 411
 412 inline void Position::remove_piece(Square s) {
 413
 414   Piece pc = board[s];
 415   byTypeBB[ALL_PIECES] ^= s;
 416   byTypeBB[type_of(pc)] ^= s;
 417   byColorBB[color_of(pc)] ^= s;
 418   board[s] = NO_PIECE;
 419   pieceCount[pc]--;
 420   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 421   psq -= PSQT::psq[pc][s];
 422 }
 423
 424 inline void Position::move_piece(Square from, Square to) {
 425
 426   Piece pc = board[from];
 427   Bitboard fromTo = from | to;
 428   byTypeBB[ALL_PIECES] ^= fromTo;
 429   byTypeBB[type_of(pc)] ^= fromTo;
 430   byColorBB[color_of(pc)] ^= fromTo;
 431   board[from] = NO_PIECE;
 432   board[to] = pc;
 433   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 434 }
 435
 436 inline void Position::do_move(Move m, StateInfo& newSt) {
 437   do_move(m, newSt, gives_check(m));
 438 }
 439
 440 inline StateInfo* Position::state() const {
 441
 442   return st;
 443 }
 444
 445 } // namespace Stockfish
 446
 447 #endif // #ifndef POSITION_H_INCLUDED