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   bool is_discovery_check_on_king(Color c, Move m) const;
 117
 118   // Attacks to/from a given square
 119   Bitboard attackers_to(Square s) const;
 120   Bitboard attackers_to(Square s, Bitboard occupied) const;
 121   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) 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_or_promotion(Move m) const;
 128   bool gives_check(Move m) const;
 129   bool advanced_pawn_push(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 non_pawn_material(Color c) const;
 165   Value non_pawn_material() const;
 166
 167   // Position consistency check, for debugging
 168   bool pos_is_ok() const;
 169   void flip();
 170
 171   // Used by NNUE
 172   StateInfo* state() const;
 173   const EvalList* eval_list() const;
 174
 175 private:
 176   // Initialization helpers (used while setting up a position)
 177   void set_castling_right(Color c, Square rfrom);
 178   void set_state(StateInfo* si) const;
 179   void set_check_info(StateInfo* si) const;
 180
 181   // Other helpers
 182   void put_piece(Piece pc, Square s);
 183   void remove_piece(Square s);
 184   void move_piece(Square from, Square to);
 185   template<bool Do>
 186   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 187
 188   // ID of a piece on a given square
 189   PieceId piece_id_on(Square sq) 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   Square pieceList[PIECE_NB][16];
 197   int index[SQUARE_NB];
 198   int castlingRightsMask[SQUARE_NB];
 199   Square castlingRookSquare[CASTLING_RIGHT_NB];
 200   Bitboard castlingPath[CASTLING_RIGHT_NB];
 201   int gamePly;
 202   Color sideToMove;
 203   Score psq;
 204   Thread* thisThread;
 205   StateInfo* st;
 206   bool chess960;
 207
 208   // List of pieces used in NNUE evaluation function
 209   EvalList evalList;
 210 };
 211
 212 namespace PSQT {
 213   extern Score psq[PIECE_NB][SQUARE_NB];
 214 }
 215
 216 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
 217
 218 inline Color Position::side_to_move() const {
 219   return sideToMove;
 220 }
 221
 222 inline Piece Position::piece_on(Square s) const {
 223   assert(is_ok(s));
 224   return board[s];
 225 }
 226
 227 inline bool Position::empty(Square s) const {
 228   return piece_on(s) == NO_PIECE;
 229 }
 230
 231 inline Piece Position::moved_piece(Move m) const {
 232   return piece_on(from_sq(m));
 233 }
 234
 235 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
 236   return byTypeBB[pt];
 237 }
 238
 239 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 240   return pieces(pt1) | pieces(pt2);
 241 }
 242
 243 inline Bitboard Position::pieces(Color c) const {
 244   return byColorBB[c];
 245 }
 246
 247 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 248   return pieces(c) & pieces(pt);
 249 }
 250
 251 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 252   return pieces(c) & (pieces(pt1) | pieces(pt2));
 253 }
 254
 255 template<PieceType Pt> inline int Position::count(Color c) const {
 256   return pieceCount[make_piece(c, Pt)];
 257 }
 258
 259 template<PieceType Pt> inline int Position::count() const {
 260   return count<Pt>(WHITE) + count<Pt>(BLACK);
 261 }
 262
 263 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
 264   return pieceList[make_piece(c, Pt)];
 265 }
 266
 267 template<PieceType Pt> inline Square Position::square(Color c) const {
 268   assert(pieceCount[make_piece(c, Pt)] == 1);
 269   return squares<Pt>(c)[0];
 270 }
 271
 272 inline Square Position::ep_square() const {
 273   return st->epSquare;
 274 }
 275
 276 inline bool Position::is_on_semiopen_file(Color c, Square s) const {
 277   return !(pieces(c, PAWN) & file_bb(s));
 278 }
 279
 280 inline bool Position::can_castle(CastlingRights cr) const {
 281   return st->castlingRights & cr;
 282 }
 283
 284 inline CastlingRights Position::castling_rights(Color c) const {
 285   return c & CastlingRights(st->castlingRights);
 286 }
 287
 288 inline bool Position::castling_impeded(CastlingRights cr) const {
 289   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 290
 291   return pieces() & castlingPath[cr];
 292 }
 293
 294 inline Square Position::castling_rook_square(CastlingRights cr) const {
 295   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 296
 297   return castlingRookSquare[cr];
 298 }
 299
 300 inline Bitboard Position::attackers_to(Square s) const {
 301   return attackers_to(s, pieces());
 302 }
 303
 304 inline Bitboard Position::checkers() const {
 305   return st->checkersBB;
 306 }
 307
 308 inline Bitboard Position::blockers_for_king(Color c) const {
 309   return st->blockersForKing[c];
 310 }
 311
 312 inline Bitboard Position::check_squares(PieceType pt) const {
 313   return st->checkSquares[pt];
 314 }
 315
 316 inline bool Position::is_discovery_check_on_king(Color c, Move m) const {
 317   return st->blockersForKing[c] & from_sq(m);
 318 }
 319
 320 inline bool Position::pawn_passed(Color c, Square s) const {
 321   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 322 }
 323
 324 inline bool Position::advanced_pawn_push(Move m) const {
 325   return   type_of(moved_piece(m)) == PAWN
 326         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
 327 }
 328
 329 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 330   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 331 }
 332
 333 inline Key Position::key() const {
 334   return st->key;
 335 }
 336
 337 inline Key Position::pawn_key() const {
 338   return st->pawnKey;
 339 }
 340
 341 inline Key Position::material_key() const {
 342   return st->materialKey;
 343 }
 344
 345 inline Score Position::psq_score() const {
 346   return psq;
 347 }
 348
 349 inline Value Position::non_pawn_material(Color c) const {
 350   return st->nonPawnMaterial[c];
 351 }
 352
 353 inline Value Position::non_pawn_material() const {
 354   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 355 }
 356
 357 inline int Position::game_ply() const {
 358   return gamePly;
 359 }
 360
 361 inline int Position::rule50_count() const {
 362   return st->rule50;
 363 }
 364
 365 inline bool Position::opposite_bishops() const {
 366   return   count<BISHOP>(WHITE) == 1
 367         && count<BISHOP>(BLACK) == 1
 368         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 369 }
 370
 371 inline bool Position::is_chess960() const {
 372   return chess960;
 373 }
 374
 375 inline bool Position::capture_or_promotion(Move m) const {
 376   assert(is_ok(m));
 377   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 378 }
 379
 380 inline bool Position::capture(Move m) const {
 381   assert(is_ok(m));
 382   // Castling is encoded as "king captures rook"
 383   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 384 }
 385
 386 inline Piece Position::captured_piece() const {
 387   return st->capturedPiece;
 388 }
 389
 390 inline Thread* Position::this_thread() const {
 391   return thisThread;
 392 }
 393
 394 inline void Position::put_piece(Piece pc, Square s) {
 395
 396   board[s] = pc;
 397   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 398   byColorBB[color_of(pc)] |= s;
 399   index[s] = pieceCount[pc]++;
 400   pieceList[pc][index[s]] = s;
 401   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 402   psq += PSQT::psq[pc][s];
 403 }
 404
 405 inline void Position::remove_piece(Square s) {
 406
 407   // WARNING: This is not a reversible operation. If we remove a piece in
 408   // do_move() and then replace it in undo_move() we will put it at the end of
 409   // the list and not in its original place, it means index[] and pieceList[]
 410   // are not invariant to a do_move() + undo_move() sequence.
 411   Piece pc = board[s];
 412   byTypeBB[ALL_PIECES] ^= s;
 413   byTypeBB[type_of(pc)] ^= s;
 414   byColorBB[color_of(pc)] ^= s;
 415   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 416   Square lastSquare = pieceList[pc][--pieceCount[pc]];
 417   index[lastSquare] = index[s];
 418   pieceList[pc][index[lastSquare]] = lastSquare;
 419   pieceList[pc][pieceCount[pc]] = SQ_NONE;
 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   // index[from] is not updated and becomes stale. This works as long as index[]
 427   // is accessed just by known occupied squares.
 428   Piece pc = board[from];
 429   Bitboard fromTo = from | to;
 430   byTypeBB[ALL_PIECES] ^= fromTo;
 431   byTypeBB[type_of(pc)] ^= fromTo;
 432   byColorBB[color_of(pc)] ^= fromTo;
 433   board[from] = NO_PIECE;
 434   board[to] = pc;
 435   index[to] = index[from];
 436   pieceList[pc][index[to]] = to;
 437   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 438 }
 439
 440 inline void Position::do_move(Move m, StateInfo& newSt) {
 441   do_move(m, newSt, gives_check(m));
 442 }
 443
 444 inline StateInfo* Position::state() const {
 445
 446   return st;
 447 }
 448
 449 inline const EvalList* Position::eval_list() const {
 450
 451   return &evalList;
 452 }
 453
 454 inline PieceId Position::piece_id_on(Square sq) const
 455 {
 456
 457   assert(piece_on(sq) != NO_PIECE);
 458
 459   PieceId pid = evalList.piece_id_list[sq];
 460   assert(is_ok(pid));
 461
 462   return pid;
 463 }
 464
 465 #endif // #ifndef POSITION_H_INCLUDED