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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
   5
   6   Stockfish is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   Stockfish is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #if !defined(POSITION_H_INCLUDED)
  21 #define POSITION_H_INCLUDED
  22
  23 #include <cassert>
  24
  25 #include "bitboard.h"
  26 #include "move.h"
  27 #include "types.h"
  28
  29 /// Maximum number of plies per game (220 should be enough, because the
  30 /// maximum search depth is 100, and during position setup we reset the
  31 /// move counter for every non-reversible move).
  32 const int MaxGameLength = 220;
  33
  34 class Position;
  35
  36 /// struct checkInfo is initialized at c'tor time and keeps
  37 /// info used to detect if a move gives check.
  38
  39 struct CheckInfo {
  40
  41     explicit CheckInfo(const Position&);
  42
  43     Bitboard dcCandidates;
  44     Bitboard pinned;
  45     Bitboard checkSq[8];
  46 };
  47
  48 /// Castle rights, encoded as bit fields
  49
  50 enum CastleRight {
  51   CASTLES_NONE = 0,
  52   WHITE_OO     = 1,
  53   BLACK_OO     = 2,
  54   WHITE_OOO    = 4,
  55   BLACK_OOO    = 8,
  56   ALL_CASTLES  = 15
  57 };
  58
  59 /// Game phase
  60 enum Phase {
  61   PHASE_ENDGAME = 0,
  62   PHASE_MIDGAME = 128
  63 };
  64
  65
  66 /// The StateInfo struct stores information we need to restore a Position
  67 /// object to its previous state when we retract a move. Whenever a move
  68 /// is made on the board (by calling Position::do_move), an StateInfo object
  69 /// must be passed as a parameter.
  70
  71 struct StateInfo {
  72   Key pawnKey, materialKey;
  73   int castleRights, rule50, gamePly, pliesFromNull;
  74   Square epSquare;
  75   Score value;
  76   Value npMaterial[2];
  77
  78   PieceType capturedType;
  79   Key key;
  80   Bitboard checkersBB;
  81   StateInfo* previous;
  82 };
  83
  84
  85 /// The position data structure. A position consists of the following data:
  86 ///
  87 ///    * For each piece type, a bitboard representing the squares occupied
  88 ///      by pieces of that type.
  89 ///    * For each color, a bitboard representing the squares occupied by
  90 ///      pieces of that color.
  91 ///    * A bitboard of all occupied squares.
  92 ///    * A bitboard of all checking pieces.
  93 ///    * A 64-entry array of pieces, indexed by the squares of the board.
  94 ///    * The current side to move.
  95 ///    * Information about the castling rights for both sides.
  96 ///    * The initial files of the kings and both pairs of rooks. This is
  97 ///      used to implement the Chess960 castling rules.
  98 ///    * The en passant square (which is SQ_NONE if no en passant capture is
  99 ///      possible).
 100 ///    * The squares of the kings for both sides.
 101 ///    * Hash keys for the position itself, the current pawn structure, and
 102 ///      the current material situation.
 103 ///    * Hash keys for all previous positions in the game for detecting
 104 ///      repetition draws.
 105 ///    * A counter for detecting 50 move rule draws.
 106
 107 class Position {
 108
 109   Position(); // No default or copy c'tor allowed
 110   Position(const Position& pos);
 111
 112 public:
 113   enum GamePhase {
 114       MidGame,
 115       EndGame
 116   };
 117
 118   // Constructors
 119   Position(const Position& pos, int threadID);
 120   Position(const std::string& fen, bool isChess960, int threadID);
 121
 122   // Text input/output
 123   void from_fen(const std::string& fen, bool isChess960);
 124   const std::string to_fen() const;
 125   void print(Move m = MOVE_NONE) const;
 126
 127   // Copying
 128   void flip();
 129
 130   // The piece on a given square
 131   Piece piece_on(Square s) const;
 132   bool square_is_empty(Square s) const;
 133   bool square_is_occupied(Square s) const;
 134
 135   // Side to move
 136   Color side_to_move() const;
 137
 138   // Bitboard representation of the position
 139   Bitboard empty_squares() const;
 140   Bitboard occupied_squares() const;
 141   Bitboard pieces_of_color(Color c) const;
 142   Bitboard pieces(PieceType pt) const;
 143   Bitboard pieces(PieceType pt, Color c) const;
 144   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 145   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
 146
 147   // Number of pieces of each color and type
 148   int piece_count(Color c, PieceType pt) const;
 149
 150   // The en passant square
 151   Square ep_square() const;
 152
 153   // Current king position for each color
 154   Square king_square(Color c) const;
 155
 156   // Castling rights
 157   bool can_castle(CastleRight f) const;
 158   bool can_castle(Color c) const;
 159   Square castle_rook_square(CastleRight f) const;
 160
 161   // Bitboards for pinned pieces and discovered check candidates
 162   Bitboard discovered_check_candidates(Color c) const;
 163   Bitboard pinned_pieces(Color c) const;
 164
 165   // Checking pieces and under check information
 166   Bitboard checkers() const;
 167   bool in_check() const;
 168
 169   // Piece lists
 170   Square piece_list(Color c, PieceType pt, int index) const;
 171   const Square* piece_list_begin(Color c, PieceType pt) const;
 172
 173   // Information about attacks to or from a given square
 174   Bitboard attackers_to(Square s) const;
 175   Bitboard attackers_to(Square s, Bitboard occ) const;
 176   Bitboard attacks_from(Piece p, Square s) const;
 177   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
 178   template<PieceType> Bitboard attacks_from(Square s) const;
 179   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 180
 181   // Properties of moves
 182   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 183   bool move_is_pl(const Move m) const;
 184   bool move_gives_check(Move m, const CheckInfo& ci) const;
 185   bool move_is_capture(Move m) const;
 186   bool move_is_capture_or_promotion(Move m) const;
 187   bool move_is_passed_pawn_push(Move m) const;
 188   bool move_attacks_square(Move m, Square s) const;
 189
 190   // Piece captured with previous moves
 191   PieceType captured_piece_type() const;
 192
 193   // Information about pawns
 194   bool pawn_is_passed(Color c, Square s) const;
 195
 196   // Weak squares
 197   bool square_is_weak(Square s, Color c) const;
 198
 199   // Doing and undoing moves
 200   void do_setup_move(Move m);
 201   void do_move(Move m, StateInfo& st);
 202   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 203   void undo_move(Move m);
 204   void do_null_move(StateInfo& st);
 205   void undo_null_move();
 206
 207   // Static exchange evaluation
 208   int see(Move m) const;
 209   int see_sign(Move m) const;
 210
 211   // Accessing hash keys
 212   Key get_key() const;
 213   Key get_exclusion_key() const;
 214   Key get_pawn_key() const;
 215   Key get_material_key() const;
 216
 217   // Incremental evaluation
 218   Score value() const;
 219   Value non_pawn_material(Color c) const;
 220   static Score pst_delta(Piece piece, Square from, Square to);
 221
 222   // Game termination checks
 223   bool is_mate() const;
 224   template<bool SkipRepetition> bool is_draw() const;
 225
 226   // Number of plies from starting position
 227   int full_moves() const;
 228
 229   // Other properties of the position
 230   bool opposite_colored_bishops() const;
 231   bool has_pawn_on_7th(Color c) const;
 232   bool is_chess960() const;
 233
 234   // Current thread ID searching on the position
 235   int thread() const;
 236
 237   int64_t nodes_searched() const;
 238   void set_nodes_searched(int64_t n);
 239
 240   // Position consistency check, for debugging
 241   bool is_ok(int* failedStep = NULL) const;
 242
 243   // Global initialization
 244   static void init();
 245
 246 private:
 247
 248   // Initialization helper functions (used while setting up a position)
 249   void clear();
 250   void detach();
 251   void put_piece(Piece p, Square s);
 252   void set_castle(int f, Square ksq, Square rsq);
 253   void set_castling_rights(char token);
 254   bool move_is_pl_slow(const Move m) const;
 255
 256   // Helper functions for doing and undoing moves
 257   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 258   void do_castle_move(Move m);
 259   void undo_castle_move(Move m);
 260   void find_checkers();
 261
 262   template<bool FindPinned>
 263   Bitboard hidden_checkers(Color c) const;
 264
 265   // Computing hash keys from scratch (for initialization and debugging)
 266   Key compute_key() const;
 267   Key compute_pawn_key() const;
 268   Key compute_material_key() const;
 269
 270   // Computing incremental evaluation scores and material counts
 271   static Score pst(Color c, PieceType pt, Square s);
 272   Score compute_value() const;
 273   Value compute_non_pawn_material(Color c) const;
 274
 275   // Board
 276   Piece board[64];
 277
 278   // Bitboards
 279   Bitboard byTypeBB[8], byColorBB[2];
 280
 281   // Piece counts
 282   int pieceCount[2][8]; // [color][pieceType]
 283
 284   // Piece lists
 285   Square pieceList[2][8][16]; // [color][pieceType][index]
 286   int index[64]; // [square]
 287
 288   // Other info
 289   Color sideToMove;
 290   Key history[MaxGameLength];
 291   int castleRightsMask[64];
 292   Square castleRookSquare[16]; // [CastleRights]
 293   StateInfo startState;
 294   bool chess960;
 295   int fullMoves;
 296   int threadID;
 297   int64_t nodes;
 298   StateInfo* st;
 299
 300   // Static variables
 301   static Key zobrist[2][8][64];
 302   static Key zobEp[64];
 303   static Key zobCastle[16];
 304   static Key zobSideToMove;
 305   static Score PieceSquareTable[16][64];
 306   static Key zobExclusion;
 307 };
 308
 309 inline int64_t Position::nodes_searched() const {
 310   return nodes;
 311 }
 312
 313 inline void Position::set_nodes_searched(int64_t n) {
 314   nodes = n;
 315 }
 316
 317 inline Piece Position::piece_on(Square s) const {
 318   return board[s];
 319 }
 320
 321 inline bool Position::square_is_empty(Square s) const {
 322   return piece_on(s) == PIECE_NONE;
 323 }
 324
 325 inline bool Position::square_is_occupied(Square s) const {
 326   return !square_is_empty(s);
 327 }
 328
 329 inline Color Position::side_to_move() const {
 330   return sideToMove;
 331 }
 332
 333 inline Bitboard Position::occupied_squares() const {
 334   return byTypeBB[0];
 335 }
 336
 337 inline Bitboard Position::empty_squares() const {
 338   return ~occupied_squares();
 339 }
 340
 341 inline Bitboard Position::pieces_of_color(Color c) const {
 342   return byColorBB[c];
 343 }
 344
 345 inline Bitboard Position::pieces(PieceType pt) const {
 346   return byTypeBB[pt];
 347 }
 348
 349 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 350   return byTypeBB[pt] & byColorBB[c];
 351 }
 352
 353 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 354   return byTypeBB[pt1] | byTypeBB[pt2];
 355 }
 356
 357 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 358   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 359 }
 360
 361 inline int Position::piece_count(Color c, PieceType pt) const {
 362   return pieceCount[c][pt];
 363 }
 364
 365 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
 366   return pieceList[c][pt][idx];
 367 }
 368
 369 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
 370   return pieceList[c][pt];
 371 }
 372
 373 inline Square Position::ep_square() const {
 374   return st->epSquare;
 375 }
 376
 377 inline Square Position::king_square(Color c) const {
 378   return pieceList[c][KING][0];
 379 }
 380
 381 inline bool Position::can_castle(CastleRight f) const {
 382   return st->castleRights & f;
 383 }
 384
 385 inline bool Position::can_castle(Color c) const {
 386   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
 387 }
 388
 389 inline Square Position::castle_rook_square(CastleRight f) const {
 390   return castleRookSquare[f];
 391 }
 392
 393 template<>
 394 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 395   return StepAttacksBB[make_piece(c, PAWN)][s];
 396 }
 397
 398 template<PieceType Piece> // Knight and King and white pawns
 399 inline Bitboard Position::attacks_from(Square s) const {
 400   return StepAttacksBB[Piece][s];
 401 }
 402
 403 template<>
 404 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 405   return bishop_attacks_bb(s, occupied_squares());
 406 }
 407
 408 template<>
 409 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 410   return rook_attacks_bb(s, occupied_squares());
 411 }
 412
 413 template<>
 414 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 415   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 416 }
 417
 418 inline Bitboard Position::checkers() const {
 419   return st->checkersBB;
 420 }
 421
 422 inline bool Position::in_check() const {
 423   return st->checkersBB != EmptyBoardBB;
 424 }
 425
 426 inline bool Position::pawn_is_passed(Color c, Square s) const {
 427   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 428 }
 429
 430 inline bool Position::square_is_weak(Square s, Color c) const {
 431   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
 432 }
 433
 434 inline Key Position::get_key() const {
 435   return st->key;
 436 }
 437
 438 inline Key Position::get_exclusion_key() const {
 439   return st->key ^ zobExclusion;
 440 }
 441
 442 inline Key Position::get_pawn_key() const {
 443   return st->pawnKey;
 444 }
 445
 446 inline Key Position::get_material_key() const {
 447   return st->materialKey;
 448 }
 449
 450 inline Score Position::pst(Color c, PieceType pt, Square s) {
 451   return PieceSquareTable[make_piece(c, pt)][s];
 452 }
 453
 454 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
 455   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
 456 }
 457
 458 inline Score Position::value() const {
 459   return st->value;
 460 }
 461
 462 inline Value Position::non_pawn_material(Color c) const {
 463   return st->npMaterial[c];
 464 }
 465
 466 inline bool Position::move_is_passed_pawn_push(Move m) const {
 467
 468   Color c = side_to_move();
 469   return   piece_on(move_from(m)) == make_piece(c, PAWN)
 470         && pawn_is_passed(c, move_to(m));
 471 }
 472
 473 inline int Position::full_moves() const {
 474   return fullMoves;
 475 }
 476
 477 inline bool Position::opposite_colored_bishops() const {
 478
 479   return   piece_count(WHITE, BISHOP) == 1 && piece_count(BLACK, BISHOP) == 1
 480         && opposite_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
 481 }
 482
 483 inline bool Position::has_pawn_on_7th(Color c) const {
 484   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
 485 }
 486
 487 inline bool Position::is_chess960() const {
 488   return chess960;
 489 }
 490
 491 inline bool Position::move_is_capture_or_promotion(Move m) const {
 492
 493   assert(m != MOVE_NONE && m != MOVE_NULL);
 494   return move_is_special(m) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 495 }
 496
 497 inline bool Position::move_is_capture(Move m) const {
 498
 499   assert(m != MOVE_NONE && m != MOVE_NULL);
 500
 501   // Note that castle is coded as "king captures the rook"
 502   return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
 503 }
 504
 505 inline PieceType Position::captured_piece_type() const {
 506   return st->capturedType;
 507 }
 508
 509 inline int Position::thread() const {
 510   return threadID;
 511 }
 512
 513 #endif // !defined(POSITION_H_INCLUDED)