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