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 StartPositionFEN = "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     explicit 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   Position(); // No default or copy c'tor allowed
 143   Position(const Position& pos);
 144
 145 public:
 146   enum GamePhase {
 147       MidGame,
 148       EndGame
 149   };
 150
 151   // Constructors
 152   explicit Position(int threadID);
 153   Position(const Position& pos, int threadID);
 154   Position(const std::string& fen, int threadID);
 155
 156   // Text input/output
 157   void from_fen(const std::string& fen);
 158   const std::string to_fen() const;
 159   void print(Move m = MOVE_NONE) const;
 160
 161   // Copying
 162   void flipped_copy(const Position& pos);
 163
 164   // The piece on a given square
 165   Piece piece_on(Square s) const;
 166   PieceType type_of_piece_on(Square s) const;
 167   Color color_of_piece_on(Square s) const;
 168   bool square_is_empty(Square s) const;
 169   bool square_is_occupied(Square s) const;
 170   Value midgame_value_of_piece_on(Square s) const;
 171   Value endgame_value_of_piece_on(Square s) const;
 172
 173   // Side to move
 174   Color side_to_move() const;
 175
 176   // Bitboard representation of the position
 177   Bitboard empty_squares() const;
 178   Bitboard occupied_squares() const;
 179   Bitboard pieces_of_color(Color c) const;
 180   Bitboard pieces(PieceType pt) const;
 181   Bitboard pieces(PieceType pt, Color c) const;
 182   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 183   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
 184
 185   // Number of pieces of each color and type
 186   int piece_count(Color c, PieceType pt) const;
 187
 188   // The en passant square
 189   Square ep_square() const;
 190
 191   // Current king position for each color
 192   Square king_square(Color c) const;
 193
 194   // Castling rights
 195   bool can_castle_kingside(Color c) const;
 196   bool can_castle_queenside(Color c) const;
 197   bool can_castle(Color c) const;
 198   Square initial_kr_square(Color c) const;
 199   Square initial_qr_square(Color c) const;
 200
 201   // Bitboards for pinned pieces and discovered check candidates
 202   Bitboard discovered_check_candidates(Color c) const;
 203   Bitboard pinned_pieces(Color c) const;
 204
 205   // Checking pieces and under check information
 206   Bitboard checkers() const;
 207   bool is_check() const;
 208
 209   // Piece lists
 210   Square piece_list(Color c, PieceType pt, int index) const;
 211   const Square* piece_list_begin(Color c, PieceType pt) const;
 212
 213   // Information about attacks to or from a given square
 214   Bitboard attackers_to(Square s) const;
 215   Bitboard attacks_from(Piece p, Square s) const;
 216   template<PieceType> Bitboard attacks_from(Square s) const;
 217   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 218
 219   // Properties of moves
 220   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 221   bool pl_move_is_evasion(Move m, Bitboard pinned) const;
 222   bool move_is_check(Move m) const;
 223   bool move_is_check(Move m, const CheckInfo& ci) const;
 224   bool move_is_capture(Move m) const;
 225   bool move_is_capture_or_promotion(Move m) const;
 226   bool move_is_passed_pawn_push(Move m) const;
 227   bool move_attacks_square(Move m, Square s) const;
 228
 229   // Piece captured with previous moves
 230   PieceType captured_piece() const;
 231
 232   // Information about pawns
 233   bool pawn_is_passed(Color c, Square s) const;
 234
 235   // Weak squares
 236   bool square_is_weak(Square s, Color c) const;
 237
 238   // Doing and undoing moves
 239   void detach();
 240   void do_move(Move m, StateInfo& st);
 241   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 242   void undo_move(Move m);
 243   void do_null_move(StateInfo& st);
 244   void undo_null_move();
 245
 246   // Static exchange evaluation
 247   int see(Square from, Square to) const;
 248   int see(Move m) const;
 249   int see(Square to) const;
 250   int see_sign(Move m) const;
 251
 252   // Accessing hash keys
 253   Key get_key() const;
 254   Key get_exclusion_key() const;
 255   Key get_pawn_key() const;
 256   Key get_material_key() const;
 257
 258   // Incremental evaluation
 259   Score value() const;
 260   Value non_pawn_material(Color c) const;
 261   static Score pst_delta(Piece piece, Square from, Square to);
 262
 263   // Game termination checks
 264   bool is_mate() const;
 265   bool is_draw() const;
 266
 267   // Check if one side threatens a mate in one
 268   bool has_mate_threat(Color c);
 269
 270   // Number of plies since the last non-reversible move
 271   int rule_50_counter() const;
 272
 273   int startpos_ply_counter() const;
 274
 275   // Other properties of the position
 276   bool opposite_colored_bishops() const;
 277   bool has_pawn_on_7th(Color c) const;
 278
 279   // Current thread ID searching on the position
 280   int thread() const;
 281
 282   // Reset the gamePly variable to 0
 283   void reset_game_ply();
 284
 285   void inc_startpos_ply_counter();
 286
 287   // Position consistency check, for debugging
 288   bool is_ok(int* failedStep = NULL) const;
 289
 290   // Static member functions
 291   static void init_zobrist();
 292   static void init_piece_square_tables();
 293
 294 private:
 295
 296   // Initialization helper functions (used while setting up a position)
 297   void clear();
 298   void put_piece(Piece p, Square s);
 299   void allow_oo(Color c);
 300   void allow_ooo(Color c);
 301   bool set_castling_rights(char token);
 302
 303   // Helper functions for doing and undoing moves
 304   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 305   void do_castle_move(Move m);
 306   void undo_castle_move(Move m);
 307   void find_checkers();
 308
 309   template<bool FindPinned>
 310   Bitboard hidden_checkers(Color c) const;
 311
 312   // Computing hash keys from scratch (for initialization and debugging)
 313   Key compute_key() const;
 314   Key compute_pawn_key() const;
 315   Key compute_material_key() const;
 316
 317   // Computing incremental evaluation scores and material counts
 318   static Score pst(Color c, PieceType pt, Square s);
 319   Score compute_value() const;
 320   Value compute_non_pawn_material(Color c) const;
 321
 322   // Board
 323   Piece board[64];
 324
 325   // Bitboards
 326   Bitboard byTypeBB[8], byColorBB[2];
 327
 328   // Piece counts
 329   int pieceCount[2][8]; // [color][pieceType]
 330
 331   // Piece lists
 332   Square pieceList[2][8][16]; // [color][pieceType][index]
 333   int index[64]; // [square]
 334
 335   // Other info
 336   Color sideToMove;
 337   Key history[MaxGameLength];
 338   int castleRightsMask[64];
 339   StateInfo startState;
 340   File initialKFile, initialKRFile, initialQRFile;
 341   int startPosPlyCounter;
 342   int threadID;
 343   StateInfo* st;
 344
 345   // Static variables
 346   static Key zobrist[2][8][64];
 347   static Key zobEp[64];
 348   static Key zobCastle[16];
 349   static Key zobSideToMove;
 350   static Score PieceSquareTable[16][64];
 351   static Key zobExclusion;
 352 };
 353
 354
 355 ////
 356 //// Inline functions
 357 ////
 358
 359 inline Piece Position::piece_on(Square s) const {
 360   return board[s];
 361 }
 362
 363 inline Color Position::color_of_piece_on(Square s) const {
 364   return color_of_piece(piece_on(s));
 365 }
 366
 367 inline PieceType Position::type_of_piece_on(Square s) const {
 368   return type_of_piece(piece_on(s));
 369 }
 370
 371 inline bool Position::square_is_empty(Square s) const {
 372   return piece_on(s) == NO_PIECE;
 373 }
 374
 375 inline bool Position::square_is_occupied(Square s) const {
 376   return !square_is_empty(s);
 377 }
 378
 379 inline Value Position::midgame_value_of_piece_on(Square s) const {
 380   return piece_value_midgame(piece_on(s));
 381 }
 382
 383 inline Value Position::endgame_value_of_piece_on(Square s) const {
 384   return piece_value_endgame(piece_on(s));
 385 }
 386
 387 inline Color Position::side_to_move() const {
 388   return sideToMove;
 389 }
 390
 391 inline Bitboard Position::occupied_squares() const {
 392   return byTypeBB[0];
 393 }
 394
 395 inline Bitboard Position::empty_squares() const {
 396   return ~(occupied_squares());
 397 }
 398
 399 inline Bitboard Position::pieces_of_color(Color c) const {
 400   return byColorBB[c];
 401 }
 402
 403 inline Bitboard Position::pieces(PieceType pt) const {
 404   return byTypeBB[pt];
 405 }
 406
 407 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 408   return byTypeBB[pt] & byColorBB[c];
 409 }
 410
 411 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 412   return byTypeBB[pt1] | byTypeBB[pt2];
 413 }
 414
 415 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 416   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 417 }
 418
 419 inline int Position::piece_count(Color c, PieceType pt) const {
 420   return pieceCount[c][pt];
 421 }
 422
 423 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
 424   return pieceList[c][pt][idx];
 425 }
 426
 427 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
 428   return pieceList[c][pt];
 429 }
 430
 431 inline Square Position::ep_square() const {
 432   return st->epSquare;
 433 }
 434
 435 inline Square Position::king_square(Color c) const {
 436   return pieceList[c][KING][0];
 437 }
 438
 439 inline bool Position::can_castle_kingside(Color side) const {
 440   return st->castleRights & (1+int(side));
 441 }
 442
 443 inline bool Position::can_castle_queenside(Color side) const {
 444   return st->castleRights & (4+4*int(side));
 445 }
 446
 447 inline bool Position::can_castle(Color side) const {
 448   return can_castle_kingside(side) || can_castle_queenside(side);
 449 }
 450
 451 inline Square Position::initial_kr_square(Color c) const {
 452   return relative_square(c, make_square(initialKRFile, RANK_1));
 453 }
 454
 455 inline Square Position::initial_qr_square(Color c) const {
 456   return relative_square(c, make_square(initialQRFile, RANK_1));
 457 }
 458
 459 template<>
 460 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 461   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
 462 }
 463
 464 template<PieceType Piece> // Knight and King and white pawns
 465 inline Bitboard Position::attacks_from(Square s) const {
 466   return StepAttackBB[Piece][s];
 467 }
 468
 469 template<>
 470 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 471   return bishop_attacks_bb(s, occupied_squares());
 472 }
 473
 474 template<>
 475 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 476   return rook_attacks_bb(s, occupied_squares());
 477 }
 478
 479 template<>
 480 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 481   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 482 }
 483
 484 inline Bitboard Position::checkers() const {
 485   return st->checkersBB;
 486 }
 487
 488 inline bool Position::is_check() const {
 489   return st->checkersBB != EmptyBoardBB;
 490 }
 491
 492 inline bool Position::pawn_is_passed(Color c, Square s) const {
 493   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 494 }
 495
 496 inline bool Position::square_is_weak(Square s, Color c) const {
 497   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
 498 }
 499
 500 inline Key Position::get_key() const {
 501   return st->key;
 502 }
 503
 504 inline Key Position::get_exclusion_key() const {
 505   return st->key ^ zobExclusion;
 506 }
 507
 508 inline Key Position::get_pawn_key() const {
 509   return st->pawnKey;
 510 }
 511
 512 inline Key Position::get_material_key() const {
 513   return st->materialKey;
 514 }
 515
 516 inline Score Position::pst(Color c, PieceType pt, Square s) {
 517   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
 518 }
 519
 520 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
 521   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
 522 }
 523
 524 inline Score Position::value() const {
 525   return st->value;
 526 }
 527
 528 inline Value Position::non_pawn_material(Color c) const {
 529   return st->npMaterial[c];
 530 }
 531
 532 inline bool Position::move_is_passed_pawn_push(Move m) const {
 533
 534   Color c = side_to_move();
 535   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
 536         && pawn_is_passed(c, move_to(m));
 537 }
 538
 539 inline int Position::rule_50_counter() const {
 540
 541   return st->rule50;
 542 }
 543
 544 inline int Position::startpos_ply_counter() const {
 545
 546   return startPosPlyCounter;
 547 }
 548
 549 inline bool Position::opposite_colored_bishops() const {
 550
 551   return   piece_count(WHITE, BISHOP) == 1
 552         && piece_count(BLACK, BISHOP) == 1
 553         && !same_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
 554 }
 555
 556 inline bool Position::has_pawn_on_7th(Color c) const {
 557
 558   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
 559 }
 560
 561 inline bool Position::move_is_capture(Move m) const {
 562
 563   // Move must not be MOVE_NONE !
 564   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 565 }
 566
 567 inline bool Position::move_is_capture_or_promotion(Move m) const {
 568
 569   // Move must not be MOVE_NONE !
 570   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 571 }
 572
 573 inline PieceType Position::captured_piece() const {
 574   return st->capture;
 575 }
 576
 577 inline int Position::thread() const {
 578   return threadID;
 579 }
 580
 581 #endif // !defined(POSITION_H_INCLUDED)