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   bool is_on_semiopen_file(Color c, Square s) const;
 104
 105   // Castling
 106   CastlingRights castling_rights(Color c) const;
 107   bool can_castle(CastlingRights cr) const;
 108   bool castling_impeded(CastlingRights cr) const;
 109   Square castling_rook_square(CastlingRights cr) const;
 110
 111   // Checking
 112   Bitboard checkers() const;
 113   Bitboard blockers_for_king(Color c) const;
 114   Bitboard check_squares(PieceType pt) const;
 115   Bitboard pinners(Color c) const;
 116
 117   // Attacks to/from a given square
 118   Bitboard attackers_to(Square s) const;
 119   Bitboard attackers_to(Square s, Bitboard occupied) const;
 120   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 121   template<PieceType Pt> Bitboard attacks_by(Color c) const;
 122
 123   // Properties of moves
 124   bool legal(Move m) const;
 125   bool pseudo_legal(const Move m) const;
 126   bool capture(Move m) const;
 127   bool capture_stage(Move m) const;
 128   bool gives_check(Move m) const;
 129   Piece moved_piece(Move m) const;
 130   Piece captured_piece() const;
 131
 132   // Piece specific
 133   bool pawn_passed(Color c, Square s) const;
 134   bool opposite_bishops() const;
 135   int  pawns_on_same_color_squares(Color c, Square s) const;
 136
 137   // Doing and undoing moves
 138   void do_move(Move m, StateInfo& newSt);
 139   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 140   void undo_move(Move m);
 141   void do_null_move(StateInfo& newSt);
 142   void undo_null_move();
 143
 144   // Static Exchange Evaluation
 145   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 146   bool see_ge(Move m, Bitboard& occupied, 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() const;
 182   void set_check_info() 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) const {
 227   return byTypeBB[pt];
 228 }
 229
 230 template<typename ...PieceTypes>
 231 inline Bitboard Position::pieces(PieceType pt, PieceTypes... pts) const {
 232   return pieces(pt) | pieces(pts...);
 233 }
 234
 235 inline Bitboard Position::pieces(Color c) const {
 236   return byColorBB[c];
 237 }
 238
 239 template<typename ...PieceTypes>
 240 inline Bitboard Position::pieces(Color c, PieceTypes... pts) const {
 241   return pieces(c) & pieces(pts...);
 242 }
 243
 244 template<PieceType Pt> inline int Position::count(Color c) const {
 245   return pieceCount[make_piece(c, Pt)];
 246 }
 247
 248 template<PieceType Pt> inline int Position::count() const {
 249   return count<Pt>(WHITE) + count<Pt>(BLACK);
 250 }
 251
 252 template<PieceType Pt> inline Square Position::square(Color c) const {
 253   assert(count<Pt>(c) == 1);
 254   return lsb(pieces(c, Pt));
 255 }
 256
 257 inline Square Position::ep_square() const {
 258   return st->epSquare;
 259 }
 260
 261 inline bool Position::is_on_semiopen_file(Color c, Square s) const {
 262   return !(pieces(c, PAWN) & file_bb(s));
 263 }
 264
 265 inline bool Position::can_castle(CastlingRights cr) const {
 266   return st->castlingRights & cr;
 267 }
 268
 269 inline CastlingRights Position::castling_rights(Color c) const {
 270   return c & CastlingRights(st->castlingRights);
 271 }
 272
 273 inline bool Position::castling_impeded(CastlingRights cr) const {
 274   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 275
 276   return pieces() & castlingPath[cr];
 277 }
 278
 279 inline Square Position::castling_rook_square(CastlingRights cr) const {
 280   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 281
 282   return castlingRookSquare[cr];
 283 }
 284
 285 inline Bitboard Position::attackers_to(Square s) const {
 286   return attackers_to(s, pieces());
 287 }
 288
 289 template<PieceType Pt>
 290 inline Bitboard Position::attacks_by(Color c) const {
 291
 292   if constexpr (Pt == PAWN)
 293       return c == WHITE ? pawn_attacks_bb<WHITE>(pieces(WHITE, PAWN))
 294                         : pawn_attacks_bb<BLACK>(pieces(BLACK, PAWN));
 295   else
 296   {
 297       Bitboard threats = 0;
 298       Bitboard attackers = pieces(c, Pt);
 299       while (attackers)
 300           threats |= attacks_bb<Pt>(pop_lsb(attackers), pieces());
 301       return threats;
 302   }
 303 }
 304
 305 inline Bitboard Position::checkers() const {
 306   return st->checkersBB;
 307 }
 308
 309 inline Bitboard Position::blockers_for_king(Color c) const {
 310   return st->blockersForKing[c];
 311 }
 312
 313 inline Bitboard Position::pinners(Color c) const {
 314   return st->pinners[c];
 315 }
 316
 317 inline Bitboard Position::check_squares(PieceType pt) const {
 318   return st->checkSquares[pt];
 319 }
 320
 321 inline bool Position::pawn_passed(Color c, Square s) const {
 322   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 323 }
 324
 325 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 326   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 327 }
 328
 329 inline Key Position::key() const {
 330   return adjust_key50<false>(st->key);
 331 }
 332
 333 template<bool AfterMove>
 334 inline Key Position::adjust_key50(Key k) const
 335 {
 336   return st->rule50 < 14 - AfterMove
 337       ? k : k ^ make_key((st->rule50 - (14 - AfterMove)) / 8);
 338 }
 339
 340 inline Key Position::material_key() const {
 341   return st->materialKey;
 342 }
 343
 344 inline Score Position::psq_score() const {
 345   return psq;
 346 }
 347
 348 inline Value Position::psq_eg_stm() const {
 349   return (sideToMove == WHITE ? 1 : -1) * eg_value(psq);
 350 }
 351
 352 inline Value Position::non_pawn_material(Color c) const {
 353   return st->nonPawnMaterial[c];
 354 }
 355
 356 inline Value Position::non_pawn_material() const {
 357   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 358 }
 359
 360 inline int Position::game_ply() const {
 361   return gamePly;
 362 }
 363
 364 inline int Position::rule50_count() const {
 365   return st->rule50;
 366 }
 367
 368 inline bool Position::opposite_bishops() const {
 369   return   count<BISHOP>(WHITE) == 1
 370         && count<BISHOP>(BLACK) == 1
 371         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 372 }
 373
 374 inline bool Position::is_chess960() const {
 375   return chess960;
 376 }
 377
 378 inline bool Position::capture(Move m) const {
 379   assert(is_ok(m));
 380   return     (!empty(to_sq(m)) && type_of(m) != CASTLING)
 381           ||  type_of(m) == EN_PASSANT;
 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  capture(m) || promotion_type(m) == QUEEN;
 390 }
 391
 392 inline Piece Position::captured_piece() const {
 393   return st->capturedPiece;
 394 }
 395
 396 inline Thread* Position::this_thread() const {
 397   return thisThread;
 398 }
 399
 400 inline void Position::put_piece(Piece pc, Square s) {
 401
 402   board[s] = pc;
 403   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 404   byColorBB[color_of(pc)] |= s;
 405   pieceCount[pc]++;
 406   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 407   psq += PSQT::psq[pc][s];
 408 }
 409
 410 inline void Position::remove_piece(Square s) {
 411
 412   Piece pc = board[s];
 413   byTypeBB[ALL_PIECES] ^= s;
 414   byTypeBB[type_of(pc)] ^= s;
 415   byColorBB[color_of(pc)] ^= s;
 416   board[s] = NO_PIECE;
 417   pieceCount[pc]--;
 418   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 419   psq -= PSQT::psq[pc][s];
 420 }
 421
 422 inline void Position::move_piece(Square from, Square to) {
 423
 424   Piece pc = board[from];
 425   Bitboard fromTo = from | to;
 426   byTypeBB[ALL_PIECES] ^= fromTo;
 427   byTypeBB[type_of(pc)] ^= fromTo;
 428   byColorBB[color_of(pc)] ^= fromTo;
 429   board[from] = NO_PIECE;
 430   board[to] = pc;
 431   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 432 }
 433
 434 inline void Position::do_move(Move m, StateInfo& newSt) {
 435   do_move(m, newSt, gives_check(m));
 436 }
 437
 438 inline StateInfo* Position::state() const {
 439
 440   return st;
 441 }
 442
 443 } // namespace Stockfish
 444
 445 #endif // #ifndef POSITION_H_INCLUDED