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