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   int castleRights, rule50, gamePly, pliesFromNull;
  52   Square epSquare;
  53   Score value;
  54   Value npMaterial[2];
  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 defaul, copy c'tor or assignment allowed, default c'tor will not be
  88   // generated anyhow because of user-defined c'tors.
  89   Position(const Position&);
  90   Position& operator=(const Position&);
  91
  92 public:
  93   Position(const Position& pos, int threadID);
  94   Position(const std::string& fen, bool isChess960, int threadID);
  95
  96   // Text input/output
  97   void from_fen(const std::string& fen, bool isChess960);
  98   const std::string to_fen() const;
  99   void print(Move m = MOVE_NONE) const;
 100
 101   // The piece on a given square
 102   Piece piece_on(Square s) const;
 103   bool square_is_empty(Square s) const;
 104
 105   // Side to move
 106   Color side_to_move() const;
 107
 108   // Bitboard representation of the position
 109   Bitboard empty_squares() const;
 110   Bitboard occupied_squares() const;
 111   Bitboard pieces(Color c) const;
 112   Bitboard pieces(PieceType pt) const;
 113   Bitboard pieces(PieceType pt, Color c) const;
 114   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 115   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
 116
 117   // Number of pieces of each color and type
 118   int piece_count(Color c, PieceType pt) const;
 119
 120   // The en passant square
 121   Square ep_square() const;
 122
 123   // Current king position for each color
 124   Square king_square(Color c) const;
 125
 126   // Castling rights
 127   bool can_castle(CastleRight f) const;
 128   bool can_castle(Color c) const;
 129   Square castle_rook_square(CastleRight f) const;
 130
 131   // Bitboards for pinned pieces and discovered check candidates
 132   Bitboard discovered_check_candidates() const;
 133   Bitboard pinned_pieces() const;
 134
 135   // Checking pieces and under check information
 136   Bitboard checkers() const;
 137   bool in_check() const;
 138
 139   // Piece lists
 140   const Square* piece_list(Color c, PieceType pt) const;
 141
 142   // Information about attacks to or from a given square
 143   Bitboard attackers_to(Square s) const;
 144   Bitboard attackers_to(Square s, Bitboard occ) const;
 145   Bitboard attacks_from(Piece p, Square s) const;
 146   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
 147   template<PieceType> Bitboard attacks_from(Square s) const;
 148   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 149
 150   // Properties of moves
 151   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 152   bool move_is_pl(const Move m) const;
 153   bool move_gives_check(Move m, const CheckInfo& ci) const;
 154   bool move_is_capture(Move m) const;
 155   bool move_is_capture_or_promotion(Move m) const;
 156   bool move_is_passed_pawn_push(Move m) const;
 157   bool move_attacks_square(Move m, Square s) const;
 158
 159   // Piece captured with previous moves
 160   PieceType captured_piece_type() const;
 161
 162   // Information about pawns
 163   bool pawn_is_passed(Color c, Square s) const;
 164
 165   // Doing and undoing moves
 166   void do_setup_move(Move m, StateInfo& st);
 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   void do_null_move(StateInfo& st);
 171   void undo_null_move();
 172
 173   // Static exchange evaluation
 174   int see(Move m) const;
 175   int see_sign(Move m) const;
 176
 177   // Accessing hash keys
 178   Key get_key() const;
 179   Key get_exclusion_key() const;
 180   Key get_pawn_key() const;
 181   Key get_material_key() const;
 182
 183   // Incremental evaluation
 184   Score value() const;
 185   Value non_pawn_material(Color c) const;
 186   Score pst_delta(Piece piece, Square from, Square to) const;
 187
 188   // Game termination checks
 189   bool is_mate() const;
 190   template<bool SkipRepetition> bool is_draw() const;
 191
 192   // Number of plies from starting position
 193   int startpos_ply_counter() const;
 194
 195   // Other properties of the position
 196   bool opposite_colored_bishops() const;
 197   bool has_pawn_on_7th(Color c) const;
 198   bool is_chess960() const;
 199
 200   // Current thread ID searching on the position
 201   int thread() const;
 202
 203   int64_t nodes_searched() const;
 204   void set_nodes_searched(int64_t n);
 205
 206   // Position consistency check, for debugging
 207   bool is_ok(int* failedStep = NULL) const;
 208   void flip();
 209
 210   // Global initialization
 211   static void init();
 212
 213 private:
 214
 215   // Initialization helper functions (used while setting up a position)
 216   void clear();
 217   void put_piece(Piece p, Square s);
 218   void set_castle(int f, Square ksq, Square rsq);
 219   void set_castling_rights(char token);
 220   bool move_is_legal(const Move m) const;
 221
 222   // Helper functions for doing and undoing moves
 223   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 224   void do_castle_move(Move m);
 225   void undo_castle_move(Move m);
 226
 227   template<bool FindPinned>
 228   Bitboard hidden_checkers() const;
 229
 230   // Computing hash keys from scratch (for initialization and debugging)
 231   Key compute_key() const;
 232   Key compute_pawn_key() const;
 233   Key compute_material_key() const;
 234
 235   // Computing incremental evaluation scores and material counts
 236   Score pst(Piece p, Square s) const;
 237   Score compute_value() const;
 238   Value compute_non_pawn_material(Color c) const;
 239
 240   // Board
 241   Piece board[64];             // [square]
 242
 243   // Bitboards
 244   Bitboard byTypeBB[8];        // [pieceType]
 245   Bitboard byColorBB[2];       // [color]
 246
 247   // Piece counts
 248   int pieceCount[2][8];        // [color][pieceType]
 249
 250   // Piece lists
 251   Square pieceList[2][8][16];  // [color][pieceType][index]
 252   int index[64];               // [square]
 253
 254   // Other info
 255   int castleRightsMask[64];    // [square]
 256   Square castleRookSquare[16]; // [castleRight]
 257   StateInfo startState;
 258   int64_t nodes;
 259   Color sideToMove;
 260   int fullMoves;
 261   int threadID;
 262   StateInfo* st;
 263   int chess960;
 264
 265   // Static variables
 266   static Score pieceSquareTable[16][64]; // [piece][square]
 267   static Key zobrist[2][8][64];          // [color][pieceType][square]
 268   static Key zobEp[64];                  // [square]
 269   static Key zobCastle[16];              // [castleRight]
 270   static Key zobSideToMove;
 271   static Key zobExclusion;
 272 };
 273
 274 inline int64_t Position::nodes_searched() const {
 275   return nodes;
 276 }
 277
 278 inline void Position::set_nodes_searched(int64_t n) {
 279   nodes = n;
 280 }
 281
 282 inline Piece Position::piece_on(Square s) const {
 283   return board[s];
 284 }
 285
 286 inline bool Position::square_is_empty(Square s) const {
 287   return piece_on(s) == PIECE_NONE;
 288 }
 289
 290 inline Color Position::side_to_move() const {
 291   return sideToMove;
 292 }
 293
 294 inline Bitboard Position::occupied_squares() const {
 295   return byTypeBB[0];
 296 }
 297
 298 inline Bitboard Position::empty_squares() const {
 299   return ~occupied_squares();
 300 }
 301
 302 inline Bitboard Position::pieces(Color c) const {
 303   return byColorBB[c];
 304 }
 305
 306 inline Bitboard Position::pieces(PieceType pt) const {
 307   return byTypeBB[pt];
 308 }
 309
 310 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 311   return byTypeBB[pt] & byColorBB[c];
 312 }
 313
 314 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 315   return byTypeBB[pt1] | byTypeBB[pt2];
 316 }
 317
 318 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 319   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 320 }
 321
 322 inline int Position::piece_count(Color c, PieceType pt) const {
 323   return pieceCount[c][pt];
 324 }
 325
 326 inline const Square* Position::piece_list(Color c, PieceType pt) const {
 327   return pieceList[c][pt];
 328 }
 329
 330 inline Square Position::ep_square() const {
 331   return st->epSquare;
 332 }
 333
 334 inline Square Position::king_square(Color c) const {
 335   return pieceList[c][KING][0];
 336 }
 337
 338 inline bool Position::can_castle(CastleRight f) const {
 339   return st->castleRights & f;
 340 }
 341
 342 inline bool Position::can_castle(Color c) const {
 343   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
 344 }
 345
 346 inline Square Position::castle_rook_square(CastleRight f) const {
 347   return castleRookSquare[f];
 348 }
 349
 350 template<>
 351 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 352   return StepAttacksBB[make_piece(c, PAWN)][s];
 353 }
 354
 355 template<PieceType Piece> // Knight and King and white pawns
 356 inline Bitboard Position::attacks_from(Square s) const {
 357   return StepAttacksBB[Piece][s];
 358 }
 359
 360 template<>
 361 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 362   return bishop_attacks_bb(s, occupied_squares());
 363 }
 364
 365 template<>
 366 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 367   return rook_attacks_bb(s, occupied_squares());
 368 }
 369
 370 template<>
 371 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 372   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 373 }
 374
 375 inline Bitboard Position::checkers() const {
 376   return st->checkersBB;
 377 }
 378
 379 inline bool Position::in_check() const {
 380   return st->checkersBB != EmptyBoardBB;
 381 }
 382
 383 inline bool Position::pawn_is_passed(Color c, Square s) const {
 384   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 385 }
 386
 387 inline Key Position::get_key() const {
 388   return st->key;
 389 }
 390
 391 inline Key Position::get_exclusion_key() const {
 392   return st->key ^ zobExclusion;
 393 }
 394
 395 inline Key Position::get_pawn_key() const {
 396   return st->pawnKey;
 397 }
 398
 399 inline Key Position::get_material_key() const {
 400   return st->materialKey;
 401 }
 402
 403 inline Score Position::pst(Piece p, Square s) const {
 404   return pieceSquareTable[p][s];
 405 }
 406
 407 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
 408   return pieceSquareTable[piece][to] - pieceSquareTable[piece][from];
 409 }
 410
 411 inline Score Position::value() const {
 412   return st->value;
 413 }
 414
 415 inline Value Position::non_pawn_material(Color c) const {
 416   return st->npMaterial[c];
 417 }
 418
 419 inline bool Position::move_is_passed_pawn_push(Move m) const {
 420
 421   Color c = side_to_move();
 422   return   piece_on(move_from(m)) == make_piece(c, PAWN)
 423         && pawn_is_passed(c, move_to(m));
 424 }
 425
 426 inline int Position::startpos_ply_counter() const {
 427   return Max(2 * (fullMoves - 1), 0) + int(sideToMove == BLACK);
 428 }
 429
 430 inline bool Position::opposite_colored_bishops() const {
 431
 432   return   piece_count(WHITE, BISHOP) == 1
 433         && piece_count(BLACK, BISHOP) == 1
 434         && opposite_color_squares(piece_list(WHITE, BISHOP)[0], piece_list(BLACK, BISHOP)[0]);
 435 }
 436
 437 inline bool Position::has_pawn_on_7th(Color c) const {
 438   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
 439 }
 440
 441 inline bool Position::is_chess960() const {
 442   return chess960;
 443 }
 444
 445 inline bool Position::move_is_capture_or_promotion(Move m) const {
 446
 447   assert(move_is_ok(m));
 448   return move_is_special(m) ? !move_is_castle(m) : !square_is_empty(move_to(m));
 449 }
 450
 451 inline bool Position::move_is_capture(Move m) const {
 452
 453   // Note that castle is coded as "king captures the rook"
 454   assert(move_is_ok(m));
 455   return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
 456 }
 457
 458 inline PieceType Position::captured_piece_type() const {
 459   return st->capturedType;
 460 }
 461
 462 inline int Position::thread() const {
 463   return threadID;
 464 }
 465
 466 #endif // !defined(POSITION_H_INCLUDED)