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-2013 Marco Costalba, Joona Kiiski, Tord Romstad
   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 #ifndef POSITION_H_INCLUDED
  21 #define POSITION_H_INCLUDED
  22
  23 #include <cassert>
  24 #include <cstddef>
  25
  26 #include "bitboard.h"
  27 #include "types.h"
  28
  29
  30 /// The checkInfo struct is initialized at c'tor time and keeps info used
  31 /// to detect if a move gives check.
  32 class Position;
  33 struct Thread;
  34
  35 struct CheckInfo {
  36
  37   explicit CheckInfo(const Position&);
  38
  39   Bitboard dcCandidates;
  40   Bitboard pinned;
  41   Bitboard checkSq[PIECE_TYPE_NB];
  42   Square ksq;
  43 };
  44
  45
  46 /// The StateInfo struct stores information needed to restore a Position
  47 /// object to its previous state when we retract a move. Whenever a move
  48 /// is made on the board (by calling Position::do_move), a StateInfo
  49 /// object must be passed as a parameter.
  50
  51 struct StateInfo {
  52   Key pawnKey, materialKey;
  53   Value npMaterial[COLOR_NB];
  54   int castleRights, rule50, pliesFromNull;
  55   Score psq;
  56   Square epSquare;
  57
  58   Key key;
  59   Bitboard checkersBB;
  60   PieceType capturedType;
  61   StateInfo* previous;
  62 };
  63
  64
  65 /// When making a move the current StateInfo up to 'key' excluded is copied to
  66 /// the new one. Here we calculate the quad words (64bits) needed to be copied.
  67 const size_t StateCopySize64 = offsetof(StateInfo, key) / sizeof(uint64_t) + 1;
  68
  69
  70 /// The Position class stores the information regarding the board representation
  71 /// like pieces, side to move, hash keys, castling info, etc. The most important
  72 /// methods are do_move() and undo_move(), used by the search to update node info
  73 /// when traversing the search tree.
  74
  75 class Position {
  76 public:
  77   Position() {}
  78   Position(const Position& p, Thread* t) { *this = p; thisThread = t; }
  79   Position(const std::string& f, bool c960, Thread* t) { set(f, c960, t); }
  80   Position& operator=(const Position&);
  81   static void init();
  82
  83   // Text input/output
  84   void set(const std::string& fen, bool isChess960, Thread* th);
  85   const std::string fen() const;
  86   const std::string pretty(Move m = MOVE_NONE) const;
  87
  88   // Position representation
  89   Bitboard pieces() const;
  90   Bitboard pieces(PieceType pt) const;
  91   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  92   Bitboard pieces(Color c) const;
  93   Bitboard pieces(Color c, PieceType pt) const;
  94   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  95   Piece piece_on(Square s) const;
  96   Square king_square(Color c) const;
  97   Square ep_square() const;
  98   bool empty(Square s) const;
  99   template<PieceType Pt> int count(Color c) const;
 100   template<PieceType Pt> const Square* list(Color c) const;
 101
 102   // Castling
 103   int can_castle(CastleRight f) const;
 104   int can_castle(Color c) const;
 105   bool castle_impeded(Color c, CastlingSide s) const;
 106   Square castle_rook_square(Color c, CastlingSide s) const;
 107
 108   // Checking
 109   Bitboard checkers() const;
 110   Bitboard discovered_check_candidates() const;
 111   Bitboard pinned_pieces() const;
 112
 113   // Attacks to/from a given square
 114   Bitboard attackers_to(Square s) const;
 115   Bitboard attackers_to(Square s, Bitboard occ) const;
 116   Bitboard attacks_from(Piece p, Square s) const;
 117   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
 118   template<PieceType> Bitboard attacks_from(Square s) const;
 119   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 120
 121   // Properties of moves
 122   bool legal(Move m, Bitboard pinned) const;
 123   bool pseudo_legal(const Move m) const;
 124   bool capture(Move m) const;
 125   bool capture_or_promotion(Move m) const;
 126   bool gives_check(Move m, const CheckInfo& ci) const;
 127   bool passed_pawn_push(Move m) const;
 128   Piece moved_piece(Move m) const;
 129   PieceType captured_piece_type() const;
 130
 131   // Piece specific
 132   bool pawn_passed(Color c, Square s) const;
 133   bool pawn_on_7th(Color c) const;
 134   bool bishop_pair(Color c) const;
 135   bool opposite_bishops() const;
 136
 137   // Doing and undoing moves
 138   void do_move(Move m, StateInfo& st);
 139   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 140   void undo_move(Move m);
 141   void do_null_move(StateInfo& st);
 142   void undo_null_move();
 143
 144   // Static exchange evaluation
 145   int see(Move m, int asymmThreshold = 0) const;
 146   int see_sign(Move m) const;
 147
 148   // Accessing hash keys
 149   Key key() const;
 150   Key exclusion_key() const;
 151   Key pawn_key() const;
 152   Key material_key() const;
 153
 154   // Incremental piece-square evaluation
 155   Score psq_score() const;
 156   Value non_pawn_material(Color c) const;
 157
 158   // Other properties of the position
 159   Color side_to_move() const;
 160   int game_ply() const;
 161   bool is_chess960() const;
 162   Thread* this_thread() const;
 163   int64_t nodes_searched() const;
 164   void set_nodes_searched(int64_t n);
 165   bool is_draw() const;
 166
 167   // Position consistency check, for debugging
 168   bool pos_is_ok(int* failedStep = NULL) const;
 169   void flip();
 170
 171 private:
 172   // Initialization helpers (used while setting up a position)
 173   void clear();
 174   void set_castle_right(Color c, Square rfrom);
 175
 176   // Helper functions
 177   void do_castle(Square kfrom, Square kto, Square rfrom, Square rto);
 178   Bitboard hidden_checkers(Square ksq, Color c) const;
 179   void put_piece(Square s, Color c, PieceType pt);
 180   void remove_piece(Square s, Color c, PieceType pt);
 181   void move_piece(Square from, Square to, Color c, PieceType pt);
 182
 183   // Computing hash keys from scratch (for initialization and debugging)
 184   Key compute_key() const;
 185   Key compute_pawn_key() const;
 186   Key compute_material_key() const;
 187
 188   // Computing incremental evaluation scores and material counts
 189   Score compute_psq_score() const;
 190   Value compute_non_pawn_material(Color c) const;
 191
 192   // Board and pieces
 193   Piece board[SQUARE_NB];
 194   Bitboard byTypeBB[PIECE_TYPE_NB];
 195   Bitboard byColorBB[COLOR_NB];
 196   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
 197   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
 198   int index[SQUARE_NB];
 199
 200   // Other info
 201   int castleRightsMask[SQUARE_NB];
 202   Square castleRookSquare[COLOR_NB][CASTLING_SIDE_NB];
 203   Bitboard castlePath[COLOR_NB][CASTLING_SIDE_NB];
 204   StateInfo startState;
 205   int64_t nodes;
 206   int gamePly;
 207   Color sideToMove;
 208   Thread* thisThread;
 209   StateInfo* st;
 210   int chess960;
 211 };
 212
 213 inline int64_t Position::nodes_searched() const {
 214   return nodes;
 215 }
 216
 217 inline void Position::set_nodes_searched(int64_t n) {
 218   nodes = n;
 219 }
 220
 221 inline Piece Position::piece_on(Square s) const {
 222   return board[s];
 223 }
 224
 225 inline Piece Position::moved_piece(Move m) const {
 226   return board[from_sq(m)];
 227 }
 228
 229 inline bool Position::empty(Square s) const {
 230   return board[s] == NO_PIECE;
 231 }
 232
 233 inline Color Position::side_to_move() const {
 234   return sideToMove;
 235 }
 236
 237 inline Bitboard Position::pieces() const {
 238   return byTypeBB[ALL_PIECES];
 239 }
 240
 241 inline Bitboard Position::pieces(PieceType pt) const {
 242   return byTypeBB[pt];
 243 }
 244
 245 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 246   return byTypeBB[pt1] | byTypeBB[pt2];
 247 }
 248
 249 inline Bitboard Position::pieces(Color c) const {
 250   return byColorBB[c];
 251 }
 252
 253 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 254   return byColorBB[c] & byTypeBB[pt];
 255 }
 256
 257 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 258   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
 259 }
 260
 261 template<PieceType Pt> inline int Position::count(Color c) const {
 262   return pieceCount[c][Pt];
 263 }
 264
 265 template<PieceType Pt> inline const Square* Position::list(Color c) const {
 266   return pieceList[c][Pt];
 267 }
 268
 269 inline Square Position::ep_square() const {
 270   return st->epSquare;
 271 }
 272
 273 inline Square Position::king_square(Color c) const {
 274   return pieceList[c][KING][0];
 275 }
 276
 277 inline int Position::can_castle(CastleRight f) const {
 278   return st->castleRights & f;
 279 }
 280
 281 inline int Position::can_castle(Color c) const {
 282   return st->castleRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
 283 }
 284
 285 inline bool Position::castle_impeded(Color c, CastlingSide s) const {
 286   return byTypeBB[ALL_PIECES] & castlePath[c][s];
 287 }
 288
 289 inline Square Position::castle_rook_square(Color c, CastlingSide s) const {
 290   return castleRookSquare[c][s];
 291 }
 292
 293 template<PieceType Pt>
 294 inline Bitboard Position::attacks_from(Square s) const {
 295
 296   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, pieces())
 297         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
 298         : StepAttacksBB[Pt][s];
 299 }
 300
 301 template<>
 302 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 303   return StepAttacksBB[make_piece(c, PAWN)][s];
 304 }
 305
 306 inline Bitboard Position::attacks_from(Piece p, Square s) const {
 307   return attacks_from(p, s, byTypeBB[ALL_PIECES]);
 308 }
 309
 310 inline Bitboard Position::attackers_to(Square s) const {
 311   return attackers_to(s, byTypeBB[ALL_PIECES]);
 312 }
 313
 314 inline Bitboard Position::checkers() const {
 315   return st->checkersBB;
 316 }
 317
 318 inline Bitboard Position::discovered_check_candidates() const {
 319   return hidden_checkers(king_square(~sideToMove), sideToMove);
 320 }
 321
 322 inline Bitboard Position::pinned_pieces() const {
 323   return hidden_checkers(king_square(sideToMove), ~sideToMove);
 324 }
 325
 326 inline bool Position::pawn_passed(Color c, Square s) const {
 327   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
 328 }
 329
 330 inline bool Position::passed_pawn_push(Move m) const {
 331
 332   return   type_of(moved_piece(m)) == PAWN
 333         && pawn_passed(sideToMove, to_sq(m));
 334 }
 335
 336 inline Key Position::key() const {
 337   return st->key;
 338 }
 339
 340 inline Key Position::pawn_key() const {
 341   return st->pawnKey;
 342 }
 343
 344 inline Key Position::material_key() const {
 345   return st->materialKey;
 346 }
 347
 348 inline Score Position::psq_score() const {
 349   return st->psq;
 350 }
 351
 352 inline Value Position::non_pawn_material(Color c) const {
 353   return st->npMaterial[c];
 354 }
 355
 356 inline int Position::game_ply() const {
 357   return gamePly;
 358 }
 359
 360 inline bool Position::opposite_bishops() const {
 361
 362   return   pieceCount[WHITE][BISHOP] == 1
 363         && pieceCount[BLACK][BISHOP] == 1
 364         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
 365 }
 366
 367 inline bool Position::bishop_pair(Color c) const {
 368
 369   return   pieceCount[c][BISHOP] >= 2
 370         && opposite_colors(pieceList[c][BISHOP][0], pieceList[c][BISHOP][1]);
 371 }
 372
 373 inline bool Position::pawn_on_7th(Color c) const {
 374   return pieces(c, PAWN) & rank_bb(relative_rank(c, RANK_7));
 375 }
 376
 377 inline bool Position::is_chess960() const {
 378   return chess960;
 379 }
 380
 381 inline bool Position::capture_or_promotion(Move m) const {
 382
 383   assert(is_ok(m));
 384   return type_of(m) ? type_of(m) != CASTLE : !empty(to_sq(m));
 385 }
 386
 387 inline bool Position::capture(Move m) const {
 388
 389   // Note that castle is coded as "king captures the rook"
 390   assert(is_ok(m));
 391   return (!empty(to_sq(m)) && type_of(m) != CASTLE) || type_of(m) == ENPASSANT;
 392 }
 393
 394 inline PieceType Position::captured_piece_type() const {
 395   return st->capturedType;
 396 }
 397
 398 inline Thread* Position::this_thread() const {
 399   return thisThread;
 400 }
 401
 402 inline void Position::put_piece(Square s, Color c, PieceType pt) {
 403
 404   board[s] = make_piece(c, pt);
 405   byTypeBB[ALL_PIECES] |= s;
 406   byTypeBB[pt] |= s;
 407   byColorBB[c] |= s;
 408   pieceCount[c][ALL_PIECES]++;
 409   index[s] = pieceCount[c][pt]++;
 410   pieceList[c][pt][index[s]] = s;
 411 }
 412
 413 inline void Position::move_piece(Square from, Square to, Color c, PieceType pt) {
 414
 415   // index[from] is not updated and becomes stale. This works as long
 416   // as index[] is accessed just by known occupied squares.
 417   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
 418   byTypeBB[ALL_PIECES] ^= from_to_bb;
 419   byTypeBB[pt] ^= from_to_bb;
 420   byColorBB[c] ^= from_to_bb;
 421   board[from] = NO_PIECE;
 422   board[to] = make_piece(c, pt);
 423   index[to] = index[from];
 424   pieceList[c][pt][index[to]] = to;
 425 }
 426
 427 inline void Position::remove_piece(Square s, Color c, PieceType pt) {
 428
 429   // WARNING: This is not a reversible operation. If we remove a piece in
 430   // do_move() and then replace it in undo_move() we will put it at the end of
 431   // the list and not in its original place, it means index[] and pieceList[]
 432   // are not guaranteed to be invariant to a do_move() + undo_move() sequence.
 433   byTypeBB[ALL_PIECES] ^= s;
 434   byTypeBB[pt] ^= s;
 435   byColorBB[c] ^= s;
 436   /* board[s] = NO_PIECE; */ // Not needed, will be overwritten by capturing
 437   pieceCount[c][ALL_PIECES]--;
 438   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
 439   index[lastSquare] = index[s];
 440   pieceList[c][pt][index[lastSquare]] = lastSquare;
 441   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
 442 }
 443
 444 #endif // #ifndef POSITION_H_INCLUDED