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 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   // Attack bitboards
 187   Bitboard sliding_attacks(Square s, Direction d) const;
 188   Bitboard ray_attacks(Square s, SignedDirection d) const;
 189   Bitboard pawn_attacks(Color c, Square s) const;
 190
 191   template<PieceType>
 192   Bitboard piece_attacks(Square s) const;
 193
 194   // Bitboards for pinned pieces and discovered check candidates
 195   Bitboard discovered_check_candidates(Color c) const;
 196   Bitboard pinned_pieces(Color c, Bitboard& p) const;
 197   Bitboard pinned_pieces(Color c) const;
 198
 199   // Checking pieces
 200   Bitboard checkers() const;
 201
 202   // Piece lists
 203   Square piece_list(Color c, PieceType pt, int index) const;
 204
 205   // Attack information for a given square
 206   bool square_is_attacked(Square s, Color c) const;
 207   Bitboard attacks_to(Square s) const;
 208   Bitboard attacks_to(Square s, Color c) const;
 209   bool is_check() const;
 210   bool pawn_attacks_square(Color c, Square f, Square t) const;
 211
 212   template<PieceType>
 213   Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
 214
 215   bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
 216
 217   // Properties of moves
 218   bool pl_move_is_legal(Move m) const;
 219   bool pl_move_is_legal(Move m, Bitboard pinned) const;
 220   bool move_is_check(Move m) const;
 221   bool move_is_check(Move m, Bitboard dcCandidates) const;
 222   bool move_is_capture(Move m) const;
 223   bool move_is_passed_pawn_push(Move m) const;
 224   bool move_attacks_square(Move m, Square s) const;
 225
 226   // Information about pawns
 227   bool pawn_is_passed(Color c, Square s) const;
 228   static bool pawn_is_passed(Bitboard theirPawns, Color c, Square s);
 229   static bool pawn_is_isolated(Bitboard ourPawns, Square s);
 230   static bool pawn_is_doubled(Bitboard ourPawns, Color c, Square s);
 231
 232   // Weak squares
 233   bool square_is_weak(Square s, Color c) const;
 234
 235   // Doing and undoing moves
 236   void saveState();
 237   void do_move(Move m, StateInfo& st);
 238   void do_move(Move m, StateInfo& st, Bitboard dcCandidates);
 239   void undo_move(Move m);
 240   void do_null_move(StateInfo& st);
 241   void undo_null_move();
 242
 243   // Static exchange evaluation
 244   int see(Square from, Square to) const;
 245   int see(Move m) const;
 246   int see(Square to) const;
 247   int see_sign(Move m) const;
 248
 249   // Accessing hash keys
 250   Key get_key() const;
 251   Key get_pawn_key() const;
 252   Key get_material_key() const;
 253
 254   // Incremental evaluation
 255   Value mg_value() const;
 256   Value eg_value() const;
 257   Value non_pawn_material(Color c) const;
 258   Phase game_phase() const;
 259   template<GamePhase> Value pst_delta(Piece piece, Square from, Square to) const;
 260
 261   // Game termination checks
 262   bool is_mate() const;
 263   bool is_draw() const;
 264
 265   // Check if one side threatens a mate in one
 266   bool has_mate_threat(Color c);
 267
 268   // Number of plies since the last non-reversible move
 269   int rule_50_counter() const;
 270
 271   // Other properties of the position
 272   bool opposite_colored_bishops() const;
 273   bool has_pawn_on_7th(Color c) const;
 274
 275   // Reset the gamePly variable to 0
 276   void reset_game_ply();
 277
 278   // Position consistency check, for debugging
 279   bool is_ok(int* failedStep = NULL) const;
 280
 281   // Static member functions:
 282   static void init_zobrist();
 283   static void init_piece_square_tables();
 284
 285 private:
 286
 287   // Initialization helper functions (used while setting up a position)
 288   void clear();
 289   void put_piece(Piece p, Square s);
 290   void allow_oo(Color c);
 291   void allow_ooo(Color c);
 292
 293   // Helper functions for doing and undoing moves
 294   void do_capture_move(Bitboard& key, PieceType capture, Color them, Square to, bool ep);
 295   void do_castle_move(Move m);
 296   void undo_castle_move(Move m);
 297   void find_checkers();
 298
 299   template<PieceType Piece>
 300   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
 301
 302   template<bool FindPinned>
 303   Bitboard hidden_checkers(Color c) const;
 304
 305   // Computing hash keys from scratch (for initialization and debugging)
 306   Key compute_key() const;
 307   Key compute_pawn_key() const;
 308   Key compute_material_key() const;
 309
 310   // Computing incremental evaluation scores and material counts
 311   template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
 312   template<GamePhase> Value compute_value() const;
 313   Value compute_non_pawn_material(Color c) const;
 314
 315   // Bitboards
 316   Bitboard byColorBB[2], byTypeBB[8];
 317
 318   // Board
 319   Piece board[64];
 320
 321   // Piece counts
 322   int pieceCount[2][8]; // [color][pieceType]
 323
 324   // Piece lists
 325   Square pieceList[2][8][16]; // [color][pieceType][index]
 326   int index[64]; // [square]
 327
 328   // Other info
 329   Square kingSquare[2];
 330   Color sideToMove;
 331   int gamePly;
 332   Key history[MaxGameLength];
 333   File initialKFile, initialKRFile, initialQRFile;
 334   StateInfo startState;
 335   StateInfo* st;
 336
 337   // Static variables
 338   static int castleRightsMask[64];
 339   static Key zobrist[2][8][64];
 340   static Key zobEp[64];
 341   static Key zobCastle[16];
 342   static Key zobMaterial[2][8][16];
 343   static Key zobSideToMove;
 344   static Value MgPieceSquareTable[16][64];
 345   static Value EgPieceSquareTable[16][64];
 346 };
 347
 348
 349 ////
 350 //// Inline functions
 351 ////
 352
 353 inline Piece Position::piece_on(Square s) const {
 354   return board[s];
 355 }
 356
 357 inline Color Position::color_of_piece_on(Square s) const {
 358   return color_of_piece(piece_on(s));
 359 }
 360
 361 inline PieceType Position::type_of_piece_on(Square s) const {
 362   return type_of_piece(piece_on(s));
 363 }
 364
 365 inline bool Position::square_is_empty(Square s) const {
 366   return piece_on(s) == EMPTY;
 367 }
 368
 369 inline bool Position::square_is_occupied(Square s) const {
 370   return !square_is_empty(s);
 371 }
 372
 373 inline Value Position::midgame_value_of_piece_on(Square s) const {
 374   return piece_value_midgame(piece_on(s));
 375 }
 376
 377 inline Value Position::endgame_value_of_piece_on(Square s) const {
 378   return piece_value_endgame(piece_on(s));
 379 }
 380
 381 inline Color Position::side_to_move() const {
 382   return sideToMove;
 383 }
 384
 385 inline Bitboard Position::occupied_squares() const {
 386   return byTypeBB[0];
 387 }
 388
 389 inline Bitboard Position::empty_squares() const {
 390   return ~(occupied_squares());
 391 }
 392
 393 inline Bitboard Position::pieces_of_color(Color c) const {
 394   return byColorBB[c];
 395 }
 396
 397 inline Bitboard Position::pieces(PieceType pt) const {
 398   return byTypeBB[pt];
 399 }
 400
 401 inline Bitboard Position::pieces(PieceType pt, Color c) const {
 402   return byTypeBB[pt] & byColorBB[c];
 403 }
 404
 405 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 406   return byTypeBB[pt1] | byTypeBB[pt2];
 407 }
 408
 409 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
 410   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
 411 }
 412
 413 inline int Position::piece_count(Color c, PieceType pt) const {
 414   return pieceCount[c][pt];
 415 }
 416
 417 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
 418   return pieceList[c][pt][index];
 419 }
 420
 421 inline Square Position::ep_square() const {
 422   return st->epSquare;
 423 }
 424
 425 inline Square Position::king_square(Color c) const {
 426   return kingSquare[c];
 427 }
 428
 429 inline bool Position::can_castle_kingside(Color side) const {
 430   return st->castleRights & (1+int(side));
 431 }
 432
 433 inline bool Position::can_castle_queenside(Color side) const {
 434   return st->castleRights & (4+4*int(side));
 435 }
 436
 437 inline bool Position::can_castle(Color side) const {
 438   return can_castle_kingside(side) || can_castle_queenside(side);
 439 }
 440
 441 inline Square Position::initial_kr_square(Color c) const {
 442   return relative_square(c, make_square(initialKRFile, RANK_1));
 443 }
 444
 445 inline Square Position::initial_qr_square(Color c) const {
 446   return relative_square(c, make_square(initialQRFile, RANK_1));
 447 }
 448
 449 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
 450   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
 451 }
 452
 453 template<PieceType Piece> // Knight and King
 454 inline Bitboard Position::piece_attacks(Square s) const {
 455   return StepAttackBB[Piece][s];
 456 }
 457
 458 template<>
 459 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
 460   return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
 461 }
 462
 463 template<>
 464 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
 465   return bishop_attacks_bb(s, occupied_squares());
 466 }
 467
 468 template<>
 469 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
 470   return rook_attacks_bb(s, occupied_squares());
 471 }
 472
 473 template<>
 474 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
 475   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
 476 }
 477
 478 inline Bitboard Position::checkers() const {
 479   return st->checkersBB;
 480 }
 481
 482 inline bool Position::is_check() const {
 483   return st->checkersBB != EmptyBoardBB;
 484 }
 485
 486 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
 487   return bit_is_set(pawn_attacks(c, f), t);
 488 }
 489
 490 template<PieceType Piece>
 491 inline Bitboard Position::piece_attacks_square(Square f, Square t) const {
 492   return bit_is_set(piece_attacks<Piece>(f), t);
 493 }
 494
 495 inline Bitboard Position::attacks_to(Square s, Color c) const {
 496
 497   return attacks_to(s) & pieces_of_color(c);
 498 }
 499
 500 inline bool Position::square_is_attacked(Square s, Color c) const {
 501
 502   return attacks_to(s, c) != EmptyBoardBB;
 503 }
 504
 505 inline bool Position::pawn_is_passed(Color c, Square s) const {
 506   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
 507 }
 508
 509 inline bool Position::pawn_is_passed(Bitboard theirPawns, Color c, Square s) {
 510   return !(theirPawns & passed_pawn_mask(c, s));
 511 }
 512
 513 inline bool Position::pawn_is_isolated(Bitboard ourPawns, Square s) {
 514   return !(ourPawns & neighboring_files_bb(s));
 515 }
 516
 517 inline bool Position::pawn_is_doubled(Bitboard ourPawns, Color c, Square s) {
 518   return ourPawns & squares_behind(c, s);
 519 }
 520
 521 inline bool Position::square_is_weak(Square s, Color c) const {
 522   return !(pieces(PAWN, c) & outpost_mask(opposite_color(c), s));
 523 }
 524
 525 inline Key Position::get_key() const {
 526   return st->key;
 527 }
 528
 529 inline Key Position::get_pawn_key() const {
 530   return st->pawnKey;
 531 }
 532
 533 inline Key Position::get_material_key() const {
 534   return st->materialKey;
 535 }
 536
 537 template<Position::GamePhase Ph>
 538 inline Value Position::pst(Color c, PieceType pt, Square s) const {
 539   return (Ph == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
 540                         : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
 541 }
 542
 543 template<Position::GamePhase Ph>
 544 inline Value Position::pst_delta(Piece piece, Square from, Square to) const {
 545   return (Ph == MidGame ? MgPieceSquareTable[piece][to] - MgPieceSquareTable[piece][from]
 546                         : EgPieceSquareTable[piece][to] - EgPieceSquareTable[piece][from]);
 547 }
 548
 549 inline Value Position::mg_value() const {
 550   return st->mgValue;
 551 }
 552
 553 inline Value Position::eg_value() const {
 554   return st->egValue;
 555 }
 556
 557 inline Value Position::non_pawn_material(Color c) const {
 558   return st->npMaterial[c];
 559 }
 560
 561 inline Phase Position::game_phase() const {
 562
 563   // Values modified by Joona Kiiski
 564   static const Value MidgameLimit = Value(15581);
 565   static const Value EndgameLimit = Value(3998);
 566
 567   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
 568
 569   if (npm >= MidgameLimit)
 570       return PHASE_MIDGAME;
 571   else if(npm <= EndgameLimit)
 572       return PHASE_ENDGAME;
 573   else
 574       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
 575 }
 576
 577 inline bool Position::move_is_passed_pawn_push(Move m) const {
 578
 579   Color c = side_to_move();
 580   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
 581         && pawn_is_passed(c, move_to(m));
 582 }
 583
 584 inline int Position::rule_50_counter() const {
 585
 586   return st->rule50;
 587 }
 588
 589 inline bool Position::opposite_colored_bishops() const {
 590
 591   return   piece_count(WHITE, BISHOP) == 1
 592         && piece_count(BLACK, BISHOP) == 1
 593         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
 594 }
 595
 596 inline bool Position::has_pawn_on_7th(Color c) const {
 597
 598   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
 599 }
 600
 601 inline bool Position::move_is_capture(Move m) const {
 602
 603   // Move must not be MOVE_NONE !
 604
 605   return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
 606 }
 607
 608 #endif // !defined(POSITION_H_INCLUDED)