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 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 move_gives_check(Move m, const CheckInfo& ci) const;
 152   bool move_attacks_square(Move m, Square s) const;
 153   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 154   bool is_pseudo_legal(const Move m) const;
 155   bool is_capture(Move m) const;
 156   bool is_capture_or_promotion(Move m) const;
 157   bool is_passed_pawn_push(Move m) 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_move(Move m, StateInfo& st);
 167   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 168   void undo_move(Move m);
 169   template<bool Do> void do_null_move(StateInfo& st);
 170
 171   // Static exchange evaluation
 172   int see(Move m) const;
 173   int see_sign(Move m) const;
 174
 175   // Accessing hash keys
 176   Key get_key() const;
 177   Key get_exclusion_key() const;
 178   Key get_pawn_key() const;
 179   Key get_material_key() const;
 180
 181   // Incremental evaluation
 182   Score value() const;
 183   Value non_pawn_material(Color c) const;
 184   Score pst_delta(Piece piece, Square from, Square to) const;
 185
 186   // Game termination checks
 187   bool is_mate() const;
 188   template<bool SkipRepetition> bool is_draw() const;
 189
 190   // Plies from start position to the beginning of search
 191   int startpos_ply_counter() const;
 192
 193   // Other properties of the position
 194   bool opposite_colored_bishops() const;
 195   bool has_pawn_on_7th(Color c) const;
 196   bool is_chess960() const;
 197
 198   // Current thread ID searching on the position
 199   int thread() const;
 200
 201   int64_t nodes_searched() const;
 202   void set_nodes_searched(int64_t n);
 203
 204   // Position consistency check, for debugging
 205   bool pos_is_ok(int* failedStep = NULL) const;
 206   void flip_me();
 207
 208   // Global initialization
 209   static void init();
 210
 211 private:
 212
 213   // Initialization helper functions (used while setting up a position)
 214   void clear();
 215   void put_piece(Piece p, Square s);
 216   void set_castle_right(Square ksq, Square rsq);
 217   bool move_is_legal(const Move m) const;
 218
 219   // Helper functions for doing and undoing moves
 220   template<bool Do> void do_castle_move(Move m);
 221
 222   template<bool FindPinned>
 223   Bitboard hidden_checkers() const;
 224
 225   // Computing hash keys from scratch (for initialization and debugging)
 226   Key compute_key() const;
 227   Key compute_pawn_key() const;
 228   Key compute_material_key() const;
 229
 230   // Computing incremental evaluation scores and material counts
 231   Score pst(Piece p, Square s) const;
 232   Score compute_value() const;
 233   Value compute_non_pawn_material(Color c) const;
 234
 235   // Board
 236   Piece board[64];             // [square]
 237
 238   // Bitboards
 239   Bitboard byTypeBB[8];        // [pieceType]
 240   Bitboard byColorBB[2];       // [color]
 241   Bitboard occupied;
 242
 243   // Piece counts
 244   int pieceCount[2][8];        // [color][pieceType]
 245
 246   // Piece lists
 247   Square pieceList[2][8][16];  // [color][pieceType][index]
 248   int index[64];               // [square]
 249
 250   // Other info
 251   int castleRightsMask[64];    // [square]
 252   Square castleRookSquare[16]; // [castleRight]
 253   StateInfo startState;
 254   int64_t nodes;
 255   int startPosPly;
 256   Color sideToMove;
 257   int threadID;
 258   StateInfo* st;
 259   int chess960;
 260
 261   // Static variables
 262   static Score pieceSquareTable[16][64]; // [piece][square]
 263   static Key zobrist[2][8][64];          // [color][pieceType][square]/[piece count]
 264   static Key zobEp[64];                  // [square]
 265   static Key zobCastle[16];              // [castleRight]
 266   static Key zobSideToMove;
 267   static Key zobExclusion;
 268 };
 269
 270 inline int64_t Position::nodes_searched() const {
 271   return nodes;
 272 }
 273
 274 inline void Position::set_nodes_searched(int64_t n) {
 275   nodes = n;
 276 }
 277
 278 inline Piece Position::piece_on(Square s) const {
 279   return board[s];
 280 }
 281
 282 inline bool Position::square_is_empty(Square s) const {
 283   return board[s] == PIECE_NONE;
 284 }
 285
 286 inline Color Position::side_to_move() const {
 287   return sideToMove;
 288 }
 289
 290 inline Bitboard Position::occupied_squares() const {
 291   return occupied;
 292 }
 293
 294 inline Bitboard Position::empty_squares() const {
 295   return ~occupied;
 296 }
 297
 298 inline Bitboard Position::pieces(Color c) const {
 299   return byColorBB[c];
 300 }
 301
 302 inline Bitboard Position::pieces(PieceType pt) const {
 303   return byTypeBB[pt];
 304 }
 305
 306 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 307   return byTypeBB[pt] & byColorBB[c];
 308 }
 309
 310 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 311   return byTypeBB[pt1] | byTypeBB[pt2];
 312 }
 313
 314 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 315   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 316 }
 317
 318 inline int Position::piece_count(Color c, PieceType pt) const {
 319   return pieceCount[c][pt];
 320 }
 321
 322 inline const Square* Position::piece_list(Color c, PieceType pt) const {
 323   return pieceList[c][pt];
 324 }
 325
 326 inline Square Position::ep_square() const {
 327   return st->epSquare;
 328 }
 329
 330 inline Square Position::king_square(Color c) const {
 331   return pieceList[c][KING][0];
 332 }
 333
 334 inline bool Position::can_castle(CastleRight f) const {
 335   return st->castleRights & f;
 336 }
 337
 338 inline bool Position::can_castle(Color c) const {
 339   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
 340 }
 341
 342 inline Square Position::castle_rook_square(CastleRight f) const {
 343   return castleRookSquare[f];
 344 }
 345
 346 template<>
 347 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 348   return StepAttacksBB[make_piece(c, PAWN)][s];
 349 }
 350
 351 template<PieceType Piece> // Knight and King and white pawns
 352 inline Bitboard Position::attacks_from(Square s) const {
 353   return StepAttacksBB[Piece][s];
 354 }
 355
 356 template<>
 357 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 358   return bishop_attacks_bb(s, occupied_squares());
 359 }
 360
 361 template<>
 362 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 363   return rook_attacks_bb(s, occupied_squares());
 364 }
 365
 366 template<>
 367 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 368   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 369 }
 370
 371 inline Bitboard Position::attacks_from(Piece p, Square s) const {
 372   return attacks_from(p, s, occupied_squares());
 373 }
 374
 375 inline Bitboard Position::attackers_to(Square s) const {
 376   return attackers_to(s, occupied_squares());
 377 }
 378
 379 inline Bitboard Position::checkers() const {
 380   return st->checkersBB;
 381 }
 382
 383 inline bool Position::in_check() const {
 384   return st->checkersBB != 0;
 385 }
 386
 387 inline bool Position::pawn_is_passed(Color c, Square s) const {
 388   return !(pieces(PAWN, flip(c)) & passed_pawn_mask(c, s));
 389 }
 390
 391 inline Key Position::get_key() const {
 392   return st->key;
 393 }
 394
 395 inline Key Position::get_exclusion_key() const {
 396   return st->key ^ zobExclusion;
 397 }
 398
 399 inline Key Position::get_pawn_key() const {
 400   return st->pawnKey;
 401 }
 402
 403 inline Key Position::get_material_key() const {
 404   return st->materialKey;
 405 }
 406
 407 inline Score Position::pst(Piece p, Square s) const {
 408   return pieceSquareTable[p][s];
 409 }
 410
 411 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
 412   return pieceSquareTable[piece][to] - pieceSquareTable[piece][from];
 413 }
 414
 415 inline Score Position::value() const {
 416   return st->value;
 417 }
 418
 419 inline Value Position::non_pawn_material(Color c) const {
 420   return st->npMaterial[c];
 421 }
 422
 423 inline bool Position::is_passed_pawn_push(Move m) const {
 424
 425   return   board[move_from(m)] == make_piece(sideToMove, PAWN)
 426         && pawn_is_passed(sideToMove, move_to(m));
 427 }
 428
 429 inline int Position::startpos_ply_counter() const {
 430   return startPosPly + st->pliesFromNull; // HACK
 431 }
 432
 433 inline bool Position::opposite_colored_bishops() const {
 434
 435   return   pieceCount[WHITE][BISHOP] == 1
 436         && pieceCount[BLACK][BISHOP] == 1
 437         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
 438 }
 439
 440 inline bool Position::has_pawn_on_7th(Color c) const {
 441   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
 442 }
 443
 444 inline bool Position::is_chess960() const {
 445   return chess960;
 446 }
 447
 448 inline bool Position::is_capture_or_promotion(Move m) const {
 449
 450   assert(is_ok(m));
 451   return is_special(m) ? !is_castle(m) : !square_is_empty(move_to(m));
 452 }
 453
 454 inline bool Position::is_capture(Move m) const {
 455
 456   // Note that castle is coded as "king captures the rook"
 457   assert(is_ok(m));
 458   return (!square_is_empty(move_to(m)) && !is_castle(m)) || is_enpassant(m);
 459 }
 460
 461 inline PieceType Position::captured_piece_type() const {
 462   return st->capturedType;
 463 }
 464
 465 inline int Position::thread() const {
 466   return threadID;
 467 }
 468
 469 #endif // !defined(POSITION_H_INCLUDED)