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-2021 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   Piece      capturedPiece;
  55   StateInfo* previous;
  56   Bitboard   blockersForKing[COLOR_NB];
  57   Bitboard   pinners[COLOR_NB];
  58   Bitboard   checkSquares[PIECE_TYPE_NB];
  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 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
  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   bool is_discovered_check_on_king(Color c, Move m) const;
 119
 120   // Attacks to/from a given square
 121   Bitboard attackers_to(Square s) const;
 122   Bitboard attackers_to(Square s, Bitboard occupied) const;
 123   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 124
 125   // Properties of moves
 126   bool legal(Move m) const;
 127   bool pseudo_legal(const Move m) const;
 128   bool capture(Move m) const;
 129   bool capture_or_promotion(Move m) const;
 130   bool gives_check(Move m) const;
 131   bool advanced_pawn_push(Move m) const;
 132   Piece moved_piece(Move m) const;
 133   Piece captured_piece() const;
 134
 135   // Piece specific
 136   bool pawn_passed(Color c, Square s) const;
 137   bool opposite_bishops() const;
 138   int  pawns_on_same_color_squares(Color c, Square s) const;
 139
 140   // Doing and undoing moves
 141   void do_move(Move m, StateInfo& newSt);
 142   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 143   void undo_move(Move m);
 144   void do_null_move(StateInfo& newSt);
 145   void undo_null_move();
 146
 147   // Static Exchange Evaluation
 148   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 149
 150   // Accessing hash keys
 151   Key key() const;
 152   Key key_after(Move m) const;
 153   Key material_key() const;
 154   Key pawn_key() const;
 155
 156   // Other properties of the position
 157   Color side_to_move() const;
 158   int game_ply() const;
 159   bool is_chess960() const;
 160   Thread* this_thread() const;
 161   bool is_draw(int ply) const;
 162   bool has_game_cycle(int ply) const;
 163   bool has_repeated() const;
 164   int rule50_count() const;
 165   Score psq_score() const;
 166   Value non_pawn_material(Color c) const;
 167   Value non_pawn_material() const;
 168
 169   // Position consistency check, for debugging
 170   bool pos_is_ok() const;
 171   void flip();
 172
 173   // Used by NNUE
 174   StateInfo* state() const;
 175
 176 private:
 177   // Initialization helpers (used while setting up a position)
 178   void set_castling_right(Color c, Square rfrom);
 179   void set_state(StateInfo* si) const;
 180   void set_check_info(StateInfo* si) const;
 181
 182   // Other helpers
 183   void put_piece(Piece pc, Square s);
 184   void remove_piece(Square s);
 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
 189   // Data members
 190   Piece board[SQUARE_NB];
 191   Bitboard byTypeBB[PIECE_TYPE_NB];
 192   Bitboard byColorBB[COLOR_NB];
 193   int pieceCount[PIECE_NB];
 194   int castlingRightsMask[SQUARE_NB];
 195   Square castlingRookSquare[CASTLING_RIGHT_NB];
 196   Bitboard castlingPath[CASTLING_RIGHT_NB];
 197   int gamePly;
 198   Color sideToMove;
 199   Score psq;
 200   Thread* thisThread;
 201   StateInfo* st;
 202   bool chess960;
 203 };
 204
 205 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
 206
 207 inline Color Position::side_to_move() const {
 208   return sideToMove;
 209 }
 210
 211 inline Piece Position::piece_on(Square s) const {
 212   assert(is_ok(s));
 213   return board[s];
 214 }
 215
 216 inline bool Position::empty(Square s) const {
 217   return piece_on(s) == NO_PIECE;
 218 }
 219
 220 inline Piece Position::moved_piece(Move m) const {
 221   return piece_on(from_sq(m));
 222 }
 223
 224 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
 225   return byTypeBB[pt];
 226 }
 227
 228 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 229   return pieces(pt1) | pieces(pt2);
 230 }
 231
 232 inline Bitboard Position::pieces(Color c) const {
 233   return byColorBB[c];
 234 }
 235
 236 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 237   return pieces(c) & pieces(pt);
 238 }
 239
 240 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 241   return pieces(c) & (pieces(pt1) | pieces(pt2));
 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 inline Bitboard Position::checkers() const {
 290   return st->checkersBB;
 291 }
 292
 293 inline Bitboard Position::blockers_for_king(Color c) const {
 294   return st->blockersForKing[c];
 295 }
 296
 297 inline Bitboard Position::pinners(Color c) const {
 298   return st->pinners[c];
 299 }
 300
 301 inline Bitboard Position::check_squares(PieceType pt) const {
 302   return st->checkSquares[pt];
 303 }
 304
 305 inline bool Position::is_discovered_check_on_king(Color c, Move m) const {
 306   return st->blockersForKing[c] & from_sq(m);
 307 }
 308
 309 inline bool Position::pawn_passed(Color c, Square s) const {
 310   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 311 }
 312
 313 inline bool Position::advanced_pawn_push(Move m) const {
 314   return   type_of(moved_piece(m)) == PAWN
 315         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
 316 }
 317
 318 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 319   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 320 }
 321
 322 inline Key Position::key() const {
 323   return st->rule50 < 14 ? st->key
 324                          : st->key ^ make_key((st->rule50 - 14) / 8);
 325 }
 326
 327 inline Key Position::pawn_key() const {
 328   return st->pawnKey;
 329 }
 330
 331 inline Key Position::material_key() const {
 332   return st->materialKey;
 333 }
 334
 335 inline Score Position::psq_score() const {
 336   return psq;
 337 }
 338
 339 inline Value Position::non_pawn_material(Color c) const {
 340   return st->nonPawnMaterial[c];
 341 }
 342
 343 inline Value Position::non_pawn_material() const {
 344   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 345 }
 346
 347 inline int Position::game_ply() const {
 348   return gamePly;
 349 }
 350
 351 inline int Position::rule50_count() const {
 352   return st->rule50;
 353 }
 354
 355 inline bool Position::opposite_bishops() const {
 356   return   count<BISHOP>(WHITE) == 1
 357         && count<BISHOP>(BLACK) == 1
 358         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 359 }
 360
 361 inline bool Position::is_chess960() const {
 362   return chess960;
 363 }
 364
 365 inline bool Position::capture_or_promotion(Move m) const {
 366   assert(is_ok(m));
 367   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 368 }
 369
 370 inline bool Position::capture(Move m) const {
 371   assert(is_ok(m));
 372   // Castling is encoded as "king captures rook"
 373   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == EN_PASSANT;
 374 }
 375
 376 inline Piece Position::captured_piece() const {
 377   return st->capturedPiece;
 378 }
 379
 380 inline Thread* Position::this_thread() const {
 381   return thisThread;
 382 }
 383
 384 inline void Position::put_piece(Piece pc, Square s) {
 385
 386   board[s] = pc;
 387   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 388   byColorBB[color_of(pc)] |= s;
 389   pieceCount[pc]++;
 390   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 391   psq += PSQT::psq[pc][s];
 392 }
 393
 394 inline void Position::remove_piece(Square s) {
 395
 396   Piece pc = board[s];
 397   byTypeBB[ALL_PIECES] ^= s;
 398   byTypeBB[type_of(pc)] ^= s;
 399   byColorBB[color_of(pc)] ^= s;
 400   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 401   pieceCount[pc]--;
 402   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 403   psq -= PSQT::psq[pc][s];
 404 }
 405
 406 inline void Position::move_piece(Square from, Square to) {
 407
 408   Piece pc = board[from];
 409   Bitboard fromTo = from | to;
 410   byTypeBB[ALL_PIECES] ^= fromTo;
 411   byTypeBB[type_of(pc)] ^= fromTo;
 412   byColorBB[color_of(pc)] ^= fromTo;
 413   board[from] = NO_PIECE;
 414   board[to] = pc;
 415   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 416 }
 417
 418 inline void Position::do_move(Move m, StateInfo& newSt) {
 419   do_move(m, newSt, gives_check(m));
 420 }
 421
 422 inline StateInfo* Position::state() const {
 423
 424   return st;
 425 }
 426
 427 } // namespace Stockfish
 428
 429 #endif // #ifndef POSITION_H_INCLUDED