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