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 npMaterial[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 public:
  77   Position() {}
  78   Position(const Position& pos, Thread* t) { *this = pos; 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& fenStr, bool isChess960, Thread* th);
  85   const std::string fen() const;
  86   const std::string pretty() 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(Color c) const;
 104   int can_castle(CastlingRight cr) const;
 105   bool castling_impeded(CastlingRight cr) const;
 106   Square castling_rook_square(CastlingRight cr) const;
 107
 108   // Checking
 109   Bitboard checkers() const;
 110   Bitboard discovered_check_candidates() const;
 111   Bitboard pinned_pieces(Color c) 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 pc, Square s) const;
 117   template<PieceType> Bitboard attacks_from(Square s) const;
 118   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 119
 120   // Properties of moves
 121   bool legal(Move m, Bitboard pinned) const;
 122   bool pseudo_legal(const Move m) const;
 123   bool capture(Move m) const;
 124   bool capture_or_promotion(Move m) const;
 125   bool gives_check(Move m, const CheckInfo& ci) const;
 126   bool advanced_pawn_push(Move m) const;
 127   Piece moved_piece(Move m) const;
 128   PieceType captured_piece_type() const;
 129
 130   // Piece specific
 131   bool pawn_passed(Color c, Square s) const;
 132   bool pawn_on_7th(Color c) const;
 133   bool bishop_pair(Color c) const;
 134   bool opposite_bishops() const;
 135
 136   // Doing and undoing moves
 137   void do_move(Move m, StateInfo& st);
 138   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
 139   void undo_move(Move m);
 140   void do_null_move(StateInfo& st);
 141   void undo_null_move();
 142   Key hash_after_move(Move m) const;
 143
 144   // Static exchange evaluation
 145   Value see(Move m) const;
 146   Value 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   Phase game_phase() const;
 161   int game_ply() const;
 162   bool is_chess960() const;
 163   Thread* this_thread() const;
 164   uint64_t nodes_searched() const;
 165   void set_nodes_searched(uint64_t n);
 166   bool is_draw() const;
 167
 168   // Position consistency check, for debugging
 169   bool pos_is_ok(int* step = NULL) const;
 170   void flip();
 171
 172 private:
 173   // Initialization helpers (used while setting up a position)
 174   void clear();
 175   void set_castling_right(Color c, Square rfrom);
 176   void set_state(StateInfo* si) const;
 177
 178   // Helper functions
 179   Bitboard check_blockers(Color c, Color kingColor) const;
 180   void put_piece(Square s, Color c, PieceType pt);
 181   void remove_piece(Square s, Color c, PieceType pt);
 182   void move_piece(Square from, Square to, Color c, PieceType pt);
 183   template<bool Do>
 184   void do_castling(Square from, Square& to, Square& rfrom, Square& rto);
 185
 186   // Board and pieces
 187   Piece board[SQUARE_NB];
 188   Bitboard byTypeBB[PIECE_TYPE_NB];
 189   Bitboard byColorBB[COLOR_NB];
 190   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
 191   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
 192   int index[SQUARE_NB];
 193
 194   // Other info
 195   int castlingRightsMask[SQUARE_NB];
 196   Square castlingRookSquare[CASTLING_RIGHT_NB];
 197   Bitboard castlingPath[CASTLING_RIGHT_NB];
 198   StateInfo startState;
 199   uint64_t nodes;
 200   int gamePly;
 201   Color sideToMove;
 202   Thread* thisThread;
 203   StateInfo* st;
 204   bool chess960;
 205 };
 206
 207 inline uint64_t Position::nodes_searched() const {
 208   return nodes;
 209 }
 210
 211 inline void Position::set_nodes_searched(uint64_t n) {
 212   nodes = n;
 213 }
 214
 215 inline Piece Position::piece_on(Square s) const {
 216   return board[s];
 217 }
 218
 219 inline Piece Position::moved_piece(Move m) const {
 220   return board[from_sq(m)];
 221 }
 222
 223 inline bool Position::empty(Square s) const {
 224   return board[s] == NO_PIECE;
 225 }
 226
 227 inline Color Position::side_to_move() const {
 228   return sideToMove;
 229 }
 230
 231 inline Bitboard Position::pieces() const {
 232   return byTypeBB[ALL_PIECES];
 233 }
 234
 235 inline Bitboard Position::pieces(PieceType pt) const {
 236   return byTypeBB[pt];
 237 }
 238
 239 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 240   return byTypeBB[pt1] | byTypeBB[pt2];
 241 }
 242
 243 inline Bitboard Position::pieces(Color c) const {
 244   return byColorBB[c];
 245 }
 246
 247 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 248   return byColorBB[c] & byTypeBB[pt];
 249 }
 250
 251 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 252   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
 253 }
 254
 255 template<PieceType Pt> inline int Position::count(Color c) const {
 256   return pieceCount[c][Pt];
 257 }
 258
 259 template<PieceType Pt> inline const Square* Position::list(Color c) const {
 260   return pieceList[c][Pt];
 261 }
 262
 263 inline Square Position::ep_square() const {
 264   return st->epSquare;
 265 }
 266
 267 inline Square Position::king_square(Color c) const {
 268   return pieceList[c][KING][0];
 269 }
 270
 271 inline int Position::can_castle(CastlingRight cr) const {
 272   return st->castlingRights & cr;
 273 }
 274
 275 inline int Position::can_castle(Color c) const {
 276   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
 277 }
 278
 279 inline bool Position::castling_impeded(CastlingRight cr) const {
 280   return byTypeBB[ALL_PIECES] & castlingPath[cr];
 281 }
 282
 283 inline Square Position::castling_rook_square(CastlingRight cr) const {
 284   return castlingRookSquare[cr];
 285 }
 286
 287 template<PieceType Pt>
 288 inline Bitboard Position::attacks_from(Square s) const {
 289
 290   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
 291         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
 292         : StepAttacksBB[Pt][s];
 293 }
 294
 295 template<>
 296 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 297   return StepAttacksBB[make_piece(c, PAWN)][s];
 298 }
 299
 300 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
 301   return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
 302 }
 303
 304 inline Bitboard Position::attackers_to(Square s) const {
 305   return attackers_to(s, byTypeBB[ALL_PIECES]);
 306 }
 307
 308 inline Bitboard Position::checkers() const {
 309   return st->checkersBB;
 310 }
 311
 312 inline Bitboard Position::discovered_check_candidates() const {
 313   return check_blockers(sideToMove, ~sideToMove);
 314 }
 315
 316 inline Bitboard Position::pinned_pieces(Color c) const {
 317   return check_blockers(c, c);
 318 }
 319
 320 inline bool Position::pawn_passed(Color c, Square s) const {
 321   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
 322 }
 323
 324 inline bool Position::advanced_pawn_push(Move m) const {
 325   return   type_of(moved_piece(m)) == PAWN
 326         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
 327 }
 328
 329 inline Key Position::key() const {
 330   return st->key;
 331 }
 332
 333 inline Key Position::pawn_key() const {
 334   return st->pawnKey;
 335 }
 336
 337 inline Key Position::material_key() const {
 338   return st->materialKey;
 339 }
 340
 341 inline Score Position::psq_score() const {
 342   return st->psq;
 343 }
 344
 345 inline Value Position::non_pawn_material(Color c) const {
 346   return st->npMaterial[c];
 347 }
 348
 349 inline int Position::game_ply() const {
 350   return gamePly;
 351 }
 352
 353 inline bool Position::opposite_bishops() const {
 354
 355   return   pieceCount[WHITE][BISHOP] == 1
 356         && pieceCount[BLACK][BISHOP] == 1
 357         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
 358 }
 359
 360 inline bool Position::bishop_pair(Color c) const {
 361
 362   return   pieceCount[c][BISHOP] >= 2
 363         && opposite_colors(pieceList[c][BISHOP][0], pieceList[c][BISHOP][1]);
 364 }
 365
 366 inline bool Position::pawn_on_7th(Color c) const {
 367   return pieces(c, PAWN) & rank_bb(relative_rank(c, RANK_7));
 368 }
 369
 370 inline bool Position::is_chess960() const {
 371   return chess960;
 372 }
 373
 374 inline bool Position::capture_or_promotion(Move m) const {
 375
 376   assert(is_ok(m));
 377   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 378 }
 379
 380 inline bool Position::capture(Move m) const {
 381
 382   // Note that castling is encoded as "king captures the rook"
 383   assert(is_ok(m));
 384   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 385 }
 386
 387 inline PieceType Position::captured_piece_type() const {
 388   return st->capturedType;
 389 }
 390
 391 inline Thread* Position::this_thread() const {
 392   return thisThread;
 393 }
 394
 395 inline void Position::put_piece(Square s, Color c, PieceType pt) {
 396
 397   board[s] = make_piece(c, pt);
 398   byTypeBB[ALL_PIECES] |= s;
 399   byTypeBB[pt] |= s;
 400   byColorBB[c] |= s;
 401   index[s] = pieceCount[c][pt]++;
 402   pieceList[c][pt][index[s]] = s;
 403 }
 404
 405 inline void Position::move_piece(Square from, Square to, Color c, PieceType pt) {
 406
 407   // index[from] is not updated and becomes stale. This works as long
 408   // as index[] is accessed just by known occupied squares.
 409   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
 410   byTypeBB[ALL_PIECES] ^= from_to_bb;
 411   byTypeBB[pt] ^= from_to_bb;
 412   byColorBB[c] ^= from_to_bb;
 413   board[from] = NO_PIECE;
 414   board[to] = make_piece(c, pt);
 415   index[to] = index[from];
 416   pieceList[c][pt][index[to]] = to;
 417 }
 418
 419 inline void Position::remove_piece(Square s, Color c, PieceType pt) {
 420
 421   // WARNING: This is not a reversible operation. If we remove a piece in
 422   // do_move() and then replace it in undo_move() we will put it at the end of
 423   // the list and not in its original place, it means index[] and pieceList[]
 424   // are not guaranteed to be invariant to a do_move() + undo_move() sequence.
 425   byTypeBB[ALL_PIECES] ^= s;
 426   byTypeBB[pt] ^= s;
 427   byColorBB[c] ^= s;
 428   /* board[s] = NO_PIECE; */ // Not needed, will be overwritten by capturing
 429   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
 430   index[lastSquare] = index[s];
 431   pieceList[c][pt][index[lastSquare]] = lastSquare;
 432   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
 433 }
 434
 435 #endif // #ifndef POSITION_H_INCLUDED