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