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, bool isChess960, int threadID);
 138
 139   // Text input/output
 140   void from_fen(const std::string& fen, bool isChess960);
 141   const std::string to_fen() 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   bool is_chess960() const;
 262
 263   // Current thread ID searching on the position
 264   int thread() const;
 265
 266   // Reset the gamePly variable to 0
 267   void reset_game_ply();
 268   void inc_startpos_ply_counter();
 269   int64_t nodes_searched() const;
 270   void set_nodes_searched(int64_t n);
 271
 272   // Position consistency check, for debugging
 273   bool is_ok(int* failedStep = NULL) const;
 274
 275   // Static member functions
 276   static void init_zobrist();
 277   static void init_piece_square_tables();
 278
 279 private:
 280
 281   // Initialization helper functions (used while setting up a position)
 282   void clear();
 283   void put_piece(Piece p, Square s);
 284   void do_allow_oo(Color c);
 285   void do_allow_ooo(Color c);
 286   bool set_castling_rights(char token);
 287
 288   // Helper functions for doing and undoing moves
 289   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 290   void do_castle_move(Move m);
 291   void undo_castle_move(Move m);
 292   void find_checkers();
 293
 294   template<bool FindPinned>
 295   Bitboard hidden_checkers(Color c) const;
 296
 297   // Computing hash keys from scratch (for initialization and debugging)
 298   Key compute_key() const;
 299   Key compute_pawn_key() const;
 300   Key compute_material_key() const;
 301
 302   // Computing incremental evaluation scores and material counts
 303   static Score pst(Color c, PieceType pt, Square s);
 304   Score compute_value() const;
 305   Value compute_non_pawn_material(Color c) const;
 306
 307   // Board
 308   Piece board[64];
 309
 310   // Bitboards
 311   Bitboard byTypeBB[8], byColorBB[2];
 312
 313   // Piece counts
 314   int pieceCount[2][8]; // [color][pieceType]
 315
 316   // Piece lists
 317   Square pieceList[2][8][16]; // [color][pieceType][index]
 318   int index[64]; // [square]
 319
 320   // Other info
 321   Color sideToMove;
 322   Key history[MaxGameLength];
 323   int castleRightsMask[64];
 324   StateInfo startState;
 325   File initialKFile, initialKRFile, initialQRFile;
 326   bool isChess960;
 327   int startPosPlyCounter;
 328   int threadID;
 329   int64_t nodes;
 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   static const Value seeValues[8];
 340   static const Value PieceValueMidgame[17];
 341   static const Value PieceValueEndgame[17];
 342 };
 343
 344
 345 ////
 346 //// Inline functions
 347 ////
 348
 349 inline int64_t Position::nodes_searched() const {
 350   return nodes;
 351 }
 352
 353 inline void Position::set_nodes_searched(int64_t n) {
 354   nodes = n;
 355 }
 356
 357 inline Piece Position::piece_on(Square s) const {
 358   return board[s];
 359 }
 360
 361 inline Color Position::color_of_piece_on(Square s) const {
 362   return color_of_piece(piece_on(s));
 363 }
 364
 365 inline PieceType Position::type_of_piece_on(Square s) const {
 366   return type_of_piece(piece_on(s));
 367 }
 368
 369 inline bool Position::square_is_empty(Square s) const {
 370   return piece_on(s) == PIECE_NONE;
 371 }
 372
 373 inline bool Position::square_is_occupied(Square s) const {
 374   return !square_is_empty(s);
 375 }
 376
 377 inline Value Position::midgame_value_of_piece_on(Square s) const {
 378   return PieceValueMidgame[piece_on(s)];
 379 }
 380
 381 inline Value Position::endgame_value_of_piece_on(Square s) const {
 382   return PieceValueEndgame[piece_on(s)];
 383 }
 384
 385 inline Color Position::side_to_move() const {
 386   return sideToMove;
 387 }
 388
 389 inline Bitboard Position::occupied_squares() const {
 390   return byTypeBB[0];
 391 }
 392
 393 inline Bitboard Position::empty_squares() const {
 394   return ~occupied_squares();
 395 }
 396
 397 inline Bitboard Position::pieces_of_color(Color c) const {
 398   return byColorBB[c];
 399 }
 400
 401 inline Bitboard Position::pieces(PieceType pt) const {
 402   return byTypeBB[pt];
 403 }
 404
 405 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 406   return byTypeBB[pt] & byColorBB[c];
 407 }
 408
 409 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 410   return byTypeBB[pt1] | byTypeBB[pt2];
 411 }
 412
 413 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 414   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 415 }
 416
 417 inline int Position::piece_count(Color c, PieceType pt) const {
 418   return pieceCount[c][pt];
 419 }
 420
 421 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
 422   return pieceList[c][pt][idx];
 423 }
 424
 425 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
 426   return pieceList[c][pt];
 427 }
 428
 429 inline Square Position::ep_square() const {
 430   return st->epSquare;
 431 }
 432
 433 inline Square Position::king_square(Color c) const {
 434   return pieceList[c][KING][0];
 435 }
 436
 437 inline bool Position::can_castle_kingside(Color side) const {
 438   return st->castleRights & (1+int(side));
 439 }
 440
 441 inline bool Position::can_castle_queenside(Color side) const {
 442   return st->castleRights & (4+4*int(side));
 443 }
 444
 445 inline bool Position::can_castle(Color side) const {
 446   return can_castle_kingside(side) || can_castle_queenside(side);
 447 }
 448
 449 inline Square Position::initial_kr_square(Color c) const {
 450   return relative_square(c, make_square(initialKRFile, RANK_1));
 451 }
 452
 453 inline Square Position::initial_qr_square(Color c) const {
 454   return relative_square(c, make_square(initialQRFile, RANK_1));
 455 }
 456
 457 template<>
 458 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 459   return NonSlidingAttacksBB[piece_of_color_and_type(c, PAWN)][s];
 460 }
 461
 462 template<PieceType Piece> // Knight and King and white pawns
 463 inline Bitboard Position::attacks_from(Square s) const {
 464   return NonSlidingAttacksBB[Piece][s];
 465 }
 466
 467 template<>
 468 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 469   return bishop_attacks_bb(s, occupied_squares());
 470 }
 471
 472 template<>
 473 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 474   return rook_attacks_bb(s, occupied_squares());
 475 }
 476
 477 template<>
 478 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 479   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 480 }
 481
 482 inline Bitboard Position::checkers() const {
 483   return st->checkersBB;
 484 }
 485
 486 inline bool Position::is_check() const {
 487   return st->checkersBB != EmptyBoardBB;
 488 }
 489
 490 inline bool Position::pawn_is_passed(Color c, Square s) const {
 491   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 492 }
 493
 494 inline bool Position::square_is_weak(Square s, Color c) const {
 495   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
 496 }
 497
 498 inline Key Position::get_key() const {
 499   return st->key;
 500 }
 501
 502 inline Key Position::get_exclusion_key() const {
 503   return st->key ^ zobExclusion;
 504 }
 505
 506 inline Key Position::get_pawn_key() const {
 507   return st->pawnKey;
 508 }
 509
 510 inline Key Position::get_material_key() const {
 511   return st->materialKey;
 512 }
 513
 514 inline Score Position::pst(Color c, PieceType pt, Square s) {
 515   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
 516 }
 517
 518 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
 519   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
 520 }
 521
 522 inline Score Position::value() const {
 523   return st->value;
 524 }
 525
 526 inline Value Position::non_pawn_material(Color c) const {
 527   return st->npMaterial[c];
 528 }
 529
 530 inline bool Position::move_is_passed_pawn_push(Move m) const {
 531
 532   Color c = side_to_move();
 533   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
 534         && pawn_is_passed(c, move_to(m));
 535 }
 536
 537 inline int Position::rule_50_counter() const {
 538   return st->rule50;
 539 }
 540
 541 inline int Position::startpos_ply_counter() const {
 542   return startPosPlyCounter;
 543 }
 544
 545 inline bool Position::opposite_colored_bishops() const {
 546
 547   return   piece_count(WHITE, BISHOP) == 1
 548         && piece_count(BLACK, BISHOP) == 1
 549         && !same_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
 550 }
 551
 552 inline bool Position::has_pawn_on_7th(Color c) const {
 553   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
 554 }
 555
 556 inline bool Position::is_chess960() const {
 557   return isChess960;
 558 }
 559
 560 inline bool Position::move_is_capture(Move m) const {
 561
 562   // Move must not be MOVE_NONE !
 563   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 564 }
 565
 566 inline bool Position::move_is_capture_or_promotion(Move m) const {
 567
 568   // Move must not be MOVE_NONE !
 569   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 570 }
 571
 572 inline PieceType Position::captured_piece_type() const {
 573   return st->capturedType;
 574 }
 575
 576 inline int Position::thread() const {
 577   return threadID;
 578 }
 579
 580 inline void Position::do_allow_oo(Color c) {
 581   st->castleRights |= (1 + int(c));
 582 }
 583
 584 inline void Position::do_allow_ooo(Color c) {
 585   st->castleRights |= (4 + 4*int(c));
 586 }
 587
 588 #endif // !defined(POSITION_H_INCLUDED)