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-2009 Marco Costalba
   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
  21 #if !defined(POSITION_H_INCLUDED)
  22 #define POSITION_H_INCLUDED
  23
  24 // Disable some silly and noisy warning from MSVC compiler
  25 #if defined(_MSC_VER)
  26
  27 // Forcing value to bool 'true' or 'false' (performance warning)
  28 #pragma warning(disable: 4800)
  29
  30 // Conditional expression is constant
  31 #pragma warning(disable: 4127)
  32
  33
  34 #endif
  35
  36 ////
  37 //// Includes
  38 ////
  39
  40 #include "bitboard.h"
  41 #include "color.h"
  42 #include "direction.h"
  43 #include "move.h"
  44 #include "piece.h"
  45 #include "square.h"
  46 #include "value.h"
  47
  48
  49 ////
  50 //// Constants
  51 ////
  52
  53 /// FEN string for the initial position
  54 const std::string StartPosition = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
  55
  56 /// Maximum number of plies per game (220 should be enough, because the
  57 /// maximum search depth is 100, and during position setup we reset the
  58 /// move counter for every non-reversible move).
  59 const int MaxGameLength = 220;
  60
  61
  62 ////
  63 //// Types
  64 ////
  65
  66 /// Castle rights, encoded as bit fields
  67
  68 enum CastleRights {
  69   NO_CASTLES  = 0,
  70   WHITE_OO    = 1,
  71   BLACK_OO    = 2,
  72   WHITE_OOO   = 4,
  73   BLACK_OOO   = 8,
  74   ALL_CASTLES = 15
  75 };
  76
  77 /// Game phase
  78 enum Phase {
  79   PHASE_ENDGAME = 0,
  80   PHASE_MIDGAME = 128
  81 };
  82
  83
  84 /// The StateInfo struct stores information we need to restore a Position
  85 /// object to its previous state when we retract a move. Whenever a move
  86 /// is made on the board (by calling Position::do_move), an StateInfo object
  87 /// must be passed as a parameter.
  88
  89 struct StateInfo {
  90   Key key, pawnKey, materialKey;
  91   int castleRights, rule50;
  92   Square kingSquare[2], epSquare;
  93   Value mgValue, egValue;
  94   Value npMaterial[2];
  95
  96   PieceType capture;
  97   Bitboard checkersBB;
  98   StateInfo* previous;
  99 };
 100
 101
 102 /// The position data structure. A position consists of the following data:
 103 ///
 104 ///    * For each piece type, a bitboard representing the squares occupied
 105 ///      by pieces of that type.
 106 ///    * For each color, a bitboard representing the squares occupied by
 107 ///      pieces of that color.
 108 ///    * A bitboard of all occupied squares.
 109 ///    * A bitboard of all checking pieces.
 110 ///    * A 64-entry array of pieces, indexed by the squares of the board.
 111 ///    * The current side to move.
 112 ///    * Information about the castling rights for both sides.
 113 ///    * The initial files of the kings and both pairs of rooks. This is
 114 ///      used to implement the Chess960 castling rules.
 115 ///    * The en passant square (which is SQ_NONE if no en passant capture is
 116 ///      possible).
 117 ///    * The squares of the kings for both sides.
 118 ///    * Hash keys for the position itself, the current pawn structure, and
 119 ///      the current material situation.
 120 ///    * Hash keys for all previous positions in the game for detecting
 121 ///      repetition draws.
 122 ///    * A counter for detecting 50 move rule draws.
 123
 124 class Position {
 125
 126   friend class MaterialInfo;
 127   friend class EndgameFunctions;
 128
 129 public:
 130   enum GamePhase {
 131       MidGame,
 132       EndGame
 133   };
 134
 135   // Constructors
 136   Position() {}
 137   Position(const Position& pos);
 138   Position(const std::string& fen);
 139
 140   // Text input/output
 141   void from_fen(const std::string& fen);
 142   const std::string to_fen() const;
 143   void print(Move m = MOVE_NONE) const;
 144
 145   // Copying
 146   void copy(const Position& pos);
 147   void flipped_copy(const Position& pos);
 148
 149   // The piece on a given square
 150   Piece piece_on(Square s) const;
 151   PieceType type_of_piece_on(Square s) const;
 152   Color color_of_piece_on(Square s) const;
 153   bool square_is_empty(Square s) const;
 154   bool square_is_occupied(Square s) const;
 155   Value midgame_value_of_piece_on(Square s) const;
 156   Value endgame_value_of_piece_on(Square s) const;
 157
 158   // Side to move
 159   Color side_to_move() const;
 160
 161   // Bitboard representation of the position
 162   Bitboard empty_squares() const;
 163   Bitboard occupied_squares() const;
 164   Bitboard pieces_of_color(Color c) const;
 165   Bitboard pieces(PieceType pt) const;
 166   Bitboard pieces(PieceType pt, Color c) const;
 167   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 168   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
 169
 170   // Number of pieces of each color and type
 171   int piece_count(Color c, PieceType pt) const;
 172
 173   // The en passant square
 174   Square ep_square() const;
 175
 176   // Current king position for each color
 177   Square king_square(Color c) const;
 178
 179   // Castling rights
 180   bool can_castle_kingside(Color c) const;
 181   bool can_castle_queenside(Color c) const;
 182   bool can_castle(Color c) const;
 183   Square initial_kr_square(Color c) const;
 184   Square initial_qr_square(Color c) const;
 185
 186   // Bitboards for pinned pieces and discovered check candidates
 187   Bitboard discovered_check_candidates(Color c) const;
 188   Bitboard pinned_pieces(Color c) const;
 189
 190   // Checking pieces and under check information
 191   Bitboard checkers() const;
 192   bool is_check() const;
 193
 194   // Piece lists
 195   Square piece_list(Color c, PieceType pt, int index) const;
 196
 197   // Information about attacks to or from a given square
 198   Bitboard attackers_to(Square s) const;
 199   Bitboard piece_attacks_from(Piece p, Square s) const;
 200   Bitboard pawn_attacks_from(Square s, Color c) const;
 201   template<PieceType> Bitboard piece_attacks_from(Square s) const;
 202
 203   // Properties of moves
 204   bool pl_move_is_legal(Move m) const;
 205   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 206   bool move_is_check(Move m) const;
 207   bool move_is_check(Move m, Bitboard dcCandidates) const;
 208   bool move_is_capture(Move m) const;
 209   bool move_is_passed_pawn_push(Move m) const;
 210   bool move_attacks_square(Move m, Square s) const;
 211
 212   // Information about pawns
 213   bool pawn_is_passed(Color c, Square s) const;
 214   static bool pawn_is_passed(Bitboard theirPawns, Color c, Square s);
 215   static bool pawn_is_isolated(Bitboard ourPawns, Square s);
 216   static bool pawn_is_doubled(Bitboard ourPawns, Color c, Square s);
 217
 218   // Weak squares
 219   bool square_is_weak(Square s, Color c) const;
 220
 221   // Doing and undoing moves
 222   void saveState();
 223   void do_move(Move m, StateInfo& st);
 224   void do_move(Move m, StateInfo& st, Bitboard dcCandidates);
 225   void undo_move(Move m);
 226   void do_null_move(StateInfo& st);
 227   void undo_null_move();
 228
 229   // Static exchange evaluation
 230   int see(Square from, Square to) const;
 231   int see(Move m) const;
 232   int see(Square to) const;
 233   int see_sign(Move m) const;
 234
 235   // Accessing hash keys
 236   Key get_key() const;
 237   Key get_pawn_key() const;
 238   Key get_material_key() const;
 239
 240   // Incremental evaluation
 241   Value mg_value() const;
 242   Value eg_value() const;
 243   Value non_pawn_material(Color c) const;
 244   Phase game_phase() const;
 245   template<GamePhase> Value pst_delta(Piece piece, Square from, Square to) const;
 246
 247   // Game termination checks
 248   bool is_mate() const;
 249   bool is_draw() const;
 250
 251   // Check if one side threatens a mate in one
 252   bool has_mate_threat(Color c);
 253
 254   // Number of plies since the last non-reversible move
 255   int rule_50_counter() const;
 256
 257   // Other properties of the position
 258   bool opposite_colored_bishops() const;
 259   bool has_pawn_on_7th(Color c) const;
 260
 261   // Reset the gamePly variable to 0
 262   void reset_game_ply();
 263
 264   // Position consistency check, for debugging
 265   bool is_ok(int* failedStep = NULL) const;
 266
 267   // Static member functions
 268   static void init_zobrist();
 269   static void init_piece_square_tables();
 270
 271 private:
 272
 273   // Initialization helper functions (used while setting up a position)
 274   void clear();
 275   void put_piece(Piece p, Square s);
 276   void allow_oo(Color c);
 277   void allow_ooo(Color c);
 278
 279   // Helper functions for doing and undoing moves
 280   void do_capture_move(Bitboard& key, PieceType capture, Color them, Square to, bool ep);
 281   void do_castle_move(Move m);
 282   void undo_castle_move(Move m);
 283   void find_checkers();
 284
 285   template<PieceType Piece>
 286   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
 287
 288   template<bool FindPinned>
 289   Bitboard hidden_checkers(Color c) const;
 290
 291   // Computing hash keys from scratch (for initialization and debugging)
 292   Key compute_key() const;
 293   Key compute_pawn_key() const;
 294   Key compute_material_key() const;
 295
 296   // Computing incremental evaluation scores and material counts
 297   template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
 298   template<GamePhase> Value compute_value() const;
 299   Value compute_non_pawn_material(Color c) const;
 300
 301   // Bitboards
 302   Bitboard byColorBB[2], byTypeBB[8];
 303
 304   // Board
 305   Piece board[64];
 306
 307   // Piece counts
 308   int pieceCount[2][8]; // [color][pieceType]
 309
 310   // Piece lists
 311   Square pieceList[2][8][16]; // [color][pieceType][index]
 312   int index[64]; // [square]
 313
 314   // Other info
 315   Color sideToMove;
 316   int gamePly;
 317   Key history[MaxGameLength];
 318   File initialKFile, initialKRFile, initialQRFile;
 319   StateInfo startState;
 320   StateInfo* st;
 321
 322   // Static variables
 323   static int castleRightsMask[64];
 324   static Key zobrist[2][8][64];
 325   static Key zobEp[64];
 326   static Key zobCastle[16];
 327   static Key zobMaterial[2][8][16];
 328   static Key zobSideToMove;
 329   static Value MgPieceSquareTable[16][64];
 330   static Value EgPieceSquareTable[16][64];
 331 };
 332
 333
 334 ////
 335 //// Inline functions
 336 ////
 337
 338 inline Piece Position::piece_on(Square s) const {
 339   return board[s];
 340 }
 341
 342 inline Color Position::color_of_piece_on(Square s) const {
 343   return color_of_piece(piece_on(s));
 344 }
 345
 346 inline PieceType Position::type_of_piece_on(Square s) const {
 347   return type_of_piece(piece_on(s));
 348 }
 349
 350 inline bool Position::square_is_empty(Square s) const {
 351   return piece_on(s) == EMPTY;
 352 }
 353
 354 inline bool Position::square_is_occupied(Square s) const {
 355   return !square_is_empty(s);
 356 }
 357
 358 inline Value Position::midgame_value_of_piece_on(Square s) const {
 359   return piece_value_midgame(piece_on(s));
 360 }
 361
 362 inline Value Position::endgame_value_of_piece_on(Square s) const {
 363   return piece_value_endgame(piece_on(s));
 364 }
 365
 366 inline Color Position::side_to_move() const {
 367   return sideToMove;
 368 }
 369
 370 inline Bitboard Position::occupied_squares() const {
 371   return byTypeBB[0];
 372 }
 373
 374 inline Bitboard Position::empty_squares() const {
 375   return ~(occupied_squares());
 376 }
 377
 378 inline Bitboard Position::pieces_of_color(Color c) const {
 379   return byColorBB[c];
 380 }
 381
 382 inline Bitboard Position::pieces(PieceType pt) const {
 383   return byTypeBB[pt];
 384 }
 385
 386 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 387   return byTypeBB[pt] & byColorBB[c];
 388 }
 389
 390 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 391   return byTypeBB[pt1] | byTypeBB[pt2];
 392 }
 393
 394 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 395   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 396 }
 397
 398 inline int Position::piece_count(Color c, PieceType pt) const {
 399   return pieceCount[c][pt];
 400 }
 401
 402 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
 403   return pieceList[c][pt][index];
 404 }
 405
 406 inline Square Position::ep_square() const {
 407   return st->epSquare;
 408 }
 409
 410 inline Square Position::king_square(Color c) const {
 411   return st->kingSquare[c];
 412 }
 413
 414 inline bool Position::can_castle_kingside(Color side) const {
 415   return st->castleRights & (1+int(side));
 416 }
 417
 418 inline bool Position::can_castle_queenside(Color side) const {
 419   return st->castleRights & (4+4*int(side));
 420 }
 421
 422 inline bool Position::can_castle(Color side) const {
 423   return can_castle_kingside(side) || can_castle_queenside(side);
 424 }
 425
 426 inline Square Position::initial_kr_square(Color c) const {
 427   return relative_square(c, make_square(initialKRFile, RANK_1));
 428 }
 429
 430 inline Square Position::initial_qr_square(Color c) const {
 431   return relative_square(c, make_square(initialQRFile, RANK_1));
 432 }
 433
 434 inline Bitboard Position::pawn_attacks_from(Square s, Color c) const {
 435   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
 436 }
 437
 438 template<PieceType Piece> // Knight and King
 439 inline Bitboard Position::piece_attacks_from(Square s) const {
 440   return StepAttackBB[Piece][s];
 441 }
 442
 443 template<>
 444 inline Bitboard Position::piece_attacks_from<PAWN>(Square s) const {
 445   return StepAttackBB[WP][s] | StepAttackBB[BP][s];
 446 }
 447
 448 template<>
 449 inline Bitboard Position::piece_attacks_from<BISHOP>(Square s) const {
 450   return bishop_attacks_bb(s, occupied_squares());
 451 }
 452
 453 template<>
 454 inline Bitboard Position::piece_attacks_from<ROOK>(Square s) const {
 455   return rook_attacks_bb(s, occupied_squares());
 456 }
 457
 458 template<>
 459 inline Bitboard Position::piece_attacks_from<QUEEN>(Square s) const {
 460   return piece_attacks_from<ROOK>(s) | piece_attacks_from<BISHOP>(s);
 461 }
 462
 463 inline Bitboard Position::checkers() const {
 464   return st->checkersBB;
 465 }
 466
 467 inline bool Position::is_check() const {
 468   return st->checkersBB != EmptyBoardBB;
 469 }
 470
 471 inline bool Position::pawn_is_passed(Color c, Square s) const {
 472   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 473 }
 474
 475 inline bool Position::pawn_is_passed(Bitboard theirPawns, Color c, Square s) {
 476   return !(theirPawns & passed_pawn_mask(c, s));
 477 }
 478
 479 inline bool Position::pawn_is_isolated(Bitboard ourPawns, Square s) {
 480   return !(ourPawns & neighboring_files_bb(s));
 481 }
 482
 483 inline bool Position::pawn_is_doubled(Bitboard ourPawns, Color c, Square s) {
 484   return ourPawns & squares_behind(c, s);
 485 }
 486
 487 inline bool Position::square_is_weak(Square s, Color c) const {
 488   return !(pieces(PAWN, c) & outpost_mask(opposite_color(c), s));
 489 }
 490
 491 inline Key Position::get_key() const {
 492   return st->key;
 493 }
 494
 495 inline Key Position::get_pawn_key() const {
 496   return st->pawnKey;
 497 }
 498
 499 inline Key Position::get_material_key() const {
 500   return st->materialKey;
 501 }
 502
 503 template<Position::GamePhase Ph>
 504 inline Value Position::pst(Color c, PieceType pt, Square s) const {
 505   return (Ph == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
 506                         : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
 507 }
 508
 509 template<Position::GamePhase Ph>
 510 inline Value Position::pst_delta(Piece piece, Square from, Square to) const {
 511   return (Ph == MidGame ? MgPieceSquareTable[piece][to] - MgPieceSquareTable[piece][from]
 512                         : EgPieceSquareTable[piece][to] - EgPieceSquareTable[piece][from]);
 513 }
 514
 515 inline Value Position::mg_value() const {
 516   return st->mgValue;
 517 }
 518
 519 inline Value Position::eg_value() const {
 520   return st->egValue;
 521 }
 522
 523 inline Value Position::non_pawn_material(Color c) const {
 524   return st->npMaterial[c];
 525 }
 526
 527 inline Phase Position::game_phase() const {
 528
 529   // Values modified by Joona Kiiski
 530   static const Value MidgameLimit = Value(15581);
 531   static const Value EndgameLimit = Value(3998);
 532
 533   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
 534
 535   if (npm >= MidgameLimit)
 536       return PHASE_MIDGAME;
 537   else if(npm <= EndgameLimit)
 538       return PHASE_ENDGAME;
 539   else
 540       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
 541 }
 542
 543 inline bool Position::move_is_passed_pawn_push(Move m) const {
 544
 545   Color c = side_to_move();
 546   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
 547         && pawn_is_passed(c, move_to(m));
 548 }
 549
 550 inline int Position::rule_50_counter() const {
 551
 552   return st->rule50;
 553 }
 554
 555 inline bool Position::opposite_colored_bishops() const {
 556
 557   return   piece_count(WHITE, BISHOP) == 1
 558         && piece_count(BLACK, BISHOP) == 1
 559         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
 560 }
 561
 562 inline bool Position::has_pawn_on_7th(Color c) const {
 563
 564   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
 565 }
 566
 567 inline bool Position::move_is_capture(Move m) const {
 568
 569   // Move must not be MOVE_NONE !
 570
 571   return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
 572 }
 573
 574 #endif // !defined(POSITION_H_INCLUDED)