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 /// Maximum number of plies per game (220 should be enough, because the
  54 /// maximum search depth is 100, and during position setup we reset the
  55 /// move counter for every non-reversible move).
  56 const int MaxGameLength = 220;
  57
  58
  59 ////
  60 //// Types
  61 ////
  62
  63 /// struct checkInfo is initialized at c'tor time and keeps
  64 /// info used to detect if a move gives check.
  65
  66 struct CheckInfo {
  67
  68     explicit CheckInfo(const Position&);
  69
  70     Bitboard dcCandidates;
  71     Bitboard checkSq[8];
  72     Square ksq;
  73 };
  74
  75 /// Castle rights, encoded as bit fields
  76
  77 enum CastleRights {
  78   CASTLES_NONE = 0,
  79   WHITE_OO     = 1,
  80   BLACK_OO     = 2,
  81   WHITE_OOO    = 4,
  82   BLACK_OOO    = 8,
  83   ALL_CASTLES  = 15
  84 };
  85
  86 /// Game phase
  87 enum Phase {
  88   PHASE_ENDGAME = 0,
  89   PHASE_MIDGAME = 128
  90 };
  91
  92
  93 /// The StateInfo struct stores information we need to restore a Position
  94 /// object to its previous state when we retract a move. Whenever a move
  95 /// is made on the board (by calling Position::do_move), an StateInfo object
  96 /// must be passed as a parameter.
  97
  98 struct StateInfo {
  99   Key pawnKey, materialKey;
 100   int castleRights, rule50, gamePly, pliesFromNull;
 101   Square epSquare;
 102   Score value;
 103   Value npMaterial[2];
 104
 105   PieceType capturedType;
 106   Key key;
 107   Bitboard checkersBB;
 108   StateInfo* previous;
 109 };
 110
 111
 112 /// The position data structure. A position consists of the following data:
 113 ///
 114 ///    * For each piece type, a bitboard representing the squares occupied
 115 ///      by pieces of that type.
 116 ///    * For each color, a bitboard representing the squares occupied by
 117 ///      pieces of that color.
 118 ///    * A bitboard of all occupied squares.
 119 ///    * A bitboard of all checking pieces.
 120 ///    * A 64-entry array of pieces, indexed by the squares of the board.
 121 ///    * The current side to move.
 122 ///    * Information about the castling rights for both sides.
 123 ///    * The initial files of the kings and both pairs of rooks. This is
 124 ///      used to implement the Chess960 castling rules.
 125 ///    * The en passant square (which is SQ_NONE if no en passant capture is
 126 ///      possible).
 127 ///    * The squares of the kings for both sides.
 128 ///    * Hash keys for the position itself, the current pawn structure, and
 129 ///      the current material situation.
 130 ///    * Hash keys for all previous positions in the game for detecting
 131 ///      repetition draws.
 132 ///    * A counter for detecting 50 move rule draws.
 133
 134 class Position {
 135
 136   friend class MaterialInfo;
 137   friend class EndgameFunctions;
 138
 139   Position(); // No default or copy c'tor allowed
 140   Position(const Position& pos);
 141
 142 public:
 143   enum GamePhase {
 144       MidGame,
 145       EndGame
 146   };
 147
 148   // Constructors
 149   explicit Position(int threadID);
 150   Position(const Position& pos, int threadID);
 151   Position(const std::string& fen, int threadID);
 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_type() 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   static Score pst_delta(Piece piece, Square from, Square to);
 259
 260   // Game termination checks
 261   bool is_mate() const;
 262   bool is_draw() const;
 263
 264   // Check if side to move could be mated in one
 265   bool has_mate_threat();
 266
 267   // Number of plies since the last non-reversible move
 268   int rule_50_counter() const;
 269
 270   int startpos_ply_counter() const;
 271
 272   // Other properties of the position
 273   bool opposite_colored_bishops() const;
 274   bool has_pawn_on_7th(Color c) const;
 275   bool is_chess960() const;
 276
 277   // Current thread ID searching on the position
 278   int thread() const;
 279
 280   // Reset the gamePly variable to 0
 281   void reset_game_ply();
 282
 283   void inc_startpos_ply_counter();
 284
 285   // Position consistency check, for debugging
 286   bool is_ok(int* failedStep = NULL) const;
 287
 288   // Static member functions
 289   static void init_zobrist();
 290   static void init_piece_square_tables();
 291
 292 private:
 293
 294   // Initialization helper functions (used while setting up a position)
 295   void clear();
 296   void put_piece(Piece p, Square s);
 297   void allow_oo(Color c);
 298   void allow_ooo(Color c);
 299   bool set_castling_rights(char token);
 300
 301   // Helper functions for doing and undoing moves
 302   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 303   void do_castle_move(Move m);
 304   void undo_castle_move(Move m);
 305   void find_checkers();
 306
 307   template<bool FindPinned>
 308   Bitboard hidden_checkers(Color c) const;
 309
 310   // Computing hash keys from scratch (for initialization and debugging)
 311   Key compute_key() const;
 312   Key compute_pawn_key() const;
 313   Key compute_material_key() const;
 314
 315   // Computing incremental evaluation scores and material counts
 316   static Score pst(Color c, PieceType pt, Square s);
 317   Score compute_value() const;
 318   Value compute_non_pawn_material(Color c) const;
 319
 320   // Board
 321   Piece board[64];
 322
 323   // Bitboards
 324   Bitboard byTypeBB[8], byColorBB[2];
 325
 326   // Piece counts
 327   int pieceCount[2][8]; // [color][pieceType]
 328
 329   // Piece lists
 330   Square pieceList[2][8][16]; // [color][pieceType][index]
 331   int index[64]; // [square]
 332
 333   // Other info
 334   Color sideToMove;
 335   Key history[MaxGameLength];
 336   int castleRightsMask[64];
 337   StateInfo startState;
 338   File initialKFile, initialKRFile, initialQRFile;
 339   bool isChess960;
 340   int startPosPlyCounter;
 341   int threadID;
 342   StateInfo* st;
 343
 344   // Static variables
 345   static Key zobrist[2][8][64];
 346   static Key zobEp[64];
 347   static Key zobCastle[16];
 348   static Key zobSideToMove;
 349   static Score PieceSquareTable[16][64];
 350   static Key zobExclusion;
 351 };
 352
 353
 354 ////
 355 //// Inline functions
 356 ////
 357
 358 inline Piece Position::piece_on(Square s) const {
 359   return board[s];
 360 }
 361
 362 inline Color Position::color_of_piece_on(Square s) const {
 363   return color_of_piece(piece_on(s));
 364 }
 365
 366 inline PieceType Position::type_of_piece_on(Square s) const {
 367   return type_of_piece(piece_on(s));
 368 }
 369
 370 inline bool Position::square_is_empty(Square s) const {
 371   return piece_on(s) == PIECE_NONE;
 372 }
 373
 374 inline bool Position::square_is_occupied(Square s) const {
 375   return !square_is_empty(s);
 376 }
 377
 378 inline Value Position::midgame_value_of_piece_on(Square s) const {
 379   return PieceValueMidgame[piece_on(s)];
 380 }
 381
 382 inline Value Position::endgame_value_of_piece_on(Square s) const {
 383   return PieceValueEndgame[piece_on(s)];
 384 }
 385
 386 inline Color Position::side_to_move() const {
 387   return sideToMove;
 388 }
 389
 390 inline Bitboard Position::occupied_squares() const {
 391   return byTypeBB[0];
 392 }
 393
 394 inline Bitboard Position::empty_squares() const {
 395   return ~(occupied_squares());
 396 }
 397
 398 inline Bitboard Position::pieces_of_color(Color c) const {
 399   return byColorBB[c];
 400 }
 401
 402 inline Bitboard Position::pieces(PieceType pt) const {
 403   return byTypeBB[pt];
 404 }
 405
 406 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 407   return byTypeBB[pt] & byColorBB[c];
 408 }
 409
 410 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 411   return byTypeBB[pt1] | byTypeBB[pt2];
 412 }
 413
 414 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 415   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 416 }
 417
 418 inline int Position::piece_count(Color c, PieceType pt) const {
 419   return pieceCount[c][pt];
 420 }
 421
 422 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
 423   return pieceList[c][pt][idx];
 424 }
 425
 426 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
 427   return pieceList[c][pt];
 428 }
 429
 430 inline Square Position::ep_square() const {
 431   return st->epSquare;
 432 }
 433
 434 inline Square Position::king_square(Color c) const {
 435   return pieceList[c][KING][0];
 436 }
 437
 438 inline bool Position::can_castle_kingside(Color side) const {
 439   return st->castleRights & (1+int(side));
 440 }
 441
 442 inline bool Position::can_castle_queenside(Color side) const {
 443   return st->castleRights & (4+4*int(side));
 444 }
 445
 446 inline bool Position::can_castle(Color side) const {
 447   return can_castle_kingside(side) || can_castle_queenside(side);
 448 }
 449
 450 inline Square Position::initial_kr_square(Color c) const {
 451   return relative_square(c, make_square(initialKRFile, RANK_1));
 452 }
 453
 454 inline Square Position::initial_qr_square(Color c) const {
 455   return relative_square(c, make_square(initialQRFile, RANK_1));
 456 }
 457
 458 template<>
 459 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 460   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
 461 }
 462
 463 template<PieceType Piece> // Knight and King and white pawns
 464 inline Bitboard Position::attacks_from(Square s) const {
 465   return StepAttackBB[Piece][s];
 466 }
 467
 468 template<>
 469 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 470   return bishop_attacks_bb(s, occupied_squares());
 471 }
 472
 473 template<>
 474 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 475   return rook_attacks_bb(s, occupied_squares());
 476 }
 477
 478 template<>
 479 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 480   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 481 }
 482
 483 inline Bitboard Position::checkers() const {
 484   return st->checkersBB;
 485 }
 486
 487 inline bool Position::is_check() const {
 488   return st->checkersBB != EmptyBoardBB;
 489 }
 490
 491 inline bool Position::pawn_is_passed(Color c, Square s) const {
 492   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 493 }
 494
 495 inline bool Position::square_is_weak(Square s, Color c) const {
 496   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
 497 }
 498
 499 inline Key Position::get_key() const {
 500   return st->key;
 501 }
 502
 503 inline Key Position::get_exclusion_key() const {
 504   return st->key ^ zobExclusion;
 505 }
 506
 507 inline Key Position::get_pawn_key() const {
 508   return st->pawnKey;
 509 }
 510
 511 inline Key Position::get_material_key() const {
 512   return st->materialKey;
 513 }
 514
 515 inline Score Position::pst(Color c, PieceType pt, Square s) {
 516   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
 517 }
 518
 519 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
 520   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
 521 }
 522
 523 inline Score Position::value() const {
 524   return st->value;
 525 }
 526
 527 inline Value Position::non_pawn_material(Color c) const {
 528   return st->npMaterial[c];
 529 }
 530
 531 inline bool Position::move_is_passed_pawn_push(Move m) const {
 532
 533   Color c = side_to_move();
 534   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
 535         && pawn_is_passed(c, move_to(m));
 536 }
 537
 538 inline int Position::rule_50_counter() const {
 539
 540   return st->rule50;
 541 }
 542
 543 inline int Position::startpos_ply_counter() const {
 544
 545   return startPosPlyCounter;
 546 }
 547
 548 inline bool Position::opposite_colored_bishops() const {
 549
 550   return   piece_count(WHITE, BISHOP) == 1
 551         && piece_count(BLACK, BISHOP) == 1
 552         && !same_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
 553 }
 554
 555 inline bool Position::has_pawn_on_7th(Color c) const {
 556
 557   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
 558 }
 559
 560 inline bool Position::is_chess960() const {
 561
 562   return isChess960;
 563 }
 564
 565 inline bool Position::move_is_capture(Move m) const {
 566
 567   // Move must not be MOVE_NONE !
 568   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 569 }
 570
 571 inline bool Position::move_is_capture_or_promotion(Move m) const {
 572
 573   // Move must not be MOVE_NONE !
 574   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 575 }
 576
 577 inline PieceType Position::captured_piece_type() const {
 578   return st->capturedType;
 579 }
 580
 581 inline int Position::thread() const {
 582   return threadID;
 583 }
 584
 585 #endif // !defined(POSITION_H_INCLUDED)