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
  35 /// StateInfo struct stores information needed to restore a Position object to
  36 /// its previous state when we retract a move. Whenever a move is made on the
  37 /// board (by calling Position::do_move), a StateInfo object must be passed.
  38
  39 struct StateInfo {
  40
  41   // Copied when making a move
  42   Key    pawnKey;
  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   Piece      capturedPiece;
  54   StateInfo* previous;
  55   Bitboard   blockersForKing[COLOR_NB];
  56   Bitboard   pinners[COLOR_NB];
  57   Bitboard   checkSquares[PIECE_TYPE_NB];
  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 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
  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   const std::string fen() const;
  91
  92   // Position representation
  93   Bitboard pieces(PieceType pt) const;
  94   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  95   Bitboard pieces(Color c) const;
  96   Bitboard pieces(Color c, PieceType pt) const;
  97   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  98   Piece piece_on(Square s) const;
  99   Square ep_square() const;
 100   bool empty(Square s) const;
 101   template<PieceType Pt> int count(Color c) const;
 102   template<PieceType Pt> int count() 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_discovered_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
 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   // Data members
 189   Piece board[SQUARE_NB];
 190   Bitboard byTypeBB[PIECE_TYPE_NB];
 191   Bitboard byColorBB[COLOR_NB];
 192   int pieceCount[PIECE_NB];
 193   int castlingRightsMask[SQUARE_NB];
 194   Square castlingRookSquare[CASTLING_RIGHT_NB];
 195   Bitboard castlingPath[CASTLING_RIGHT_NB];
 196   int gamePly;
 197   Color sideToMove;
 198   Score psq;
 199   Thread* thisThread;
 200   StateInfo* st;
 201   bool chess960;
 202 };
 203
 204 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
 205
 206 inline Color Position::side_to_move() const {
 207   return sideToMove;
 208 }
 209
 210 inline Piece Position::piece_on(Square s) const {
 211   assert(is_ok(s));
 212   return board[s];
 213 }
 214
 215 inline bool Position::empty(Square s) const {
 216   return piece_on(s) == NO_PIECE;
 217 }
 218
 219 inline Piece Position::moved_piece(Move m) const {
 220   return piece_on(from_sq(m));
 221 }
 222
 223 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
 224   return byTypeBB[pt];
 225 }
 226
 227 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 228   return pieces(pt1) | pieces(pt2);
 229 }
 230
 231 inline Bitboard Position::pieces(Color c) const {
 232   return byColorBB[c];
 233 }
 234
 235 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 236   return pieces(c) & pieces(pt);
 237 }
 238
 239 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 240   return pieces(c) & (pieces(pt1) | pieces(pt2));
 241 }
 242
 243 template<PieceType Pt> inline int Position::count(Color c) const {
 244   return pieceCount[make_piece(c, Pt)];
 245 }
 246
 247 template<PieceType Pt> inline int Position::count() const {
 248   return count<Pt>(WHITE) + count<Pt>(BLACK);
 249 }
 250
 251 template<PieceType Pt> inline Square Position::square(Color c) const {
 252   assert(count<Pt>(c) == 1);
 253   return lsb(pieces(c, Pt));
 254 }
 255
 256 inline Square Position::ep_square() const {
 257   return st->epSquare;
 258 }
 259
 260 inline bool Position::is_on_semiopen_file(Color c, Square s) const {
 261   return !(pieces(c, PAWN) & file_bb(s));
 262 }
 263
 264 inline bool Position::can_castle(CastlingRights cr) const {
 265   return st->castlingRights & cr;
 266 }
 267
 268 inline CastlingRights Position::castling_rights(Color c) const {
 269   return c & CastlingRights(st->castlingRights);
 270 }
 271
 272 inline bool Position::castling_impeded(CastlingRights cr) const {
 273   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 274
 275   return pieces() & castlingPath[cr];
 276 }
 277
 278 inline Square Position::castling_rook_square(CastlingRights cr) const {
 279   assert(cr == WHITE_OO || cr == WHITE_OOO || cr == BLACK_OO || cr == BLACK_OOO);
 280
 281   return castlingRookSquare[cr];
 282 }
 283
 284 inline Bitboard Position::attackers_to(Square s) const {
 285   return attackers_to(s, pieces());
 286 }
 287
 288 inline Bitboard Position::checkers() const {
 289   return st->checkersBB;
 290 }
 291
 292 inline Bitboard Position::blockers_for_king(Color c) const {
 293   return st->blockersForKing[c];
 294 }
 295
 296 inline Bitboard Position::pinners(Color c) const {
 297   return st->pinners[c];
 298 }
 299
 300 inline Bitboard Position::check_squares(PieceType pt) const {
 301   return st->checkSquares[pt];
 302 }
 303
 304 inline bool Position::is_discovered_check_on_king(Color c, Move m) const {
 305   return st->blockersForKing[c] & from_sq(m);
 306 }
 307
 308 inline bool Position::pawn_passed(Color c, Square s) const {
 309   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 310 }
 311
 312 inline bool Position::advanced_pawn_push(Move m) const {
 313   return   type_of(moved_piece(m)) == PAWN
 314         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
 315 }
 316
 317 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 318   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 319 }
 320
 321 inline Key Position::key() const {
 322   return st->rule50 < 14 ? st->key
 323                          : st->key ^ make_key((st->rule50 - 14) / 8);
 324 }
 325
 326 inline Key Position::pawn_key() const {
 327   return st->pawnKey;
 328 }
 329
 330 inline Key Position::material_key() const {
 331   return st->materialKey;
 332 }
 333
 334 inline Score Position::psq_score() const {
 335   return psq;
 336 }
 337
 338 inline Value Position::non_pawn_material(Color c) const {
 339   return st->nonPawnMaterial[c];
 340 }
 341
 342 inline Value Position::non_pawn_material() const {
 343   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 344 }
 345
 346 inline int Position::game_ply() const {
 347   return gamePly;
 348 }
 349
 350 inline int Position::rule50_count() const {
 351   return st->rule50;
 352 }
 353
 354 inline bool Position::opposite_bishops() const {
 355   return   count<BISHOP>(WHITE) == 1
 356         && count<BISHOP>(BLACK) == 1
 357         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 358 }
 359
 360 inline bool Position::is_chess960() const {
 361   return chess960;
 362 }
 363
 364 inline bool Position::capture_or_promotion(Move m) const {
 365   assert(is_ok(m));
 366   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 367 }
 368
 369 inline bool Position::capture(Move m) const {
 370   assert(is_ok(m));
 371   // Castling is encoded as "king captures rook"
 372   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == EN_PASSANT;
 373 }
 374
 375 inline Piece Position::captured_piece() const {
 376   return st->capturedPiece;
 377 }
 378
 379 inline Thread* Position::this_thread() const {
 380   return thisThread;
 381 }
 382
 383 inline void Position::put_piece(Piece pc, Square s) {
 384
 385   board[s] = pc;
 386   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 387   byColorBB[color_of(pc)] |= s;
 388   pieceCount[pc]++;
 389   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 390   psq += PSQT::psq[pc][s];
 391 }
 392
 393 inline void Position::remove_piece(Square s) {
 394
 395   Piece pc = board[s];
 396   byTypeBB[ALL_PIECES] ^= s;
 397   byTypeBB[type_of(pc)] ^= s;
 398   byColorBB[color_of(pc)] ^= s;
 399   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 400   pieceCount[pc]--;
 401   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 402   psq -= PSQT::psq[pc][s];
 403 }
 404
 405 inline void Position::move_piece(Square from, Square to) {
 406
 407   Piece pc = board[from];
 408   Bitboard fromTo = from | to;
 409   byTypeBB[ALL_PIECES] ^= fromTo;
 410   byTypeBB[type_of(pc)] ^= fromTo;
 411   byColorBB[color_of(pc)] ^= fromTo;
 412   board[from] = NO_PIECE;
 413   board[to] = pc;
 414   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 415 }
 416
 417 inline void Position::do_move(Move m, StateInfo& newSt) {
 418   do_move(m, newSt, gives_check(m));
 419 }
 420
 421 inline StateInfo* Position::state() const {
 422
 423   return st;
 424 }
 425
 426 #endif // #ifndef POSITION_H_INCLUDED