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-2014 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 nonPawnMaterial[COLOR_NB];
  54   int castlingRights, 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
  77   friend std::ostream& operator<<(std::ostream&, const Position&);
  78
  79 public:
  80   Position() {}
  81   Position(const Position& pos, Thread* th) { *this = pos; thisThread = th; }
  82   Position(const std::string& f, bool c960, Thread* th) { set(f, c960, th); }
  83   Position& operator=(const Position&);
  84   static void init();
  85
  86   // FEN string input/output
  87   void set(const std::string& fenStr, bool isChess960, Thread* th);
  88   const std::string fen() const;
  89
  90   // Position representation
  91   Bitboard pieces() const;
  92   Bitboard pieces(PieceType pt) const;
  93   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  94   Bitboard pieces(Color c) const;
  95   Bitboard pieces(Color c, PieceType pt) const;
  96   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  97   Piece piece_on(Square s) const;
  98   Square king_square(Color c) const;
  99   Square ep_square() const;
 100   bool empty(Square s) const;
 101   template<PieceType Pt> int count(Color c) const;
 102   template<PieceType Pt> const Square* list(Color c) const;
 103
 104   // Castling
 105   int can_castle(Color c) const;
 106   int can_castle(CastlingRight cr) const;
 107   bool castling_impeded(CastlingRight cr) const;
 108   Square castling_rook_square(CastlingRight cr) const;
 109
 110   // Checking
 111   Bitboard checkers() const;
 112   Bitboard discovered_check_candidates() const;
 113   Bitboard pinned_pieces(Color c) const;
 114
 115   // Attacks to/from a given square
 116   Bitboard attackers_to(Square s) const;
 117   Bitboard attackers_to(Square s, Bitboard occupied) const;
 118   Bitboard attacks_from(Piece pc, Square s) const;
 119   template<PieceType> Bitboard attacks_from(Square s) const;
 120   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 121
 122   // Properties of moves
 123   bool legal(Move m, Bitboard pinned) const;
 124   bool pseudo_legal(const Move m) const;
 125   bool capture(Move m) const;
 126   bool capture_or_promotion(Move m) const;
 127   bool gives_check(Move m, const CheckInfo& ci) const;
 128   bool advanced_pawn_push(Move m) const;
 129   Piece moved_piece(Move m) const;
 130   PieceType captured_piece_type() const;
 131
 132   // Piece specific
 133   bool pawn_passed(Color c, Square s) const;
 134   bool pawn_on_7th(Color c) const;
 135   bool bishop_pair(Color c) const;
 136   bool opposite_bishops() const;
 137
 138   // Doing and undoing moves
 139   void do_move(Move m, StateInfo& st);
 140   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 141   void undo_move(Move m);
 142   void do_null_move(StateInfo& st);
 143   void undo_null_move();
 144
 145   // Static exchange evaluation
 146   Value see(Move m) const;
 147   Value see_sign(Move m) const;
 148
 149   // Accessing hash keys
 150   Key key() const;
 151   Key key_after(Move m) const;
 152   Key exclusion_key() const;
 153   Key pawn_key() const;
 154   Key material_key() const;
 155
 156   // Incremental piece-square evaluation
 157   Score psq_score() const;
 158   Value non_pawn_material(Color c) const;
 159
 160   // Other properties of the position
 161   Color side_to_move() const;
 162   Phase game_phase() const;
 163   int game_ply() const;
 164   bool is_chess960() const;
 165   Thread* this_thread() const;
 166   uint64_t nodes_searched() const;
 167   void set_nodes_searched(uint64_t n);
 168   bool is_draw() const;
 169   int rule50_count() const;
 170
 171   // Position consistency check, for debugging
 172   bool pos_is_ok(int* step = NULL) const;
 173   void flip();
 174
 175 private:
 176   // Initialization helpers (used while setting up a position)
 177   void clear();
 178   void set_castling_right(Color c, Square rfrom);
 179   void set_state(StateInfo* si) const;
 180
 181   // Helper functions
 182   Bitboard check_blockers(Color c, Color kingColor) const;
 183   void put_piece(Square s, Color c, PieceType pt);
 184   void remove_piece(Square s, Color c, PieceType pt);
 185   void move_piece(Square from, Square to, Color c, PieceType pt);
 186   template<bool Do>
 187   void do_castling(Square from, Square& to, Square& rfrom, Square& rto);
 188
 189   // Board and pieces
 190   Piece board[SQUARE_NB];
 191   Bitboard byTypeBB[PIECE_TYPE_NB];
 192   Bitboard byColorBB[COLOR_NB];
 193   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
 194   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
 195   int index[SQUARE_NB];
 196
 197   // Other info
 198   int castlingRightsMask[SQUARE_NB];
 199   Square castlingRookSquare[CASTLING_RIGHT_NB];
 200   Bitboard castlingPath[CASTLING_RIGHT_NB];
 201   StateInfo startState;
 202   uint64_t nodes;
 203   int gamePly;
 204   Color sideToMove;
 205   Thread* thisThread;
 206   StateInfo* st;
 207   bool chess960;
 208 };
 209
 210 inline uint64_t Position::nodes_searched() const {
 211   return nodes;
 212 }
 213
 214 inline void Position::set_nodes_searched(uint64_t n) {
 215   nodes = n;
 216 }
 217
 218 inline Piece Position::piece_on(Square s) const {
 219   return board[s];
 220 }
 221
 222 inline Piece Position::moved_piece(Move m) const {
 223   return board[from_sq(m)];
 224 }
 225
 226 inline bool Position::empty(Square s) const {
 227   return board[s] == NO_PIECE;
 228 }
 229
 230 inline Color Position::side_to_move() const {
 231   return sideToMove;
 232 }
 233
 234 inline Bitboard Position::pieces() const {
 235   return byTypeBB[ALL_PIECES];
 236 }
 237
 238 inline Bitboard Position::pieces(PieceType pt) const {
 239   return byTypeBB[pt];
 240 }
 241
 242 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 243   return byTypeBB[pt1] | byTypeBB[pt2];
 244 }
 245
 246 inline Bitboard Position::pieces(Color c) const {
 247   return byColorBB[c];
 248 }
 249
 250 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 251   return byColorBB[c] & byTypeBB[pt];
 252 }
 253
 254 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 255   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
 256 }
 257
 258 template<PieceType Pt> inline int Position::count(Color c) const {
 259   return pieceCount[c][Pt];
 260 }
 261
 262 template<PieceType Pt> inline const Square* Position::list(Color c) const {
 263   return pieceList[c][Pt];
 264 }
 265
 266 inline Square Position::ep_square() const {
 267   return st->epSquare;
 268 }
 269
 270 inline Square Position::king_square(Color c) const {
 271   return pieceList[c][KING][0];
 272 }
 273
 274 inline int Position::can_castle(CastlingRight cr) const {
 275   return st->castlingRights & cr;
 276 }
 277
 278 inline int Position::can_castle(Color c) const {
 279   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
 280 }
 281
 282 inline bool Position::castling_impeded(CastlingRight cr) const {
 283   return byTypeBB[ALL_PIECES] & castlingPath[cr];
 284 }
 285
 286 inline Square Position::castling_rook_square(CastlingRight cr) const {
 287   return castlingRookSquare[cr];
 288 }
 289
 290 template<PieceType Pt>
 291 inline Bitboard Position::attacks_from(Square s) const {
 292
 293   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
 294         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
 295         : StepAttacksBB[Pt][s];
 296 }
 297
 298 template<>
 299 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 300   return StepAttacksBB[make_piece(c, PAWN)][s];
 301 }
 302
 303 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
 304   return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
 305 }
 306
 307 inline Bitboard Position::attackers_to(Square s) const {
 308   return attackers_to(s, byTypeBB[ALL_PIECES]);
 309 }
 310
 311 inline Bitboard Position::checkers() const {
 312   return st->checkersBB;
 313 }
 314
 315 inline Bitboard Position::discovered_check_candidates() const {
 316   return check_blockers(sideToMove, ~sideToMove);
 317 }
 318
 319 inline Bitboard Position::pinned_pieces(Color c) const {
 320   return check_blockers(c, c);
 321 }
 322
 323 inline bool Position::pawn_passed(Color c, Square s) const {
 324   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
 325 }
 326
 327 inline bool Position::advanced_pawn_push(Move m) const {
 328   return   type_of(moved_piece(m)) == PAWN
 329         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
 330 }
 331
 332 inline Key Position::key() const {
 333   return st->key;
 334 }
 335
 336 inline Key Position::pawn_key() const {
 337   return st->pawnKey;
 338 }
 339
 340 inline Key Position::material_key() const {
 341   return st->materialKey;
 342 }
 343
 344 inline Score Position::psq_score() const {
 345   return st->psq;
 346 }
 347
 348 inline Value Position::non_pawn_material(Color c) const {
 349   return st->nonPawnMaterial[c];
 350 }
 351
 352 inline int Position::game_ply() const {
 353   return gamePly;
 354 }
 355
 356 inline int Position::rule50_count() const {
 357   return st->rule50;
 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) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 385 }
 386
 387 inline bool Position::capture(Move m) const {
 388
 389   // Note that castling is encoded as "king captures the rook"
 390   assert(is_ok(m));
 391   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || 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   index[s] = pieceCount[c][pt]++;
 409   pieceList[c][pt][index[s]] = s;
 410   pieceCount[c][ALL_PIECES]++;
 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   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
 438   index[lastSquare] = index[s];
 439   pieceList[c][pt][index[lastSquare]] = lastSquare;
 440   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
 441   pieceCount[c][ALL_PIECES]--;
 442 }
 443
 444 #endif // #ifndef POSITION_H_INCLUDED