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-2019 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   int repetition;
  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 };
  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() const;
  87   Bitboard pieces(PieceType pt) const;
  88   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  89   Bitboard pieces(Color c) const;
  90   Bitboard pieces(Color c, PieceType pt) const;
  91   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  92   Piece piece_on(Square s) const;
  93   Square ep_square() const;
  94   bool empty(Square s) const;
  95   template<PieceType Pt> int count(Color c) const;
  96   template<PieceType Pt> int count() const;
  97   template<PieceType Pt> const Square* squares(Color c) const;
  98   template<PieceType Pt> Square square(Color c) const;
  99   bool is_semiopen_file(Color c, File f) const;
 100
 101   // Castling
 102   int castling_rights(Color c) const;
 103   bool can_castle(CastlingRight cr) const;
 104   bool castling_impeded(CastlingRight cr) const;
 105   Square castling_rook_square(CastlingRight cr) const;
 106
 107   // Checking
 108   Bitboard checkers() const;
 109   Bitboard blockers_for_king(Color c) const;
 110   Bitboard check_squares(PieceType pt) 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 attacks_from(PieceType pt, Square s) const;
 116   template<PieceType> Bitboard attacks_from(Square s) const;
 117   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 118   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 119
 120   // Properties of moves
 121   bool legal(Move m) const;
 122   bool pseudo_legal(const Move m) const;
 123   bool capture(Move m) const;
 124   bool capture_or_promotion(Move m) const;
 125   bool gives_check(Move m) const;
 126   bool advanced_pawn_push(Move m) const;
 127   Piece moved_piece(Move m) const;
 128   Piece captured_piece() const;
 129
 130   // Piece specific
 131   bool pawn_passed(Color c, Square s) const;
 132   bool opposite_bishops() const;
 133   int  pawns_on_same_color_squares(Color c, Square s) const;
 134
 135   // Doing and undoing moves
 136   void do_move(Move m, StateInfo& newSt);
 137   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 138   void undo_move(Move m);
 139   void do_null_move(StateInfo& newSt);
 140   void undo_null_move();
 141
 142   // Static Exchange Evaluation
 143   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
 144
 145   // Accessing hash keys
 146   Key key() const;
 147   Key key_after(Move m) const;
 148   Key material_key() const;
 149   Key pawn_key() const;
 150
 151   // Other properties of the position
 152   Color side_to_move() const;
 153   int game_ply() const;
 154   bool is_chess960() const;
 155   Thread* this_thread() const;
 156   bool is_draw(int ply) const;
 157   bool has_game_cycle(int ply) const;
 158   bool has_repeated() const;
 159   int rule50_count() const;
 160   Score psq_score() const;
 161   Value non_pawn_material(Color c) const;
 162   Value non_pawn_material() const;
 163
 164   // Position consistency check, for debugging
 165   bool pos_is_ok() const;
 166   void flip();
 167
 168 private:
 169   // Initialization helpers (used while setting up a position)
 170   void set_castling_right(Color c, Square rfrom);
 171   void set_state(StateInfo* si) const;
 172   void set_check_info(StateInfo* si) const;
 173
 174   // Other helpers
 175   void put_piece(Piece pc, Square s);
 176   void remove_piece(Piece pc, Square s);
 177   void move_piece(Piece pc, Square from, Square to);
 178   template<bool Do>
 179   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 180
 181   // Data members
 182   Piece board[SQUARE_NB];
 183   Bitboard byTypeBB[PIECE_TYPE_NB];
 184   Bitboard byColorBB[COLOR_NB];
 185   int pieceCount[PIECE_NB];
 186   Square pieceList[PIECE_NB][16];
 187   int index[SQUARE_NB];
 188   int castlingRightsMask[SQUARE_NB];
 189   Square castlingRookSquare[CASTLING_RIGHT_NB];
 190   Bitboard castlingPath[CASTLING_RIGHT_NB];
 191   int gamePly;
 192   Color sideToMove;
 193   Score psq;
 194   Thread* thisThread;
 195   StateInfo* st;
 196   bool chess960;
 197 };
 198
 199 namespace PSQT {
 200   extern Score psq[PIECE_NB][SQUARE_NB];
 201 }
 202
 203 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
 204
 205 inline Color Position::side_to_move() const {
 206   return sideToMove;
 207 }
 208
 209 inline bool Position::empty(Square s) const {
 210   return board[s] == NO_PIECE;
 211 }
 212
 213 inline Piece Position::piece_on(Square s) const {
 214   return board[s];
 215 }
 216
 217 inline Piece Position::moved_piece(Move m) const {
 218   return board[from_sq(m)];
 219 }
 220
 221 inline Bitboard Position::pieces() const {
 222   return byTypeBB[ALL_PIECES];
 223 }
 224
 225 inline Bitboard Position::pieces(PieceType pt) const {
 226   return byTypeBB[pt];
 227 }
 228
 229 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 230   return byTypeBB[pt1] | byTypeBB[pt2];
 231 }
 232
 233 inline Bitboard Position::pieces(Color c) const {
 234   return byColorBB[c];
 235 }
 236
 237 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 238   return byColorBB[c] & byTypeBB[pt];
 239 }
 240
 241 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 242   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
 243 }
 244
 245 template<PieceType Pt> inline int Position::count(Color c) const {
 246   return pieceCount[make_piece(c, Pt)];
 247 }
 248
 249 template<PieceType Pt> inline int Position::count() const {
 250   return pieceCount[make_piece(WHITE, Pt)] + pieceCount[make_piece(BLACK, Pt)];
 251 }
 252
 253 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
 254   return pieceList[make_piece(c, Pt)];
 255 }
 256
 257 template<PieceType Pt> inline Square Position::square(Color c) const {
 258   assert(pieceCount[make_piece(c, Pt)] == 1);
 259   return pieceList[make_piece(c, Pt)][0];
 260 }
 261
 262 inline Square Position::ep_square() const {
 263   return st->epSquare;
 264 }
 265
 266 inline bool Position::is_semiopen_file(Color c, File f) const {
 267   return !(pieces(c, PAWN) & file_bb(f));
 268 }
 269
 270 inline bool Position::can_castle(CastlingRight cr) const {
 271   return st->castlingRights & cr;
 272 }
 273
 274 inline int Position::castling_rights(Color c) const {
 275   return st->castlingRights & (c == WHITE ? WHITE_CASTLING : BLACK_CASTLING);
 276 }
 277
 278 inline bool Position::castling_impeded(CastlingRight cr) const {
 279   return byTypeBB[ALL_PIECES] & castlingPath[cr];
 280 }
 281
 282 inline Square Position::castling_rook_square(CastlingRight cr) const {
 283   return castlingRookSquare[cr];
 284 }
 285
 286 template<PieceType Pt>
 287 inline Bitboard Position::attacks_from(Square s) const {
 288   assert(Pt != PAWN);
 289   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
 290         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
 291         : PseudoAttacks[Pt][s];
 292 }
 293
 294 template<>
 295 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 296   return PawnAttacks[c][s];
 297 }
 298
 299 inline Bitboard Position::attacks_from(PieceType pt, Square s) const {
 300   return attacks_bb(pt, s, byTypeBB[ALL_PIECES]);
 301 }
 302
 303 inline Bitboard Position::attackers_to(Square s) const {
 304   return attackers_to(s, byTypeBB[ALL_PIECES]);
 305 }
 306
 307 inline Bitboard Position::checkers() const {
 308   return st->checkersBB;
 309 }
 310
 311 inline Bitboard Position::blockers_for_king(Color c) const {
 312   return st->blockersForKing[c];
 313 }
 314
 315 inline Bitboard Position::check_squares(PieceType pt) const {
 316   return st->checkSquares[pt];
 317 }
 318
 319 inline bool Position::pawn_passed(Color c, Square s) const {
 320   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
 321 }
 322
 323 inline bool Position::advanced_pawn_push(Move m) const {
 324   return   type_of(moved_piece(m)) == PAWN
 325         && relative_rank(sideToMove, to_sq(m)) > RANK_5;
 326 }
 327
 328 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
 329   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
 330 }
 331
 332 inline Key Position::key() const {
 333   return st->key;
 334 }
 335
 336 inline Key Position::pawn_key() const {
 337   return st->pawnKey;
 338 }
 339
 340 inline Key Position::material_key() const {
 341   return st->materialKey;
 342 }
 343
 344 inline Score Position::psq_score() const {
 345   return psq;
 346 }
 347
 348 inline Value Position::non_pawn_material(Color c) const {
 349   return st->nonPawnMaterial[c];
 350 }
 351
 352 inline Value Position::non_pawn_material() const {
 353   return st->nonPawnMaterial[WHITE] + st->nonPawnMaterial[BLACK];
 354 }
 355
 356 inline int Position::game_ply() const {
 357   return gamePly;
 358 }
 359
 360 inline int Position::rule50_count() const {
 361   return st->rule50;
 362 }
 363
 364 inline bool Position::opposite_bishops() const {
 365   return   pieceCount[W_BISHOP] == 1
 366         && pieceCount[B_BISHOP] == 1
 367         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 368 }
 369
 370 inline bool Position::is_chess960() const {
 371   return chess960;
 372 }
 373
 374 inline bool Position::capture_or_promotion(Move m) const {
 375   assert(is_ok(m));
 376   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 377 }
 378
 379 inline bool Position::capture(Move m) const {
 380   assert(is_ok(m));
 381   // Castling is encoded as "king captures rook"
 382   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 383 }
 384
 385 inline Piece Position::captured_piece() const {
 386   return st->capturedPiece;
 387 }
 388
 389 inline Thread* Position::this_thread() const {
 390   return thisThread;
 391 }
 392
 393 inline void Position::put_piece(Piece pc, Square s) {
 394
 395   board[s] = pc;
 396   byTypeBB[ALL_PIECES] |= s;
 397   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(Piece pc, 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   byTypeBB[ALL_PIECES] ^= s;
 412   byTypeBB[type_of(pc)] ^= s;
 413   byColorBB[color_of(pc)] ^= s;
 414   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 415   Square lastSquare = pieceList[pc][--pieceCount[pc]];
 416   index[lastSquare] = index[s];
 417   pieceList[pc][index[lastSquare]] = lastSquare;
 418   pieceList[pc][pieceCount[pc]] = SQ_NONE;
 419   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 420   psq -= PSQT::psq[pc][s];
 421 }
 422
 423 inline void Position::move_piece(Piece pc, Square from, Square to) {
 424
 425   // index[from] is not updated and becomes stale. This works as long as index[]
 426   // is accessed just by known occupied squares.
 427   Bitboard fromTo = square_bb(from) | square_bb(to);
 428   byTypeBB[ALL_PIECES] ^= fromTo;
 429   byTypeBB[type_of(pc)] ^= fromTo;
 430   byColorBB[color_of(pc)] ^= fromTo;
 431   board[from] = NO_PIECE;
 432   board[to] = pc;
 433   index[to] = index[from];
 434   pieceList[pc][index[to]] = to;
 435   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
 436 }
 437
 438 inline void Position::do_move(Move m, StateInfo& newSt) {
 439   do_move(m, newSt, gives_check(m));
 440 }
 441
 442 #endif // #ifndef POSITION_H_INCLUDED