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 namespace PSQT {
  34
  35   extern Score psq[COLOR_NB][PIECE_TYPE_NB][SQUARE_NB];
  36
  37   void init();
  38 }
  39
  40 /// CheckInfo struct is initialized at constructor time and keeps info used to
  41 /// detect if a move gives check.
  42
  43 struct CheckInfo {
  44
  45   explicit CheckInfo(const Position&);
  46
  47   Bitboard dcCandidates;
  48   Bitboard pinned;
  49   Bitboard checkSquares[PIECE_TYPE_NB];
  50   Square   ksq;
  51 };
  52
  53
  54 /// StateInfo struct stores information needed to restore a Position object to
  55 /// its previous state when we retract a move. Whenever a move is made on the
  56 /// board (by calling Position::do_move), a StateInfo object must be passed.
  57
  58 struct StateInfo {
  59
  60   // Copied when making a move
  61   Key    pawnKey;
  62   Key    materialKey;
  63   Value  nonPawnMaterial[COLOR_NB];
  64   int    castlingRights;
  65   int    rule50;
  66   int    pliesFromNull;
  67   Score  psq;
  68   Square epSquare;
  69
  70   // Not copied when making a move
  71   Key        key;
  72   Bitboard   checkersBB;
  73   PieceType  capturedType;
  74   StateInfo* previous;
  75 };
  76
  77
  78 /// Position class stores information regarding the board representation as
  79 /// pieces, side to move, hash keys, castling info, etc. Important methods are
  80 /// do_move() and undo_move(), used by the search to update node info when
  81 /// traversing the search tree.
  82
  83 class Position {
  84
  85   friend std::ostream& operator<<(std::ostream&, const Position&);
  86
  87 public:
  88   static void init();
  89
  90   Position() = default; // To define the global object RootPos
  91   Position(const Position&) = delete;
  92   Position(const Position& pos, Thread* th) { *this = pos; thisThread = th; }
  93   Position(const std::string& f, bool c960, Thread* th) { set(f, c960, th); }
  94   Position& operator=(const Position&); // To assign RootPos from UCI
  95
  96   // FEN string input/output
  97   void set(const std::string& fenStr, bool isChess960, Thread* th);
  98   const std::string fen() const;
  99
 100   // Position representation
 101   Bitboard pieces() const;
 102   Bitboard pieces(PieceType pt) const;
 103   Bitboard pieces(PieceType pt1, PieceType pt2) const;
 104   Bitboard pieces(Color c) const;
 105   Bitboard pieces(Color c, PieceType pt) const;
 106   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
 107   Piece piece_on(Square s) 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* squares(Color c) const;
 112   template<PieceType Pt> Square square(Color c) const;
 113
 114   // Castling
 115   int can_castle(Color c) const;
 116   int can_castle(CastlingRight cr) const;
 117   bool castling_impeded(CastlingRight cr) const;
 118   Square castling_rook_square(CastlingRight cr) const;
 119
 120   // Checking
 121   Bitboard checkers() const;
 122   Bitboard discovered_check_candidates() const;
 123   Bitboard pinned_pieces(Color c) const;
 124
 125   // Attacks to/from a given square
 126   Bitboard attackers_to(Square s) const;
 127   Bitboard attackers_to(Square s, Bitboard occupied) const;
 128   Bitboard attacks_from(Piece pc, Square s) const;
 129   template<PieceType> Bitboard attacks_from(Square s) const;
 130   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 131
 132   // Properties of moves
 133   bool legal(Move m, Bitboard pinned) const;
 134   bool pseudo_legal(const Move m) const;
 135   bool capture(Move m) const;
 136   bool capture_or_promotion(Move m) const;
 137   bool gives_check(Move m, const CheckInfo& ci) const;
 138   bool advanced_pawn_push(Move m) const;
 139   Piece moved_piece(Move m) const;
 140   PieceType captured_piece_type() const;
 141
 142   // Piece specific
 143   bool pawn_passed(Color c, Square s) const;
 144   bool opposite_bishops() const;
 145
 146   // Doing and undoing moves
 147   void do_move(Move m, StateInfo& st, bool givesCheck);
 148   void undo_move(Move m);
 149   void do_null_move(StateInfo& st);
 150   void undo_null_move();
 151
 152   // Static exchange evaluation
 153   Value see(Move m) const;
 154   Value see_sign(Move m) const;
 155
 156   // Accessing hash keys
 157   Key key() const;
 158   Key key_after(Move m) const;
 159   Key exclusion_key() const;
 160   Key material_key() const;
 161   Key pawn_key() const;
 162
 163   // Other properties of the position
 164   Color side_to_move() const;
 165   Phase game_phase() const;
 166   int game_ply() const;
 167   bool is_chess960() const;
 168   Thread* this_thread() const;
 169   uint64_t nodes_searched() const;
 170   void set_nodes_searched(uint64_t n);
 171   bool is_draw() const;
 172   int rule50_count() const;
 173   Score psq_score() const;
 174   Value non_pawn_material(Color c) const;
 175
 176   // Position consistency check, for debugging
 177   bool pos_is_ok(int* failedStep = nullptr) const;
 178   void flip();
 179
 180 private:
 181   // Initialization helpers (used while setting up a position)
 182   void clear();
 183   void set_castling_right(Color c, Square rfrom);
 184   void set_state(StateInfo* si) const;
 185
 186   // Other helpers
 187   Bitboard check_blockers(Color c, Color kingColor) const;
 188   void put_piece(Color c, PieceType pt, Square s);
 189   void remove_piece(Color c, PieceType pt, Square s);
 190   void move_piece(Color c, PieceType pt, Square from, Square to);
 191   template<bool Do>
 192   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 193
 194   // Data members
 195   Piece board[SQUARE_NB];
 196   Bitboard byTypeBB[PIECE_TYPE_NB];
 197   Bitboard byColorBB[COLOR_NB];
 198   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
 199   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
 200   int index[SQUARE_NB];
 201   int castlingRightsMask[SQUARE_NB];
 202   Square castlingRookSquare[CASTLING_RIGHT_NB];
 203   Bitboard castlingPath[CASTLING_RIGHT_NB];
 204   StateInfo startState;
 205   uint64_t nodes;
 206   int gamePly;
 207   Color sideToMove;
 208   Thread* thisThread;
 209   StateInfo* st;
 210   bool chess960;
 211 };
 212
 213 inline Color Position::side_to_move() const {
 214   return sideToMove;
 215 }
 216
 217 inline bool Position::empty(Square s) const {
 218   return board[s] == NO_PIECE;
 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 Bitboard Position::pieces() const {
 230   return byTypeBB[ALL_PIECES];
 231 }
 232
 233 inline Bitboard Position::pieces(PieceType pt) const {
 234   return byTypeBB[pt];
 235 }
 236
 237 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 238   return byTypeBB[pt1] | byTypeBB[pt2];
 239 }
 240
 241 inline Bitboard Position::pieces(Color c) const {
 242   return byColorBB[c];
 243 }
 244
 245 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 246   return byColorBB[c] & byTypeBB[pt];
 247 }
 248
 249 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 250   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
 251 }
 252
 253 template<PieceType Pt> inline int Position::count(Color c) const {
 254   return pieceCount[c][Pt];
 255 }
 256
 257 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
 258   return pieceList[c][Pt];
 259 }
 260
 261 template<PieceType Pt> inline Square Position::square(Color c) const {
 262   assert(pieceCount[c][Pt] == 1);
 263   return pieceList[c][Pt][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(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 367 }
 368
 369 inline bool Position::is_chess960() const {
 370   return chess960;
 371 }
 372
 373 inline bool Position::capture_or_promotion(Move m) const {
 374
 375   assert(is_ok(m));
 376   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 377 }
 378
 379 inline bool Position::capture(Move m) const {
 380
 381   // Castling is encoded as "king captures the rook"
 382   assert(is_ok(m));
 383   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 384 }
 385
 386 inline PieceType Position::captured_piece_type() const {
 387   return st->capturedType;
 388 }
 389
 390 inline Thread* Position::this_thread() const {
 391   return thisThread;
 392 }
 393
 394 inline void Position::put_piece(Color c, PieceType pt, Square s) {
 395
 396   board[s] = make_piece(c, pt);
 397   byTypeBB[ALL_PIECES] |= s;
 398   byTypeBB[pt] |= s;
 399   byColorBB[c] |= s;
 400   index[s] = pieceCount[c][pt]++;
 401   pieceList[c][pt][index[s]] = s;
 402   pieceCount[c][ALL_PIECES]++;
 403 }
 404
 405 inline void Position::remove_piece(Color c, PieceType pt, Square s) {
 406
 407   // WARNING: This is not a reversible operation. If we remove a piece in
 408   // do_move() and then replace it in undo_move() we will put it at the end of
 409   // the list and not in its original place, it means index[] and pieceList[]
 410   // are not guaranteed to be invariant to a do_move() + undo_move() sequence.
 411   byTypeBB[ALL_PIECES] ^= s;
 412   byTypeBB[pt] ^= s;
 413   byColorBB[c] ^= s;
 414   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 415   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
 416   index[lastSquare] = index[s];
 417   pieceList[c][pt][index[lastSquare]] = lastSquare;
 418   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
 419   pieceCount[c][ALL_PIECES]--;
 420 }
 421
 422 inline void Position::move_piece(Color c, PieceType pt, Square from, Square to) {
 423
 424   // index[from] is not updated and becomes stale. This works as long as index[]
 425   // is accessed just by known occupied squares.
 426   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
 427   byTypeBB[ALL_PIECES] ^= from_to_bb;
 428   byTypeBB[pt] ^= from_to_bb;
 429   byColorBB[c] ^= from_to_bb;
 430   board[from] = NO_PIECE;
 431   board[to] = make_piece(c, pt);
 432   index[to] = index[from];
 433   pieceList[c][pt][index[to]] = to;
 434 }
 435
 436 #endif // #ifndef POSITION_H_INCLUDED