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