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 CastleRights {
  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   PieceType type_of_piece_on(Square s) const;
 133   Color color_of_piece_on(Square s) const;
 134   bool square_is_empty(Square s) const;
 135   bool square_is_occupied(Square s) const;
 136   Value midgame_value_of_piece_on(Square s) const;
 137   Value endgame_value_of_piece_on(Square s) const;
 138
 139   // Side to move
 140   Color side_to_move() const;
 141
 142   // Bitboard representation of the position
 143   Bitboard empty_squares() const;
 144   Bitboard occupied_squares() const;
 145   Bitboard pieces_of_color(Color c) const;
 146   Bitboard pieces(PieceType pt) const;
 147   Bitboard pieces(PieceType pt, Color c) const;
 148   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 149   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
 150
 151   // Number of pieces of each color and type
 152   int piece_count(Color c, PieceType pt) const;
 153
 154   // The en passant square
 155   Square ep_square() const;
 156
 157   // Current king position for each color
 158   Square king_square(Color c) const;
 159
 160   // Castling rights
 161   bool can_castle_kingside(Color c) const;
 162   bool can_castle_queenside(Color c) const;
 163   bool can_castle(Color c) const;
 164   Square initial_kr_square(Color c) const;
 165   Square initial_qr_square(Color c) const;
 166
 167   // Bitboards for pinned pieces and discovered check candidates
 168   Bitboard discovered_check_candidates(Color c) const;
 169   Bitboard pinned_pieces(Color c) const;
 170
 171   // Checking pieces and under check information
 172   Bitboard checkers() const;
 173   bool in_check() const;
 174
 175   // Piece lists
 176   Square piece_list(Color c, PieceType pt, int index) const;
 177   const Square* piece_list_begin(Color c, PieceType pt) const;
 178
 179   // Information about attacks to or from a given square
 180   Bitboard attackers_to(Square s) const;
 181   Bitboard attackers_to(Square s, Bitboard occ) const;
 182   Bitboard attacks_from(Piece p, Square s) const;
 183   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
 184   template<PieceType> Bitboard attacks_from(Square s) const;
 185   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 186
 187   // Properties of moves
 188   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 189   bool move_is_pl(const Move m) const;
 190   bool move_gives_check(Move m, const CheckInfo& ci) const;
 191   bool move_is_capture(Move m) const;
 192   bool move_is_passed_pawn_push(Move m) const;
 193   bool move_attacks_square(Move m, Square s) const;
 194
 195   // Piece captured with previous moves
 196   PieceType captured_piece_type() const;
 197
 198   // Information about pawns
 199   bool pawn_is_passed(Color c, Square s) const;
 200
 201   // Weak squares
 202   bool square_is_weak(Square s, Color c) const;
 203
 204   // Doing and undoing moves
 205   void do_setup_move(Move m);
 206   void do_move(Move m, StateInfo& st);
 207   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 208   void undo_move(Move m);
 209   void do_null_move(StateInfo& st);
 210   void undo_null_move();
 211
 212   // Static exchange evaluation
 213   int see(Move m) const;
 214   int see_sign(Move m) const;
 215   static int see_value(PieceType pt);
 216
 217   // Accessing hash keys
 218   Key get_key() const;
 219   Key get_exclusion_key() const;
 220   Key get_pawn_key() const;
 221   Key get_material_key() const;
 222
 223   // Incremental evaluation
 224   Score value() const;
 225   Value non_pawn_material(Color c) const;
 226   static Score pst_delta(Piece piece, Square from, Square to);
 227
 228   // Game termination checks
 229   bool is_mate() const;
 230   template<bool SkipRepetition> bool is_draw() const;
 231
 232   // Number of plies from starting position
 233   int startpos_ply_counter() const;
 234
 235   // Other properties of the position
 236   bool opposite_colored_bishops() const;
 237   bool has_pawn_on_7th(Color c) const;
 238   bool is_chess960() const;
 239
 240   // Current thread ID searching on the position
 241   int thread() const;
 242
 243   int64_t nodes_searched() const;
 244   void set_nodes_searched(int64_t n);
 245
 246   // Position consistency check, for debugging
 247   bool is_ok(int* failedStep = NULL) const;
 248
 249   // Global initialization
 250   static void init();
 251
 252 private:
 253
 254   // Initialization helper functions (used while setting up a position)
 255   void clear();
 256   void detach();
 257   void put_piece(Piece p, Square s);
 258   void set_castle_kingside(Color c);
 259   void set_castle_queenside(Color c);
 260   bool set_castling_rights(char token);
 261   bool move_is_pl_slow(const Move m) const;
 262
 263   // Helper functions for doing and undoing moves
 264   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
 265   void do_castle_move(Move m);
 266   void undo_castle_move(Move m);
 267   void find_checkers();
 268
 269   template<bool FindPinned>
 270   Bitboard hidden_checkers(Color c) const;
 271
 272   // Computing hash keys from scratch (for initialization and debugging)
 273   Key compute_key() const;
 274   Key compute_pawn_key() const;
 275   Key compute_material_key() const;
 276
 277   // Computing incremental evaluation scores and material counts
 278   static Score pst(Color c, PieceType pt, Square s);
 279   Score compute_value() const;
 280   Value compute_non_pawn_material(Color c) const;
 281
 282   // Board
 283   Piece board[64];
 284
 285   // Bitboards
 286   Bitboard byTypeBB[8], byColorBB[2];
 287
 288   // Piece counts
 289   int pieceCount[2][8]; // [color][pieceType]
 290
 291   // Piece lists
 292   Square pieceList[2][8][16]; // [color][pieceType][index]
 293   int index[64]; // [square]
 294
 295   // Other info
 296   Color sideToMove;
 297   Key history[MaxGameLength];
 298   int castleRightsMask[64];
 299   StateInfo startState;
 300   File initialKFile, initialKRFile, initialQRFile;
 301   bool chess960;
 302   int startPosPlyCounter;
 303   int threadID;
 304   int64_t nodes;
 305   StateInfo* st;
 306
 307   // Static variables
 308   static Key zobrist[2][8][64];
 309   static Key zobEp[64];
 310   static Key zobCastle[16];
 311   static Key zobSideToMove;
 312   static Score PieceSquareTable[16][64];
 313   static Key zobExclusion;
 314   static const Value seeValues[8];
 315   static const Value PieceValueMidgame[17];
 316   static const Value PieceValueEndgame[17];
 317 };
 318
 319 inline int64_t Position::nodes_searched() const {
 320   return nodes;
 321 }
 322
 323 inline void Position::set_nodes_searched(int64_t n) {
 324   nodes = n;
 325 }
 326
 327 inline Piece Position::piece_on(Square s) const {
 328   return board[s];
 329 }
 330
 331 inline Color Position::color_of_piece_on(Square s) const {
 332   return color_of_piece(piece_on(s));
 333 }
 334
 335 inline PieceType Position::type_of_piece_on(Square s) const {
 336   return type_of_piece(piece_on(s));
 337 }
 338
 339 inline bool Position::square_is_empty(Square s) const {
 340   return piece_on(s) == PIECE_NONE;
 341 }
 342
 343 inline bool Position::square_is_occupied(Square s) const {
 344   return !square_is_empty(s);
 345 }
 346
 347 inline Value Position::midgame_value_of_piece_on(Square s) const {
 348   return PieceValueMidgame[piece_on(s)];
 349 }
 350
 351 inline Value Position::endgame_value_of_piece_on(Square s) const {
 352   return PieceValueEndgame[piece_on(s)];
 353 }
 354
 355 inline Color Position::side_to_move() const {
 356   return sideToMove;
 357 }
 358
 359 inline Bitboard Position::occupied_squares() const {
 360   return byTypeBB[0];
 361 }
 362
 363 inline Bitboard Position::empty_squares() const {
 364   return ~occupied_squares();
 365 }
 366
 367 inline Bitboard Position::pieces_of_color(Color c) const {
 368   return byColorBB[c];
 369 }
 370
 371 inline Bitboard Position::pieces(PieceType pt) const {
 372   return byTypeBB[pt];
 373 }
 374
 375 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 376   return byTypeBB[pt] & byColorBB[c];
 377 }
 378
 379 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 380   return byTypeBB[pt1] | byTypeBB[pt2];
 381 }
 382
 383 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 384   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 385 }
 386
 387 inline int Position::piece_count(Color c, PieceType pt) const {
 388   return pieceCount[c][pt];
 389 }
 390
 391 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
 392   return pieceList[c][pt][idx];
 393 }
 394
 395 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
 396   return pieceList[c][pt];
 397 }
 398
 399 inline Square Position::ep_square() const {
 400   return st->epSquare;
 401 }
 402
 403 inline Square Position::king_square(Color c) const {
 404   return pieceList[c][KING][0];
 405 }
 406
 407 inline bool Position::can_castle_kingside(Color c) const {
 408   return st->castleRights & (WHITE_OO << c);
 409 }
 410
 411 inline bool Position::can_castle_queenside(Color c) const {
 412   return st->castleRights & (WHITE_OOO << c);
 413 }
 414
 415 inline bool Position::can_castle(Color c) const {
 416   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
 417 }
 418
 419 inline void Position::set_castle_kingside(Color c) {
 420   st->castleRights |= (WHITE_OO << c);
 421 }
 422
 423 inline void Position::set_castle_queenside(Color c) {
 424   st->castleRights |= (WHITE_OOO << c);
 425 }
 426
 427 inline Square Position::initial_kr_square(Color c) const {
 428   return relative_square(c, make_square(initialKRFile, RANK_1));
 429 }
 430
 431 inline Square Position::initial_qr_square(Color c) const {
 432   return relative_square(c, make_square(initialQRFile, RANK_1));
 433 }
 434
 435 template<>
 436 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 437   return StepAttacksBB[make_piece(c, PAWN)][s];
 438 }
 439
 440 template<PieceType Piece> // Knight and King and white pawns
 441 inline Bitboard Position::attacks_from(Square s) const {
 442   return StepAttacksBB[Piece][s];
 443 }
 444
 445 template<>
 446 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
 447   return bishop_attacks_bb(s, occupied_squares());
 448 }
 449
 450 template<>
 451 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
 452   return rook_attacks_bb(s, occupied_squares());
 453 }
 454
 455 template<>
 456 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
 457   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
 458 }
 459
 460 inline Bitboard Position::checkers() const {
 461   return st->checkersBB;
 462 }
 463
 464 inline bool Position::in_check() const {
 465   return st->checkersBB != EmptyBoardBB;
 466 }
 467
 468 inline bool Position::pawn_is_passed(Color c, Square s) const {
 469   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 470 }
 471
 472 inline bool Position::square_is_weak(Square s, Color c) const {
 473   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
 474 }
 475
 476 inline int Position::see_value(PieceType pt) {
 477   return seeValues[pt];
 478 }
 479
 480 inline Key Position::get_key() const {
 481   return st->key;
 482 }
 483
 484 inline Key Position::get_exclusion_key() const {
 485   return st->key ^ zobExclusion;
 486 }
 487
 488 inline Key Position::get_pawn_key() const {
 489   return st->pawnKey;
 490 }
 491
 492 inline Key Position::get_material_key() const {
 493   return st->materialKey;
 494 }
 495
 496 inline Score Position::pst(Color c, PieceType pt, Square s) {
 497   return PieceSquareTable[make_piece(c, pt)][s];
 498 }
 499
 500 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
 501   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
 502 }
 503
 504 inline Score Position::value() const {
 505   return st->value;
 506 }
 507
 508 inline Value Position::non_pawn_material(Color c) const {
 509   return st->npMaterial[c];
 510 }
 511
 512 inline bool Position::move_is_passed_pawn_push(Move m) const {
 513
 514   Color c = side_to_move();
 515   return   piece_on(move_from(m)) == make_piece(c, PAWN)
 516         && pawn_is_passed(c, move_to(m));
 517 }
 518
 519 inline int Position::startpos_ply_counter() const {
 520   return startPosPlyCounter;
 521 }
 522
 523 inline bool Position::opposite_colored_bishops() const {
 524
 525   return   piece_count(WHITE, BISHOP) == 1 && piece_count(BLACK, BISHOP) == 1
 526         && opposite_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
 527 }
 528
 529 inline bool Position::has_pawn_on_7th(Color c) const {
 530   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
 531 }
 532
 533 inline bool Position::is_chess960() const {
 534   return chess960;
 535 }
 536
 537 inline bool Position::move_is_capture(Move m) const {
 538
 539   assert (m != MOVE_NONE && m != MOVE_NULL);
 540   return !move_is_special(m) ? !square_is_empty(move_to(m)) : move_is_ep(m);
 541 }
 542
 543 inline PieceType Position::captured_piece_type() const {
 544   return st->capturedType;
 545 }
 546
 547 inline int Position::thread() const {
 548   return threadID;
 549 }
 550
 551 #endif // !defined(POSITION_H_INCLUDED)