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