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-2020 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
  34 /// StateInfo struct stores information needed to restore a Position object to
  35 /// its previous state when we retract a move. Whenever a move is made on the
  36 /// board (by calling Position::do_move), a StateInfo object must be passed.
  37
  38 struct StateInfo {
  39
  40   // Copied when making a move
  41   Key    pawnKey;
  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   Piece      capturedPiece;
  53   StateInfo* previous;
  54   Bitboard   blockersForKing[COLOR_NB];
  55   Bitboard   pinners[COLOR_NB];
  56   Bitboard   checkSquares[PIECE_TYPE_NB];
  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 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
  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   const std::string fen() const;
  90
  91   // Position representation
  92   Bitboard pieces(PieceType pt) const;
  93   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  94   Bitboard pieces(Color c) const;
  95   Bitboard pieces(Color c, PieceType pt) const;
  96   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) 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> const Square* squares(Color c) const;
 103   template<PieceType Pt> Square square(Color c) const;
 104   bool is_on_semiopen_file(Color c, Square s) const;
 105
 106   // Castling
 107   CastlingRights castling_rights(Color c) const;
 108   bool can_castle(CastlingRights cr) const;
 109   bool castling_impeded(CastlingRights cr) const;
 110   Square castling_rook_square(CastlingRights cr) const;
 111
 112   // Checking
 113   Bitboard checkers() const;
 114   Bitboard blockers_for_king(Color c) const;
 115   Bitboard check_squares(PieceType pt) const;
 116   Bitboard pinners(Color c) const;
 117   bool is_discovery_check_on_king(Color c, Move m) 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
 124   // Properties of moves
 125   bool legal(Move m) const;
 126   bool pseudo_legal(const Move m) const;
 127   bool capture(Move m) const;
 128   bool capture_or_promotion(Move m) const;
 129   bool gives_check(Move m) const;
 130   bool advanced_pawn_push(Move m) const;
 131   Piece moved_piece(Move m) const;
 132   Piece captured_piece() const;
 133
 134   // Piece specific
 135   bool pawn_passed(Color c, Square s) const;
 136   bool opposite_bishops() const;
 137   int  pawns_on_same_color_squares(Color c, Square s) const;
 138
 139   // Doing and undoing moves
 140   void do_move(Move m, StateInfo& newSt);
 141   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 142   void undo_move(Move m);
 143   void do_null_move(StateInfo& newSt);
 144   void undo_null_move();
 145
 146   // Static Exchange Evaluation
 147   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 148
 149   // Accessing hash keys
 150   Key key() const;
 151   Key key_after(Move m) const;
 152   Key material_key() const;
 153   Key pawn_key() const;
 154
 155   // Other properties of the position
 156   Color side_to_move() const;
 157   int game_ply() const;
 158   bool is_chess960() const;
 159   Thread* this_thread() const;
 160   bool is_draw(int ply) const;
 161   bool has_game_cycle(int ply) const;
 162   bool has_repeated() const;
 163   int rule50_count() const;
 164   Score psq_score() 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   const EvalList* eval_list() 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   // ID of a piece on a given square
 190   PieceId piece_id_on(Square sq) const;
 191
 192   // Data members
 193   Piece board[SQUARE_NB];
 194   Bitboard byTypeBB[PIECE_TYPE_NB];
 195   Bitboard byColorBB[COLOR_NB];
 196   int pieceCount[PIECE_NB];
 197   Square pieceList[PIECE_NB][16];
 198   int index[SQUARE_NB];
 199   int castlingRightsMask[SQUARE_NB];
 200   Square castlingRookSquare[CASTLING_RIGHT_NB];
 201   Bitboard castlingPath[CASTLING_RIGHT_NB];
 202   int gamePly;
 203   Color sideToMove;
 204   Score psq;
 205   Thread* thisThread;
 206   StateInfo* st;
 207   bool chess960;
 208
 209   // List of pieces used in NNUE evaluation function
 210   EvalList evalList;
 211 };
 212
 213 namespace PSQT {
 214   extern Score psq[PIECE_NB][SQUARE_NB];
 215 }
 216
 217 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
 218
 219 inline Color Position::side_to_move() const {
 220   return sideToMove;
 221 }
 222
 223 inline Piece Position::piece_on(Square s) const {
 224   assert(is_ok(s));
 225   return board[s];
 226 }
 227
 228 inline bool Position::empty(Square s) const {
 229   return piece_on(s) == NO_PIECE;
 230 }
 231
 232 inline Piece Position::moved_piece(Move m) const {
 233   return piece_on(from_sq(m));
 234 }
 235
 236 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
 237   return byTypeBB[pt];
 238 }
 239
 240 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 241   return pieces(pt1) | pieces(pt2);
 242 }
 243
 244 inline Bitboard Position::pieces(Color c) const {
 245   return byColorBB[c];
 246 }
 247
 248 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 249   return pieces(c) & pieces(pt);
 250 }
 251
 252 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 253   return pieces(c) & (pieces(pt1) | pieces(pt2));
 254 }
 255
 256 template<PieceType Pt> inline int Position::count(Color c) const {
 257   return pieceCount[make_piece(c, Pt)];
 258 }
 259
 260 template<PieceType Pt> inline int Position::count() const {
 261   return count<Pt>(WHITE) + count<Pt>(BLACK);
 262 }
 263
 264 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
 265   return pieceList[make_piece(c, Pt)];
 266 }
 267
 268 template<PieceType Pt> inline Square Position::square(Color c) const {
 269   assert(pieceCount[make_piece(c, Pt)] == 1);
 270   return squares<Pt>(c)[0];
 271 }
 272
 273 inline Square Position::ep_square() const {
 274   return st->epSquare;
 275 }
 276
 277 inline bool Position::is_on_semiopen_file(Color c, Square s) const {
 278   return !(pieces(c, PAWN) & file_bb(s));
 279 }
 280
 281 inline bool Position::can_castle(CastlingRights cr) const {
 282   return st->castlingRights & cr;
 283 }
 284
 285 inline CastlingRights Position::castling_rights(Color c) const {
 286   return c & CastlingRights(st->castlingRights);
 287 }
 288
 289 inline bool Position::castling_impeded(CastlingRights cr) const {
 290   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 291
 292   return pieces() & castlingPath[cr];
 293 }
 294
 295 inline Square Position::castling_rook_square(CastlingRights cr) const {
 296   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 297
 298   return castlingRookSquare[cr];
 299 }
 300
 301 inline Bitboard Position::attackers_to(Square s) const {
 302   return attackers_to(s, pieces());
 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::is_discovery_check_on_king(Color c, Move m) const {
 322   return st->blockersForKing[c] & from_sq(m);
 323 }
 324
 325 inline bool Position::pawn_passed(Color c, Square s) const {
 326   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 327 }
 328
 329 inline bool Position::advanced_pawn_push(Move m) const {
 330   return   type_of(moved_piece(m)) == PAWN
 331         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
 332 }
 333
 334 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 335   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 336 }
 337
 338 inline Key Position::key() const {
 339   return st->key;
 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::non_pawn_material(Color c) const {
 355   return st->nonPawnMaterial[c];
 356 }
 357
 358 inline Value Position::non_pawn_material() const {
 359   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 360 }
 361
 362 inline int Position::game_ply() const {
 363   return gamePly;
 364 }
 365
 366 inline int Position::rule50_count() const {
 367   return st->rule50;
 368 }
 369
 370 inline bool Position::opposite_bishops() const {
 371   return   count<BISHOP>(WHITE) == 1
 372         && count<BISHOP>(BLACK) == 1
 373         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 374 }
 375
 376 inline bool Position::is_chess960() const {
 377   return chess960;
 378 }
 379
 380 inline bool Position::capture_or_promotion(Move m) const {
 381   assert(is_ok(m));
 382   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 383 }
 384
 385 inline bool Position::capture(Move m) const {
 386   assert(is_ok(m));
 387   // Castling is encoded as "king captures rook"
 388   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 389 }
 390
 391 inline Piece Position::captured_piece() const {
 392   return st->capturedPiece;
 393 }
 394
 395 inline Thread* Position::this_thread() const {
 396   return thisThread;
 397 }
 398
 399 inline void Position::put_piece(Piece pc, Square s) {
 400
 401   board[s] = pc;
 402   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 403   byColorBB[color_of(pc)] |= s;
 404   index[s] = pieceCount[pc]++;
 405   pieceList[pc][index[s]] = s;
 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   // WARNING: This is not a reversible operation. If we remove a piece in
 413   // do_move() and then replace it in undo_move() we will put it at the end of
 414   // the list and not in its original place, it means index[] and pieceList[]
 415   // are not invariant to a do_move() + undo_move() sequence.
 416   Piece pc = board[s];
 417   byTypeBB[ALL_PIECES] ^= s;
 418   byTypeBB[type_of(pc)] ^= s;
 419   byColorBB[color_of(pc)] ^= s;
 420   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 421   Square lastSquare = pieceList[pc][--pieceCount[pc]];
 422   index[lastSquare] = index[s];
 423   pieceList[pc][index[lastSquare]] = lastSquare;
 424   pieceList[pc][pieceCount[pc]] = SQ_NONE;
 425   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 426   psq -= PSQT::psq[pc][s];
 427 }
 428
 429 inline void Position::move_piece(Square from, Square to) {
 430
 431   // index[from] is not updated and becomes stale. This works as long as index[]
 432   // is accessed just by known occupied squares.
 433   Piece pc = board[from];
 434   Bitboard fromTo = from | to;
 435   byTypeBB[ALL_PIECES] ^= fromTo;
 436   byTypeBB[type_of(pc)] ^= fromTo;
 437   byColorBB[color_of(pc)] ^= fromTo;
 438   board[from] = NO_PIECE;
 439   board[to] = pc;
 440   index[to] = index[from];
 441   pieceList[pc][index[to]] = to;
 442   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 443 }
 444
 445 inline void Position::do_move(Move m, StateInfo& newSt) {
 446   do_move(m, newSt, gives_check(m));
 447 }
 448
 449 inline StateInfo* Position::state() const {
 450
 451   return st;
 452 }
 453
 454 inline const EvalList* Position::eval_list() const {
 455
 456   return &evalList;
 457 }
 458
 459 inline PieceId Position::piece_id_on(Square sq) const
 460 {
 461
 462   assert(piece_on(sq) != NO_PIECE);
 463
 464   PieceId pid = evalList.piece_id_list[sq];
 465   assert(is_ok(pid));
 466
 467   return pid;
 468 }
 469
 470 #endif // #ifndef POSITION_H_INCLUDED