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-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef POSITION_H_INCLUDED
  22 #define POSITION_H_INCLUDED
  23
  24 #include <cassert>
  25 #include <deque>
  26 #include <memory> // For std::unique_ptr
  27 #include <string>
  28
  29 #include "bitboard.h"
  30 #include "types.h"
  31
  32
  33 /// StateInfo struct stores information needed to restore a Position object to
  34 /// its previous state when we retract a move. Whenever a move is made on the
  35 /// board (by calling Position::do_move), a StateInfo object must be passed.
  36
  37 struct StateInfo {
  38
  39   // Copied when making a move
  40   Key    pawnKey;
  41   Key    materialKey;
  42   Value  nonPawnMaterial[COLOR_NB];
  43   int    castlingRights;
  44   int    rule50;
  45   int    pliesFromNull;
  46   Square epSquare;
  47
  48   // Not copied when making a move (will be recomputed anyhow)
  49   Key        key;
  50   Bitboard   checkersBB;
  51   Piece      capturedPiece;
  52   StateInfo* previous;
  53   Bitboard   blockersForKing[COLOR_NB];
  54   Bitboard   pinners[COLOR_NB];
  55   Bitboard   checkSquares[PIECE_TYPE_NB];
  56   int        repetition;
  57 };
  58
  59 /// A list to keep track of the position states along the setup moves (from the
  60 /// start position to the position just before the search starts). Needed by
  61 /// 'draw by repetition' detection. Use a std::deque because pointers to
  62 /// elements are not invalidated upon list resizing.
  63 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
  64
  65
  66 /// Position class stores information regarding the board representation as
  67 /// pieces, side to move, hash keys, castling info, etc. Important methods are
  68 /// do_move() and undo_move(), used by the search to update node info when
  69 /// traversing the search tree.
  70 class Thread;
  71
  72 class Position {
  73 public:
  74   static void init();
  75
  76   Position() = default;
  77   Position(const Position&) = delete;
  78   Position& operator=(const Position&) = delete;
  79
  80   // FEN string input/output
  81   Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
  82   Position& set(const std::string& code, Color c, StateInfo* si);
  83   const std::string fen() const;
  84
  85   // Position representation
  86   Bitboard pieces(PieceType pt) const;
  87   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  88   Bitboard pieces(Color c) const;
  89   Bitboard pieces(Color c, PieceType pt) const;
  90   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  91   Piece piece_on(Square s) const;
  92   Square ep_square() const;
  93   bool empty(Square s) const;
  94   template<PieceType Pt> int count(Color c) const;
  95   template<PieceType Pt> int count() const;
  96   template<PieceType Pt> const Square* squares(Color c) const;
  97   template<PieceType Pt> Square square(Color c) const;
  98   bool is_on_semiopen_file(Color c, Square s) const;
  99
 100   // Castling
 101   CastlingRights castling_rights(Color c) const;
 102   bool can_castle(CastlingRights cr) const;
 103   bool castling_impeded(CastlingRights cr) const;
 104   Square castling_rook_square(CastlingRights cr) const;
 105
 106   // Checking
 107   Bitboard checkers() const;
 108   Bitboard blockers_for_king(Color c) const;
 109   Bitboard check_squares(PieceType pt) const;
 110   bool is_discovery_check_on_king(Color c, Move m) const;
 111
 112   // Attacks to/from a given square
 113   Bitboard attackers_to(Square s) const;
 114   Bitboard attackers_to(Square s, Bitboard occupied) const;
 115   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 116
 117   // Properties of moves
 118   bool legal(Move m) const;
 119   bool pseudo_legal(const Move m) const;
 120   bool capture(Move m) const;
 121   bool capture_or_promotion(Move m) const;
 122   bool gives_check(Move m) const;
 123   bool advanced_pawn_push(Move m) const;
 124   Piece moved_piece(Move m) const;
 125   Piece captured_piece() const;
 126
 127   // Piece specific
 128   bool pawn_passed(Color c, Square s) const;
 129   bool opposite_bishops() const;
 130   int  pawns_on_same_color_squares(Color c, Square s) const;
 131
 132   // Doing and undoing moves
 133   void do_move(Move m, StateInfo& newSt);
 134   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 135   void undo_move(Move m);
 136   void do_null_move(StateInfo& newSt);
 137   void undo_null_move();
 138
 139   // Static Exchange Evaluation
 140   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 141
 142   // Accessing hash keys
 143   Key key() const;
 144   Key key_after(Move m) const;
 145   Key material_key() const;
 146   Key pawn_key() const;
 147
 148   // Other properties of the position
 149   Color side_to_move() const;
 150   int game_ply() const;
 151   bool is_chess960() const;
 152   Thread* this_thread() const;
 153   bool is_draw(int ply) const;
 154   bool has_game_cycle(int ply) const;
 155   bool has_repeated() const;
 156   int rule50_count() const;
 157   Score psq_score() const;
 158   Value non_pawn_material(Color c) const;
 159   Value non_pawn_material() const;
 160
 161   // Position consistency check, for debugging
 162   bool pos_is_ok() const;
 163   void flip();
 164
 165 private:
 166   // Initialization helpers (used while setting up a position)
 167   void set_castling_right(Color c, Square rfrom);
 168   void set_state(StateInfo* si) const;
 169   void set_check_info(StateInfo* si) const;
 170
 171   // Other helpers
 172   void put_piece(Piece pc, Square s);
 173   void remove_piece(Square s);
 174   void move_piece(Square from, Square to);
 175   template<bool Do>
 176   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 177
 178   // Data members
 179   Piece board[SQUARE_NB];
 180   Bitboard byTypeBB[PIECE_TYPE_NB];
 181   Bitboard byColorBB[COLOR_NB];
 182   int pieceCount[PIECE_NB];
 183   Square pieceList[PIECE_NB][16];
 184   int index[SQUARE_NB];
 185   int castlingRightsMask[SQUARE_NB];
 186   Square castlingRookSquare[CASTLING_RIGHT_NB];
 187   Bitboard castlingPath[CASTLING_RIGHT_NB];
 188   int gamePly;
 189   Color sideToMove;
 190   Score psq;
 191   Thread* thisThread;
 192   StateInfo* st;
 193   bool chess960;
 194 };
 195
 196 namespace PSQT {
 197   extern Score psq[PIECE_NB][SQUARE_NB];
 198 }
 199
 200 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
 201
 202 inline Color Position::side_to_move() const {
 203   return sideToMove;
 204 }
 205
 206 inline Piece Position::piece_on(Square s) const {
 207   assert(is_ok(s));
 208   return board[s];
 209 }
 210
 211 inline bool Position::empty(Square s) const {
 212   return piece_on(s) == NO_PIECE;
 213 }
 214
 215 inline Piece Position::moved_piece(Move m) const {
 216   return piece_on(from_sq(m));
 217 }
 218
 219 inline Bitboard Position::pieces(PieceType pt = ALL_PIECES) const {
 220   return byTypeBB[pt];
 221 }
 222
 223 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 224   return pieces(pt1) | pieces(pt2);
 225 }
 226
 227 inline Bitboard Position::pieces(Color c) const {
 228   return byColorBB[c];
 229 }
 230
 231 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 232   return pieces(c) & pieces(pt);
 233 }
 234
 235 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 236   return pieces(c) & (pieces(pt1) | pieces(pt2));
 237 }
 238
 239 template<PieceType Pt> inline int Position::count(Color c) const {
 240   return pieceCount[make_piece(c, Pt)];
 241 }
 242
 243 template<PieceType Pt> inline int Position::count() const {
 244   return count<Pt>(WHITE) + count<Pt>(BLACK);
 245 }
 246
 247 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
 248   return pieceList[make_piece(c, Pt)];
 249 }
 250
 251 template<PieceType Pt> inline Square Position::square(Color c) const {
 252   assert(pieceCount[make_piece(c, Pt)] == 1);
 253   return squares<Pt>(c)[0];
 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::check_squares(PieceType pt) const {
 297   return st->checkSquares[pt];
 298 }
 299
 300 inline bool Position::is_discovery_check_on_king(Color c, Move m) const {
 301   return st->blockersForKing[c] & from_sq(m);
 302 }
 303
 304 inline bool Position::pawn_passed(Color c, Square s) const {
 305   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 306 }
 307
 308 inline bool Position::advanced_pawn_push(Move m) const {
 309   return   type_of(moved_piece(m)) == PAWN
 310         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
 311 }
 312
 313 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 314   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 315 }
 316
 317 inline Key Position::key() const {
 318   return st->key;
 319 }
 320
 321 inline Key Position::pawn_key() const {
 322   return st->pawnKey;
 323 }
 324
 325 inline Key Position::material_key() const {
 326   return st->materialKey;
 327 }
 328
 329 inline Score Position::psq_score() const {
 330   return psq;
 331 }
 332
 333 inline Value Position::non_pawn_material(Color c) const {
 334   return st->nonPawnMaterial[c];
 335 }
 336
 337 inline Value Position::non_pawn_material() const {
 338   return non_pawn_material(WHITE) + non_pawn_material(BLACK);
 339 }
 340
 341 inline int Position::game_ply() const {
 342   return gamePly;
 343 }
 344
 345 inline int Position::rule50_count() const {
 346   return st->rule50;
 347 }
 348
 349 inline bool Position::opposite_bishops() const {
 350   return   count<BISHOP>(WHITE) == 1
 351         && count<BISHOP>(BLACK) == 1
 352         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 353 }
 354
 355 inline bool Position::is_chess960() const {
 356   return chess960;
 357 }
 358
 359 inline bool Position::capture_or_promotion(Move m) const {
 360   assert(is_ok(m));
 361   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 362 }
 363
 364 inline bool Position::capture(Move m) const {
 365   assert(is_ok(m));
 366   // Castling is encoded as "king captures rook"
 367   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 368 }
 369
 370 inline Piece Position::captured_piece() const {
 371   return st->capturedPiece;
 372 }
 373
 374 inline Thread* Position::this_thread() const {
 375   return thisThread;
 376 }
 377
 378 inline void Position::put_piece(Piece pc, Square s) {
 379
 380   board[s] = pc;
 381   byTypeBB[ALL_PIECES] |= byTypeBB[type_of(pc)] |= s;
 382   byColorBB[color_of(pc)] |= s;
 383   index[s] = pieceCount[pc]++;
 384   pieceList[pc][index[s]] = s;
 385   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 386   psq += PSQT::psq[pc][s];
 387 }
 388
 389 inline void Position::remove_piece(Square s) {
 390
 391   // WARNING: This is not a reversible operation. If we remove a piece in
 392   // do_move() and then replace it in undo_move() we will put it at the end of
 393   // the list and not in its original place, it means index[] and pieceList[]
 394   // are not invariant to a do_move() + undo_move() sequence.
 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   Square lastSquare = pieceList[pc][--pieceCount[pc]];
 401   index[lastSquare] = index[s];
 402   pieceList[pc][index[lastSquare]] = lastSquare;
 403   pieceList[pc][pieceCount[pc]] = SQ_NONE;
 404   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 405   psq -= PSQT::psq[pc][s];
 406 }
 407
 408 inline void Position::move_piece(Square from, Square to) {
 409
 410   // index[from] is not updated and becomes stale. This works as long as index[]
 411   // is accessed just by known occupied squares.
 412   Piece pc = board[from];
 413   Bitboard fromTo = from | to;
 414   byTypeBB[ALL_PIECES] ^= fromTo;
 415   byTypeBB[type_of(pc)] ^= fromTo;
 416   byColorBB[color_of(pc)] ^= fromTo;
 417   board[from] = NO_PIECE;
 418   board[to] = pc;
 419   index[to] = index[from];
 420   pieceList[pc][index[to]] = to;
 421   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 422 }
 423
 424 inline void Position::do_move(Move m, StateInfo& newSt) {
 425   do_move(m, newSt, gives_check(m));
 426 }
 427
 428 #endif // #ifndef POSITION_H_INCLUDED