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