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 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 a 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) \r
  29 \r
  30 #endif
  31
  32 ////
  33 //// Includes
  34 ////
  35
  36 #include "bitboard.h"
  37 #include "color.h"
  38 #include "direction.h"
  39 #include "move.h"
  40 #include "piece.h"
  41 #include "phase.h"
  42 #include "square.h"
  43 #include "value.h"
  44
  45
  46 ////
  47 //// Constants
  48 ////
  49
  50 /// FEN string for the initial position:
  51 const std::string StartPosition =
  52   "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
  53
  54 /// Maximum number of plies per game (220 should be enough, because the
  55 /// maximum search depth is 100, and during position setup we reset the
  56 /// move counter for every non-reversible move):
  57 const int MaxGameLength = 220;
  58
  59
  60 ////
  61 //// Types
  62 ////
  63
  64 /// Castle rights, encoded as bit fields:
  65
  66 enum CastleRights {
  67   NO_CASTLES = 0,
  68   WHITE_OO = 1,
  69   BLACK_OO = 2,
  70   WHITE_OOO = 4,
  71   BLACK_OOO = 8,
  72   ALL_CASTLES = 15
  73 };
  74
  75
  76 /// The UndoInfo struct stores information we need to restore a Position
  77 /// object to its previous state when we retract a move.  Whenever a move
  78 /// is made on the board (by calling Position::do_move), an UndoInfo object
  79 /// must be passed as a parameter.  When the move is unmade (by calling
  80 /// Position::undo_move), the same UndoInfo object must be passed again.
  81
  82 struct UndoInfo {
  83   int castleRights;
  84   Square epSquare;
  85   Bitboard checkersBB;
  86   Key key, pawnKey, materialKey;
  87   int rule50;
  88   Move lastMove;
  89   PieceType capture;
  90   Value mgValue, egValue;
  91 };
  92
  93
  94 /// The position data structure.  A position consists of the following data:
  95 ///
  96 ///    * For each piece type, a bitboard representing the squares occupied
  97 ///      by pieces of that type.
  98 ///    * For each color, a bitboard representing the squares occupiecd by
  99 ///      pieces of that color.
 100 ///    * A bitboard of all occupied squares.
 101 ///    * A bitboard of all checking pieces.
 102 ///    * A 64-entry array of pieces, indexed by the squares of the board.
 103 ///    * The current side to move.
 104 ///    * Information about the castling rights for both sides.
 105 ///    * The initial files of the kings and both pairs of rooks.  This is
 106 ///      used to implement the Chess960 castling rules.
 107 ///    * The en passant square (which is SQ_NONE if no en passant capture is
 108 ///      possible).
 109 ///    * The squares of the kings for both sides.
 110 ///    * The last move played.
 111 ///    * Hash keys for the position itself, the current pawn structure, and
 112 ///      the current material situation.
 113 ///    * Hash keys for all previous positions in the game (for detecting
 114 ///      repetition draws.
 115 ///    * A counter for detecting 50 move rule draws.
 116
 117 class Position {
 118
 119   friend class MaterialInfo;
 120
 121 public:
 122   // Constructors
 123   Position() {};
 124   Position(const Position &pos);
 125   Position(const std::string &fen);
 126
 127   // Text input/output
 128   void from_fen(const std::string &fen);
 129   const std::string to_fen() const;
 130   void print() const;
 131
 132   // Copying
 133   void copy(const Position &pos);
 134   void flipped_copy(const Position &pos);
 135
 136   // The piece on a given square
 137   Piece piece_on(Square s) const;
 138   PieceType type_of_piece_on(Square s) const;
 139   Color color_of_piece_on(Square s) const;
 140   bool square_is_empty(Square s) const;
 141   bool square_is_occupied(Square s) const;
 142   Value midgame_value_of_piece_on(Square s) const;
 143   Value endgame_value_of_piece_on(Square s) const;
 144
 145   // Side to move
 146   Color side_to_move() const;
 147
 148   // Bitboard representation of the position
 149   Bitboard empty_squares() const;
 150   Bitboard occupied_squares() const;
 151   Bitboard pieces_of_color(Color c) const;
 152   Bitboard pieces_of_type(PieceType pt) const;
 153   Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
 154   Bitboard pawns() const;
 155   Bitboard knights() const;
 156   Bitboard bishops() const;
 157   Bitboard rooks() const;
 158   Bitboard queens() const;
 159   Bitboard kings() const;
 160   Bitboard rooks_and_queens() const;
 161   Bitboard bishops_and_queens() const;
 162   Bitboard sliders() const;
 163   Bitboard pawns(Color c) const;
 164   Bitboard knights(Color c) const;
 165   Bitboard bishops(Color c) const;
 166   Bitboard rooks(Color c) const;
 167   Bitboard queens(Color c) const;
 168   Bitboard kings(Color c) const;
 169   Bitboard rooks_and_queens(Color c) const;
 170   Bitboard bishops_and_queens(Color c) const;
 171   Bitboard sliders_of_color(Color c) const;
 172
 173   // Number of pieces of each color and type
 174   int piece_count(Color c, PieceType pt) const;
 175
 176   // The en passant square:
 177   Square ep_square() const;
 178
 179   // Current king position for each color
 180   Square king_square(Color c) const;
 181
 182   // Castling rights.
 183   bool can_castle_kingside(Color c) const;
 184   bool can_castle_queenside(Color c) const;
 185   bool can_castle(Color c) const;
 186   Square initial_kr_square(Color c) const;
 187   Square initial_qr_square(Color c) const;
 188
 189   // Attack bitboards
 190   Bitboard sliding_attacks(Square s, Direction d) const;
 191   Bitboard ray_attacks(Square s, SignedDirection d) const;
 192   Bitboard pawn_attacks(Color c, Square s) const;
 193
 194   template<PieceType>
 195   Bitboard piece_attacks(Square s) const;
 196
 197   // Bitboards for pinned pieces and discovered check candidates
 198   Bitboard discovered_check_candidates(Color c) const;
 199   Bitboard pinned_pieces(Color c) const;
 200
 201   // Checking pieces
 202   Bitboard checkers() const;
 203
 204   // Piece lists
 205   Square piece_list(Color c, PieceType pt, int index) const;
 206
 207   // Attack information for a given square
 208   bool square_is_attacked(Square s, Color c) const;
 209   Bitboard attacks_to(Square s) const;
 210   Bitboard attacks_to(Square s, Color c) const;
 211   bool is_check() const;
 212   bool pawn_attacks_square(Color c, Square f, Square t) const;
 213
 214   template<PieceType>
 215   Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
 216
 217   bool piece_attacks_square(Square f, Square t) const; // Dispatch at run-time
 218
 219   // Properties of moves
 220   bool move_is_legal(Move m) const;
 221   bool move_is_legal(Move m, Bitboard pinned) const;
 222   bool move_is_check(Move m) const;
 223   bool move_is_check(Move m, Bitboard dcCandidates) const;
 224   bool move_is_capture(Move m) const;
 225   bool move_is_deep_pawn_push(Move m) const;
 226   bool move_is_pawn_push_to_7th(Move m) const;
 227   bool move_is_passed_pawn_push(Move m) const;
 228   bool move_was_passed_pawn_push(Move m) const;
 229   bool move_attacks_square(Move m, Square s) const;
 230
 231   // Information about pawns
 232   bool pawn_is_passed(Color c, Square s) const;
 233   bool pawn_is_isolated(Color c, Square s) const;
 234   bool pawn_is_doubled(Color c, Square s) const;
 235
 236   // Open and half-open files
 237   bool file_is_open(File f) const;
 238   bool file_is_half_open(Color c, File f) const;
 239
 240   // Weak squares
 241   bool square_is_weak(Square s, Color c) const;
 242
 243   // Doing and undoing moves
 244   void backup(UndoInfo &u) const;
 245   void restore(const UndoInfo &u);
 246   void do_move(Move m, UndoInfo &u);
 247   void do_move(Move m, UndoInfo &u, Bitboard dcCandidates);
 248   void undo_move(Move m, const UndoInfo &u);
 249   void do_null_move(UndoInfo &u);
 250   void undo_null_move(const UndoInfo &u);
 251
 252   // Static exchange evaluation
 253   int see(Square from, Square to) const;
 254   int see(Move m) const;
 255
 256   // Accessing hash keys
 257   Key get_key() const;
 258   Key get_pawn_key() const;
 259   Key get_material_key() const;
 260
 261   // Incremental evaluation
 262   Value mg_value() const;
 263   Value eg_value() const;
 264   Value non_pawn_material(Color c) const;
 265   Phase game_phase() const;
 266   Value mg_pst_delta(Move m) const;
 267
 268   // Game termination checks
 269   bool is_mate();
 270   bool is_draw() const;
 271
 272   // Check if one side threatens a mate in one
 273   bool has_mate_threat(Color c);
 274
 275   // Number of plies since the last non-reversible move
 276   int rule_50_counter() const;
 277
 278   // Other properties of the position
 279   bool opposite_colored_bishops() const;
 280   bool has_pawn_on_7th(Color c) const;
 281
 282   // Reset the gamePly variable to 0
 283   void reset_game_ply();
 284
 285   // Position consistency check, for debugging
 286   bool is_ok(int* failedStep = NULL) const;
 287
 288   // Static member functions:
 289   static void init_zobrist();
 290   static void init_piece_square_tables();
 291
 292 private:
 293   // Initialization helper functions (used while setting up a position)
 294   void clear();
 295   void put_piece(Piece p, Square s);
 296   void allow_oo(Color c);
 297   void allow_ooo(Color c);
 298
 299   // Helper functions for doing and undoing moves
 300   void do_castle_move(Move m);
 301   void do_promotion_move(Move m, UndoInfo &u);
 302   void do_ep_move(Move m);
 303   void undo_castle_move(Move m);
 304   void undo_promotion_move(Move m, const UndoInfo &u);
 305   void undo_ep_move(Move m);
 306   void find_checkers();
 307
 308   template<PieceType Piece, bool FindPinned>
 309   Bitboard hidden_checks(Color c, Square ksq) const;
 310
 311   // Computing hash keys from scratch (for initialization and debugging)
 312   Key compute_key() const;
 313   Key compute_pawn_key() const;
 314   Key compute_material_key() const;
 315
 316   // Computing incremental evaluation scores and material counts
 317   Value mg_pst(Color c, PieceType pt, Square s) const;
 318   Value eg_pst(Color c, PieceType pt, Square s) const;
 319   Value compute_mg_value() const;
 320   Value compute_eg_value() const;
 321   Value compute_non_pawn_material(Color c) const;
 322
 323   // Bitboards
 324   Bitboard byColorBB[2], byTypeBB[8];
 325   Bitboard checkersBB;
 326
 327   // Board
 328   Piece board[64];
 329
 330   // Piece counts
 331   int pieceCount[2][8]; // [color][pieceType]
 332
 333   // Piece lists
 334   Square pieceList[2][8][16]; // [color][pieceType][index]
 335   int index[64];
 336
 337   // Other info
 338   Color sideToMove;
 339   int castleRights;
 340   File initialKFile, initialKRFile, initialQRFile;
 341   Square epSquare;
 342   Square kingSquare[2];
 343   Move lastMove;
 344   Key key, pawnKey, materialKey, history[MaxGameLength];
 345   int rule50, gamePly;
 346   Value mgValue, egValue;
 347   Value npMaterial[2];
 348
 349   // Static variables
 350   static int castleRightsMask[64];
 351   static Key zobrist[2][8][64];
 352   static Key zobEp[64];
 353   static Key zobCastle[16];
 354   static Key zobMaterial[2][8][16];
 355   static Key zobSideToMove;
 356   static Value MgPieceSquareTable[16][64];
 357   static Value EgPieceSquareTable[16][64];
 358 };
 359
 360
 361 ////
 362 //// Inline functions
 363 ////
 364
 365 inline Piece Position::piece_on(Square s) const {
 366   return board[s];
 367 }
 368
 369 inline Color Position::color_of_piece_on(Square s) const {
 370   return color_of_piece(piece_on(s));
 371 }
 372
 373 inline PieceType Position::type_of_piece_on(Square s) const {
 374   return type_of_piece(piece_on(s));
 375 }
 376
 377 inline bool Position::square_is_empty(Square s) const {
 378   return piece_on(s) == EMPTY;
 379 }
 380
 381 inline bool Position::square_is_occupied(Square s) const {
 382   return !square_is_empty(s);
 383 }
 384
 385 inline Value Position::midgame_value_of_piece_on(Square s) const {
 386   return piece_value_midgame(piece_on(s));
 387 }
 388
 389 inline Value Position::endgame_value_of_piece_on(Square s) const {
 390   return piece_value_endgame(piece_on(s));
 391 }
 392
 393 inline Color Position::side_to_move() const {
 394   return sideToMove;
 395 }
 396
 397 inline Bitboard Position::occupied_squares() const {
 398   return byTypeBB[0];
 399 }
 400
 401 inline Bitboard Position::empty_squares() const {
 402   return ~(occupied_squares());
 403 }
 404
 405 inline Bitboard Position::pieces_of_color(Color c) const {
 406   return byColorBB[c];
 407 }
 408
 409 inline Bitboard Position::pieces_of_type(PieceType pt) const {
 410   return byTypeBB[pt];
 411 }
 412
 413 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
 414   return pieces_of_color(c) & pieces_of_type(pt);
 415 }
 416
 417 inline Bitboard Position::pawns() const {
 418   return pieces_of_type(PAWN);
 419 }
 420
 421 inline Bitboard Position::knights() const {
 422   return pieces_of_type(KNIGHT);
 423 }
 424
 425 inline Bitboard Position::bishops() const {
 426   return pieces_of_type(BISHOP);
 427 }
 428
 429 inline Bitboard Position::rooks() const {
 430   return pieces_of_type(ROOK);
 431 }
 432
 433 inline Bitboard Position::queens() const {
 434   return pieces_of_type(QUEEN);
 435 }
 436
 437 inline Bitboard Position::kings() const {
 438   return pieces_of_type(KING);
 439 }
 440
 441 inline Bitboard Position::rooks_and_queens() const {
 442   return rooks() | queens();
 443 }
 444
 445 inline Bitboard Position::bishops_and_queens() const {
 446   return bishops() | queens();
 447 }
 448
 449 inline Bitboard Position::sliders() const {
 450   return bishops() | queens() | rooks();
 451 }
 452
 453 inline Bitboard Position::pawns(Color c) const {
 454   return pieces_of_color_and_type(c, PAWN);
 455 }
 456
 457 inline Bitboard Position::knights(Color c) const {
 458   return pieces_of_color_and_type(c, KNIGHT);
 459 }
 460
 461 inline Bitboard Position::bishops(Color c) const {
 462   return pieces_of_color_and_type(c, BISHOP);
 463 }
 464
 465 inline Bitboard Position::rooks(Color c) const {
 466   return pieces_of_color_and_type(c, ROOK);
 467 }
 468
 469 inline Bitboard Position::queens(Color c) const {
 470   return pieces_of_color_and_type(c, QUEEN);
 471 }
 472
 473 inline Bitboard Position::kings(Color c) const {
 474   return pieces_of_color_and_type(c, KING);
 475 }
 476
 477 inline Bitboard Position::rooks_and_queens(Color c) const {
 478   return rooks_and_queens() & pieces_of_color(c);
 479 }
 480
 481 inline Bitboard Position::bishops_and_queens(Color c) const {
 482   return bishops_and_queens() & pieces_of_color(c);
 483 }
 484
 485 inline Bitboard Position::sliders_of_color(Color c) const {
 486   return sliders() & pieces_of_color(c);
 487 }
 488
 489 inline int Position::piece_count(Color c, PieceType pt) const {
 490   return pieceCount[c][pt];
 491 }
 492
 493 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
 494   return pieceList[c][pt][index];
 495 }
 496
 497 inline Square Position::ep_square() const {
 498   return epSquare;
 499 }
 500
 501 inline Square Position::king_square(Color c) const {
 502   return kingSquare[c];
 503 }
 504
 505 inline bool Position::can_castle_kingside(Color side) const {
 506   return castleRights & (1+int(side));
 507 }
 508
 509 inline bool Position::can_castle_queenside(Color side) const {
 510   return castleRights & (4+4*int(side));
 511 }
 512
 513 inline bool Position::can_castle(Color side) const {
 514   return can_castle_kingside(side) || can_castle_queenside(side);
 515 }
 516
 517 inline Square Position::initial_kr_square(Color c) const {
 518   return relative_square(c, make_square(initialKRFile, RANK_1));
 519 }
 520
 521 inline Square Position::initial_qr_square(Color c) const {
 522   return relative_square(c, make_square(initialQRFile, RANK_1));
 523 }
 524
 525 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
 526   return StepAttackBB[pawn_of_color(c)][s];
 527 }
 528
 529 template<>
 530 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
 531   return StepAttackBB[KNIGHT][s];
 532 }
 533
 534 template<>
 535 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
 536   return bishop_attacks_bb(s, occupied_squares());
 537 }
 538
 539 template<>
 540 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
 541   return rook_attacks_bb(s, occupied_squares());
 542 }
 543
 544 template<>
 545 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
 546   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
 547 }
 548
 549 template<>
 550 inline Bitboard Position::piece_attacks<KING>(Square s) const {
 551   return StepAttackBB[KING][s];
 552 }
 553
 554 inline Bitboard Position::checkers() const {
 555   return checkersBB;
 556 }
 557
 558 inline bool Position::is_check() const {
 559   return checkersBB != EmptyBoardBB;
 560 }
 561
 562 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
 563   return bit_is_set(pawn_attacks(c, f), t);
 564 }
 565
 566 template<PieceType Piece>
 567 Bitboard Position::piece_attacks_square(Square f, Square t) const {
 568   return bit_is_set(piece_attacks<Piece>(f), t);
 569 }
 570
 571 inline bool Position::pawn_is_passed(Color c, Square s) const {
 572   return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
 573 }
 574
 575 inline bool Position::pawn_is_isolated(Color c, Square s) const {
 576   return !(pawns(c) & neighboring_files_bb(s));
 577 }
 578
 579 inline bool Position::pawn_is_doubled(Color c, Square s) const {
 580   return pawns(c) & squares_behind(c, s);
 581 }
 582
 583 inline bool Position::file_is_open(File f) const {
 584   return !(pawns() & file_bb(f));
 585 }
 586
 587 inline bool Position::file_is_half_open(Color c, File f) const {
 588   return !(pawns(c) & file_bb(f));
 589 }
 590
 591 inline bool Position::square_is_weak(Square s, Color c) const {
 592   return !(pawns(c) & outpost_mask(opposite_color(c), s));
 593 }
 594
 595 inline Key Position::get_key() const {
 596   return key;
 597 }
 598
 599 inline Key Position::get_pawn_key() const {
 600   return pawnKey;
 601 }
 602
 603 inline Key Position::get_material_key() const {
 604   return materialKey;
 605 }
 606
 607 inline Value Position::mg_pst(Color c, PieceType pt, Square s) const {
 608   return MgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
 609 }
 610
 611 inline Value Position::mg_pst_delta(Move m) const {
 612   return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
 613         -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
 614 }
 615
 616 inline Value Position::eg_pst(Color c, PieceType pt, Square s) const {
 617   return EgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
 618 }
 619
 620 inline Value Position::mg_value() const {
 621   return mgValue;
 622 }
 623
 624 inline Value Position::eg_value() const {
 625   return egValue;
 626 }
 627
 628 inline Value Position::non_pawn_material(Color c) const {
 629   return npMaterial[c];
 630 }
 631
 632 inline Phase Position::game_phase() const {
 633
 634   // The purpose of the Value(325) terms below is to make sure the difference
 635   // between MidgameLimit and EndgameLimit is a power of 2, which should make
 636   // the division at the end of the function a bit faster.
 637   static const Value MidgameLimit =  2 * QueenValueMidgame
 638                                    + 2 * RookValueMidgame
 639                                    + 6 * BishopValueMidgame
 640                                    + Value(325);
 641
 642   static const Value EndgameLimit = 4 * RookValueMidgame - Value(325);
 643
 644   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
 645
 646   if (npm >= MidgameLimit)
 647       return PHASE_MIDGAME;
 648   else if(npm <= EndgameLimit)
 649       return PHASE_ENDGAME;
 650   else
 651       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
 652 }
 653
 654 inline bool Position::move_is_deep_pawn_push(Move m) const {
 655
 656   Color c = side_to_move();
 657   return   piece_on(move_from(m)) == pawn_of_color(c)
 658         && relative_rank(c, move_to(m)) > RANK_4;
 659 }
 660
 661 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
 662
 663   Color c = side_to_move();
 664   return   piece_on(move_from(m)) == pawn_of_color(c)
 665         && relative_rank(c, move_to(m)) == RANK_7;
 666 }
 667
 668 inline bool Position::move_is_passed_pawn_push(Move m) const {
 669
 670   Color c = side_to_move();
 671   return   piece_on(move_from(m)) == pawn_of_color(c)
 672         && pawn_is_passed(c, move_to(m));
 673 }
 674
 675 inline bool Position::move_was_passed_pawn_push(Move m) const {
 676
 677   Color c = opposite_color(side_to_move());
 678   return   piece_on(move_to(m)) == pawn_of_color(c)
 679         && pawn_is_passed(c, move_to(m));
 680 }
 681
 682 inline int Position::rule_50_counter() const {
 683
 684   return rule50;
 685 }
 686
 687 inline bool Position::opposite_colored_bishops() const {
 688
 689   return   piece_count(WHITE, BISHOP) == 1
 690         && piece_count(BLACK, BISHOP) == 1
 691         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
 692 }
 693
 694 inline bool Position::has_pawn_on_7th(Color c) const {
 695
 696   return pawns(c) & relative_rank_bb(c, RANK_7);
 697 }
 698
 699
 700 #endif // !defined(POSITION_H_INCLUDED)