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
  21 #if !defined(POSITION_H_INCLUDED)
  22 #define POSITION_H_INCLUDED
  23
  24 // Disable some silly and noisy warning from MSVC compiler
  25 #if defined(_MSC_VER)
  26
  27 // Forcing value to bool 'true' or 'false' (performance warning)
  28 #pragma warning(disable: 4800)
  29
  30 // Conditional expression is constant
  31 #pragma warning(disable: 4127)
  32
  33
  34 #endif
  35
  36 ////
  37 //// Includes
  38 ////
  39
  40 #include "bitboard.h"
  41 #include "color.h"
  42 #include "direction.h"
  43 #include "move.h"
  44 #include "piece.h"
  45 #include "square.h"
  46 #include "value.h"
  47
  48
  49 ////
  50 //// Constants
  51 ////
  52
  53 /// FEN string for the initial position
  54 const std::string StartPosition = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
  55
  56 /// Maximum number of plies per game (220 should be enough, because the
  57 /// maximum search depth is 100, and during position setup we reset the
  58 /// move counter for every non-reversible move).
  59 const int MaxGameLength = 220;
  60
  61
  62 ////
  63 //// Types
  64 ////
  65
  66 /// struct checkInfo is initialized at c'tor time and keeps
  67 /// info used to detect if a move gives check.
  68
  69 struct CheckInfo {
  70
  71     CheckInfo(const Position&);
  72
  73     Bitboard dcCandidates;
  74     Bitboard checkSq[8];
  75     Square ksq;
  76 };
  77
  78 /// Castle rights, encoded as bit fields
  79
  80 enum CastleRights {
  81   NO_CASTLES  = 0,
  82   WHITE_OO    = 1,
  83   BLACK_OO    = 2,
  84   WHITE_OOO   = 4,
  85   BLACK_OOO   = 8,
  86   ALL_CASTLES = 15
  87 };
  88
  89 /// Game phase
  90 enum Phase {
  91   PHASE_ENDGAME = 0,
  92   PHASE_MIDGAME = 128
  93 };
  94
  95
  96 /// The StateInfo struct stores information we need to restore a Position
  97 /// object to its previous state when we retract a move. Whenever a move
  98 /// is made on the board (by calling Position::do_move), an StateInfo object
  99 /// must be passed as a parameter.
 100
 101 struct StateInfo {
 102   Key pawnKey, materialKey;
 103   int castleRights, rule50, gamePly, pliesFromNull;
 104   Square epSquare;
 105   Score value;
 106   Value npMaterial[2];
 107
 108   PieceType capture;
 109   Key key;
 110   Bitboard checkersBB;
 111   StateInfo* previous;
 112 };
 113
 114
 115 /// The position data structure. A position consists of the following data:
 116 ///
 117 ///    * For each piece type, a bitboard representing the squares occupied
 118 ///      by pieces of that type.
 119 ///    * For each color, a bitboard representing the squares occupied by
 120 ///      pieces of that color.
 121 ///    * A bitboard of all occupied squares.
 122 ///    * A bitboard of all checking pieces.
 123 ///    * A 64-entry array of pieces, indexed by the squares of the board.
 124 ///    * The current side to move.
 125 ///    * Information about the castling rights for both sides.
 126 ///    * The initial files of the kings and both pairs of rooks. This is
 127 ///      used to implement the Chess960 castling rules.
 128 ///    * The en passant square (which is SQ_NONE if no en passant capture is
 129 ///      possible).
 130 ///    * The squares of the kings for both sides.
 131 ///    * Hash keys for the position itself, the current pawn structure, and
 132 ///      the current material situation.
 133 ///    * Hash keys for all previous positions in the game for detecting
 134 ///      repetition draws.
 135 ///    * A counter for detecting 50 move rule draws.
 136
 137 class Position {
 138
 139   friend class MaterialInfo;
 140   friend class EndgameFunctions;
 141
 142 public:
 143   enum GamePhase {
 144       MidGame,
 145       EndGame
 146   };
 147
 148   // Constructors
 149   Position();
 150   explicit Position(const Position& pos);
 151   explicit Position(const std::string& fen);
 152
 153   // Text input/output
 154   void from_fen(const std::string& fen);
 155   const std::string to_fen() const;
 156   void print(Move m = MOVE_NONE) const;
 157
 158   // Copying
 159   void flipped_copy(const Position& pos);
 160
 161   // The piece on a given square
 162   Piece piece_on(Square s) const;
 163   PieceType type_of_piece_on(Square s) const;
 164   Color color_of_piece_on(Square s) const;
 165   bool square_is_empty(Square s) const;
 166   bool square_is_occupied(Square s) const;
 167   Value midgame_value_of_piece_on(Square s) const;
 168   Value endgame_value_of_piece_on(Square s) const;
 169
 170   // Side to move
 171   Color side_to_move() const;
 172
 173   // Bitboard representation of the position
 174   Bitboard empty_squares() const;
 175   Bitboard occupied_squares() const;
 176   Bitboard pieces_of_color(Color c) const;
 177   Bitboard pieces(PieceType pt) const;
 178   Bitboard pieces(PieceType pt, Color c) const;
 179   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 180   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
 181
 182   // Number of pieces of each color and type
 183   int piece_count(Color c, PieceType pt) const;
 184
 185   // The en passant square
 186   Square ep_square() const;
 187
 188   // Current king position for each color
 189   Square king_square(Color c) const;
 190
 191   // Castling rights
 192   bool can_castle_kingside(Color c) const;
 193   bool can_castle_queenside(Color c) const;
 194   bool can_castle(Color c) const;
 195   Square initial_kr_square(Color c) const;
 196   Square initial_qr_square(Color c) const;
 197
 198   // Bitboards for pinned pieces and discovered check candidates
 199   Bitboard discovered_check_candidates(Color c) const;
 200   Bitboard pinned_pieces(Color c) const;
 201
 202   // Checking pieces and under check information
 203   Bitboard checkers() const;
 204   bool is_check() const;
 205
 206   // Piece lists
 207   Square piece_list(Color c, PieceType pt, int index) const;
 208   const Square* piece_list_begin(Color c, PieceType pt) const;
 209
 210   // Information about attacks to or from a given square
 211   Bitboard attackers_to(Square s) const;
 212   Bitboard attacks_from(Piece p, Square s) const;
 213   template<PieceType> Bitboard attacks_from(Square s) const;
 214   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 215
 216   // Properties of moves
 217   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 218   bool pl_move_is_evasion(Move m, Bitboard pinned) const;
 219   bool move_is_check(Move m) const;
 220   bool move_is_check(Move m, const CheckInfo& ci) const;
 221   bool move_is_capture(Move m) const;
 222   bool move_is_capture_or_promotion(Move m) const;
 223   bool move_is_passed_pawn_push(Move m) const;
 224   bool move_attacks_square(Move m, Square s) const;
 225
 226   // Piece captured with previous moves
 227   PieceType captured_piece() const;
 228
 229   // Information about pawns
 230   bool pawn_is_passed(Color c, Square s) const;
 231
 232   // Weak squares
 233   bool square_is_weak(Square s, Color c) const;
 234
 235   // Doing and undoing moves
 236   void detach();
 237   void do_move(Move m, StateInfo& st);
 238   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 239   void undo_move(Move m);
 240   void do_null_move(StateInfo& st);
 241   void undo_null_move();
 242
 243   // Static exchange evaluation
 244   int see(Square from, Square to) const;
 245   int see(Move m) const;
 246   int see(Square to) const;
 247   int see_sign(Move m) const;
 248
 249   // Accessing hash keys
 250   Key get_key() const;
 251   Key get_exclusion_key() const;
 252   Key get_pawn_key() const;
 253   Key get_material_key() const;
 254
 255   // Incremental evaluation
 256   Score value() const;
 257   Value non_pawn_material(Color c) const;
 258   Score pst_delta(Piece piece, Square from, Square to) const;
 259
 260   // Game termination checks
 261   bool is_mate() const;
 262   bool is_draw() const;
 263
 264   // Check if one side threatens a mate in one
 265   bool has_mate_threat(Color c);
 266
 267   // Number of plies since the last non-reversible move
 268   int rule_50_counter() const;
 269
 270   // Other properties of the position
 271   bool opposite_colored_bishops() const;
 272   bool has_pawn_on_7th(Color c) const;
 273
 274   // Reset the gamePly variable to 0
 275   void reset_game_ply();
 276
 277   // Position consistency check, for debugging
 278   bool is_ok(int* failedStep = NULL) const;
 279
 280   // Static member functions
 281   static void init_zobrist();
 282   static void init_piece_square_tables();
 283
 284 private:
 285
 286   // Initialization helper functions (used while setting up a position)
 287   void clear();
 288   void put_piece(Piece p, Square s);
 289   void allow_oo(Color c);
 290   void allow_ooo(Color c);
 291
 292   // Helper functions for doing and undoing moves
 293   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 294   void do_castle_move(Move m);
 295   void undo_castle_move(Move m);
 296   void find_checkers();
 297
 298   template<bool FindPinned>
 299   Bitboard hidden_checkers(Color c) const;
 300
 301   // Computing hash keys from scratch (for initialization and debugging)
 302   Key compute_key() const;
 303   Key compute_pawn_key() const;
 304   Key compute_material_key() const;
 305
 306   // Computing incremental evaluation scores and material counts
 307   Score pst(Color c, PieceType pt, Square s) const;
 308   Score compute_value() const;
 309   Value compute_non_pawn_material(Color c) const;
 310
 311   // Board
 312   Piece board[64];
 313
 314   // Bitboards
 315   Bitboard byTypeBB[8], byColorBB[2];
 316
 317   // Piece counts
 318   int pieceCount[2][8]; // [color][pieceType]
 319
 320   // Piece lists
 321   Square pieceList[2][8][16]; // [color][pieceType][index]
 322   int index[64]; // [square]
 323
 324   // Other info
 325   Color sideToMove;
 326   Key history[MaxGameLength];
 327   int castleRightsMask[64];
 328   StateInfo startState;
 329   File initialKFile, initialKRFile, initialQRFile;
 330   StateInfo* st;
 331
 332   // Static variables
 333   static Key zobrist[2][8][64];
 334   static Key zobEp[64];
 335   static Key zobCastle[16];
 336   static Key zobSideToMove;
 337   static Score PieceSquareTable[16][64];
 338   static Key zobExclusion;
 339 };
 340
 341
 342 ////
 343 //// Inline functions
 344 ////
 345
 346 inline Piece Position::piece_on(Square s) const {
 347   return board[s];
 348 }
 349
 350 inline Color Position::color_of_piece_on(Square s) const {
 351   return color_of_piece(piece_on(s));
 352 }
 353
 354 inline PieceType Position::type_of_piece_on(Square s) const {
 355   return type_of_piece(piece_on(s));
 356 }
 357
 358 inline bool Position::square_is_empty(Square s) const {
 359   return piece_on(s) == EMPTY;
 360 }
 361
 362 inline bool Position::square_is_occupied(Square s) const {
 363   return !square_is_empty(s);
 364 }
 365
 366 inline Value Position::midgame_value_of_piece_on(Square s) const {
 367   return piece_value_midgame(piece_on(s));
 368 }
 369
 370 inline Value Position::endgame_value_of_piece_on(Square s) const {
 371   return piece_value_endgame(piece_on(s));
 372 }
 373
 374 inline Color Position::side_to_move() const {
 375   return sideToMove;
 376 }
 377
 378 inline Bitboard Position::occupied_squares() const {
 379   return byTypeBB[0];
 380 }
 381
 382 inline Bitboard Position::empty_squares() const {
 383   return ~(occupied_squares());
 384 }
 385
 386 inline Bitboard Position::pieces_of_color(Color c) const {
 387   return byColorBB[c];
 388 }
 389
 390 inline Bitboard Position::pieces(PieceType pt) const {
 391   return byTypeBB[pt];
 392 }
 393
 394 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 395   return byTypeBB[pt] & byColorBB[c];
 396 }
 397
 398 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 399   return byTypeBB[pt1] | byTypeBB[pt2];
 400 }
 401
 402 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 403   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 404 }
 405
 406 inline int Position::piece_count(Color c, PieceType pt) const {
 407   return pieceCount[c][pt];
 408 }
 409
 410 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
 411   return pieceList[c][pt][idx];
 412 }
 413
 414 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
 415   return pieceList[c][pt];
 416 }
 417
 418 inline Square Position::ep_square() const {
 419   return st->epSquare;
 420 }
 421
 422 inline Square Position::king_square(Color c) const {
 423   return pieceList[c][KING][0];
 424 }
 425
 426 inline bool Position::can_castle_kingside(Color side) const {
 427   return st->castleRights & (1+int(side));
 428 }
 429
 430 inline bool Position::can_castle_queenside(Color side) const {
 431   return st->castleRights & (4+4*int(side));
 432 }
 433
 434 inline bool Position::can_castle(Color side) const {
 435   return can_castle_kingside(side) || can_castle_queenside(side);
 436 }
 437
 438 inline Square Position::initial_kr_square(Color c) const {
 439   return relative_square(c, make_square(initialKRFile, RANK_1));
 440 }
 441
 442 inline Square Position::initial_qr_square(Color c) const {
 443   return relative_square(c, make_square(initialQRFile, RANK_1));
 444 }
 445
 446 template<>
 447 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 448   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
 449 }
 450
 451 template<PieceType Piece> // Knight and King and white pawns
 452 inline Bitboard Position::attacks_from(Square s) const {
 453   return StepAttackBB[Piece][s];
 454 }
 455
 456 template<>
 457 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 458   return bishop_attacks_bb(s, occupied_squares());
 459 }
 460
 461 template<>
 462 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 463   return rook_attacks_bb(s, occupied_squares());
 464 }
 465
 466 template<>
 467 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 468   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 469 }
 470
 471 inline Bitboard Position::checkers() const {
 472   return st->checkersBB;
 473 }
 474
 475 inline bool Position::is_check() const {
 476   return st->checkersBB != EmptyBoardBB;
 477 }
 478
 479 inline bool Position::pawn_is_passed(Color c, Square s) const {
 480   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 481 }
 482
 483 inline bool Position::square_is_weak(Square s, Color c) const {
 484   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
 485 }
 486
 487 inline Key Position::get_key() const {
 488   return st->key;
 489 }
 490
 491 inline Key Position::get_exclusion_key() const {
 492   return st->key ^ zobExclusion;
 493 }
 494
 495 inline Key Position::get_pawn_key() const {
 496   return st->pawnKey;
 497 }
 498
 499 inline Key Position::get_material_key() const {
 500   return st->materialKey;
 501 }
 502
 503 inline Score Position::pst(Color c, PieceType pt, Square s) const {
 504   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
 505 }
 506
 507 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
 508   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
 509 }
 510
 511 inline Score Position::value() const {
 512   return st->value;
 513 }
 514
 515 inline Value Position::non_pawn_material(Color c) const {
 516   return st->npMaterial[c];
 517 }
 518
 519 inline bool Position::move_is_passed_pawn_push(Move m) const {
 520
 521   Color c = side_to_move();
 522   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
 523         && pawn_is_passed(c, move_to(m));
 524 }
 525
 526 inline int Position::rule_50_counter() const {
 527
 528   return st->rule50;
 529 }
 530
 531 inline bool Position::opposite_colored_bishops() const {
 532
 533   return   piece_count(WHITE, BISHOP) == 1
 534         && piece_count(BLACK, BISHOP) == 1
 535         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
 536 }
 537
 538 inline bool Position::has_pawn_on_7th(Color c) const {
 539
 540   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
 541 }
 542
 543 inline bool Position::move_is_capture(Move m) const {
 544
 545   // Move must not be MOVE_NONE !
 546   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 547 }
 548
 549 inline bool Position::move_is_capture_or_promotion(Move m) const {
 550
 551   // Move must not be MOVE_NONE !
 552   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 553 }
 554
 555 inline PieceType Position::captured_piece() const {
 556   return st->capture;
 557 }
 558
 559 #endif // !defined(POSITION_H_INCLUDED)