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   Copyright (C) 2015-2016 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef POSITION_H_INCLUDED
  22 #define POSITION_H_INCLUDED
  23
  24 #include <cassert>
  25 #include <deque>
  26 #include <memory> // For std::unique_ptr
  27 #include <string>
  28
  29 #include "bitboard.h"
  30 #include "types.h"
  31
  32
  33 /// StateInfo struct stores information needed to restore a Position object to
  34 /// its previous state when we retract a move. Whenever a move is made on the
  35 /// board (by calling Position::do_move), a StateInfo object must be passed.
  36
  37 struct StateInfo {
  38
  39   // Copied when making a move
  40   Key    pawnKey;
  41   Key    materialKey;
  42   Value  nonPawnMaterial[COLOR_NB];
  43   int    castlingRights;
  44   int    rule50;
  45   int    pliesFromNull;
  46   Score  psq;
  47   Square epSquare;
  48
  49   // Not copied when making a move (will be recomputed anyhow)
  50   Key        key;
  51   Bitboard   checkersBB;
  52   Piece      capturedPiece;
  53   StateInfo* previous;
  54   Bitboard   blockersForKing[COLOR_NB];
  55   Bitboard   pinnersForKing[COLOR_NB];
  56   Bitboard   checkSquares[PIECE_TYPE_NB];
  57 };
  58
  59 // In a std::deque references to elements are unaffected upon resizing
  60 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
  61
  62
  63 /// Position class stores information regarding the board representation as
  64 /// pieces, side to move, hash keys, castling info, etc. Important methods are
  65 /// do_move() and undo_move(), used by the search to update node info when
  66 /// traversing the search tree.
  67 class Thread;
  68
  69 class Position {
  70 public:
  71   static void init();
  72
  73   Position() = default;
  74   Position(const Position&) = delete;
  75   Position& operator=(const Position&) = delete;
  76
  77   // FEN string input/output
  78   Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
  79   Position& set(const std::string& code, Color c, StateInfo* si);
  80   const std::string fen() const;
  81
  82   // Position representation
  83   Bitboard pieces() const;
  84   Bitboard pieces(PieceType pt) const;
  85   Bitboard pieces(PieceType pt1, PieceType pt2) const;
  86   Bitboard pieces(Color c) const;
  87   Bitboard pieces(Color c, PieceType pt) const;
  88   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
  89   Piece piece_on(Square s) const;
  90   Square ep_square() const;
  91   bool empty(Square s) const;
  92   template<PieceType Pt> int count(Color c) const;
  93   template<PieceType Pt> const Square* squares(Color c) const;
  94   template<PieceType Pt> Square square(Color c) const;
  95
  96   // Castling
  97   int can_castle(Color c) const;
  98   int can_castle(CastlingRight cr) const;
  99   bool castling_impeded(CastlingRight cr) const;
 100   Square castling_rook_square(CastlingRight cr) const;
 101
 102   // Checking
 103   Bitboard checkers() const;
 104   Bitboard discovered_check_candidates() const;
 105   Bitboard pinned_pieces(Color c) const;
 106   Bitboard check_squares(PieceType pt) const;
 107
 108   // Attacks to/from a given square
 109   Bitboard attackers_to(Square s) const;
 110   Bitboard attackers_to(Square s, Bitboard occupied) const;
 111   Bitboard attacks_from(Piece pc, Square s) const;
 112   template<PieceType> Bitboard attacks_from(Square s) const;
 113   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
 114   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
 115
 116   // Properties of moves
 117   bool legal(Move m) const;
 118   bool pseudo_legal(const Move m) const;
 119   bool capture(Move m) const;
 120   bool capture_or_promotion(Move m) const;
 121   bool gives_check(Move m) const;
 122   bool advanced_pawn_push(Move m) const;
 123   Piece moved_piece(Move m) const;
 124   Piece captured_piece() const;
 125
 126   // Piece specific
 127   bool pawn_passed(Color c, Square s) const;
 128   bool opposite_bishops() const;
 129
 130   // Doing and undoing moves
 131   void do_move(Move m, StateInfo& newSt, bool givesCheck);
 132   void undo_move(Move m);
 133   void do_null_move(StateInfo& newSt);
 134   void undo_null_move();
 135
 136   // Static Exchange Evaluation
 137   bool see_ge(Move m, Value value) const;
 138
 139   // Accessing hash keys
 140   Key key() const;
 141   Key key_after(Move m) const;
 142   Key material_key() const;
 143   Key pawn_key() const;
 144
 145   // Other properties of the position
 146   Color side_to_move() const;
 147   Phase game_phase() const;
 148   int game_ply() const;
 149   bool is_chess960() const;
 150   Thread* this_thread() const;
 151   uint64_t nodes_searched() const;
 152   bool is_draw() const;
 153   int rule50_count() const;
 154   Score psq_score() const;
 155   Value non_pawn_material(Color c) const;
 156
 157   // Position consistency check, for debugging
 158   bool pos_is_ok(int* failedStep = nullptr) const;
 159   void flip();
 160
 161 private:
 162   // Initialization helpers (used while setting up a position)
 163   void set_castling_right(Color c, Square rfrom);
 164   void set_state(StateInfo* si) const;
 165   void set_check_info(StateInfo* si) const;
 166
 167   // Other helpers
 168   void put_piece(Piece pc, Square s);
 169   void remove_piece(Piece pc, Square s);
 170   void move_piece(Piece pc, Square from, Square to);
 171   template<bool Do>
 172   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
 173
 174   // Data members
 175   Piece board[SQUARE_NB];
 176   Bitboard byTypeBB[PIECE_TYPE_NB];
 177   Bitboard byColorBB[COLOR_NB];
 178   int pieceCount[PIECE_NB];
 179   Square pieceList[PIECE_NB][16];
 180   int index[SQUARE_NB];
 181   int castlingRightsMask[SQUARE_NB];
 182   Square castlingRookSquare[CASTLING_RIGHT_NB];
 183   Bitboard castlingPath[CASTLING_RIGHT_NB];
 184   uint64_t nodes;
 185   int gamePly;
 186   Color sideToMove;
 187   Thread* thisThread;
 188   StateInfo* st;
 189   bool chess960;
 190 };
 191
 192 extern std::ostream& operator<<(std::ostream& os, Position& pos);
 193
 194 inline Color Position::side_to_move() const {
 195   return sideToMove;
 196 }
 197
 198 inline bool Position::empty(Square s) const {
 199   return board[s] == NO_PIECE;
 200 }
 201
 202 inline Piece Position::piece_on(Square s) const {
 203   return board[s];
 204 }
 205
 206 inline Piece Position::moved_piece(Move m) const {
 207   return board[from_sq(m)];
 208 }
 209
 210 inline Bitboard Position::pieces() const {
 211   return byTypeBB[ALL_PIECES];
 212 }
 213
 214 inline Bitboard Position::pieces(PieceType pt) const {
 215   return byTypeBB[pt];
 216 }
 217
 218 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
 219   return byTypeBB[pt1] | byTypeBB[pt2];
 220 }
 221
 222 inline Bitboard Position::pieces(Color c) const {
 223   return byColorBB[c];
 224 }
 225
 226 inline Bitboard Position::pieces(Color c, PieceType pt) const {
 227   return byColorBB[c] & byTypeBB[pt];
 228 }
 229
 230 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
 231   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
 232 }
 233
 234 template<PieceType Pt> inline int Position::count(Color c) const {
 235   return pieceCount[make_piece(c, Pt)];
 236 }
 237
 238 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
 239   return pieceList[make_piece(c, Pt)];
 240 }
 241
 242 template<PieceType Pt> inline Square Position::square(Color c) const {
 243   assert(pieceCount[make_piece(c, Pt)] == 1);
 244   return pieceList[make_piece(c, Pt)][0];
 245 }
 246
 247 inline Square Position::ep_square() const {
 248   return st->epSquare;
 249 }
 250
 251 inline int Position::can_castle(CastlingRight cr) const {
 252   return st->castlingRights & cr;
 253 }
 254
 255 inline int Position::can_castle(Color c) const {
 256   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
 257 }
 258
 259 inline bool Position::castling_impeded(CastlingRight cr) const {
 260   return byTypeBB[ALL_PIECES] & castlingPath[cr];
 261 }
 262
 263 inline Square Position::castling_rook_square(CastlingRight cr) const {
 264   return castlingRookSquare[cr];
 265 }
 266
 267 template<PieceType Pt>
 268 inline Bitboard Position::attacks_from(Square s) const {
 269   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
 270         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
 271         : StepAttacksBB[Pt][s];
 272 }
 273
 274 template<>
 275 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
 276   return StepAttacksBB[make_piece(c, PAWN)][s];
 277 }
 278
 279 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
 280   return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
 281 }
 282
 283 inline Bitboard Position::attackers_to(Square s) const {
 284   return attackers_to(s, byTypeBB[ALL_PIECES]);
 285 }
 286
 287 inline Bitboard Position::checkers() const {
 288   return st->checkersBB;
 289 }
 290
 291 inline Bitboard Position::discovered_check_candidates() const {
 292   return st->blockersForKing[~sideToMove] & pieces(sideToMove);
 293 }
 294
 295 inline Bitboard Position::pinned_pieces(Color c) const {
 296   return st->blockersForKing[c] & pieces(c);
 297 }
 298
 299 inline Bitboard Position::check_squares(PieceType pt) const {
 300   return st->checkSquares[pt];
 301 }
 302
 303 inline bool Position::pawn_passed(Color c, Square s) const {
 304   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
 305 }
 306
 307 inline bool Position::advanced_pawn_push(Move m) const {
 308   return   type_of(moved_piece(m)) == PAWN
 309         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
 310 }
 311
 312 inline Key Position::key() const {
 313   return st->key;
 314 }
 315
 316 inline Key Position::pawn_key() const {
 317   return st->pawnKey;
 318 }
 319
 320 inline Key Position::material_key() const {
 321   return st->materialKey;
 322 }
 323
 324 inline Score Position::psq_score() const {
 325   return st->psq;
 326 }
 327
 328 inline Value Position::non_pawn_material(Color c) const {
 329   return st->nonPawnMaterial[c];
 330 }
 331
 332 inline int Position::game_ply() const {
 333   return gamePly;
 334 }
 335
 336 inline int Position::rule50_count() const {
 337   return st->rule50;
 338 }
 339
 340 inline uint64_t Position::nodes_searched() const {
 341   return nodes;
 342 }
 343
 344 inline bool Position::opposite_bishops() const {
 345   return   pieceCount[W_BISHOP] == 1
 346         && pieceCount[B_BISHOP] == 1
 347         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
 348 }
 349
 350 inline bool Position::is_chess960() const {
 351   return chess960;
 352 }
 353
 354 inline bool Position::capture_or_promotion(Move m) const {
 355   assert(is_ok(m));
 356   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
 357 }
 358
 359 inline bool Position::capture(Move m) const {
 360   assert(is_ok(m));
 361   // Castling is encoded as "king captures rook"
 362   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
 363 }
 364
 365 inline Piece Position::captured_piece() const {
 366   return st->capturedPiece;
 367 }
 368
 369 inline Thread* Position::this_thread() const {
 370   return thisThread;
 371 }
 372
 373 inline void Position::put_piece(Piece pc, Square s) {
 374
 375   board[s] = pc;
 376   byTypeBB[ALL_PIECES] |= s;
 377   byTypeBB[type_of(pc)] |= s;
 378   byColorBB[color_of(pc)] |= s;
 379   index[s] = pieceCount[pc]++;
 380   pieceList[pc][index[s]] = s;
 381   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
 382 }
 383
 384 inline void Position::remove_piece(Piece pc, Square s) {
 385
 386   // WARNING: This is not a reversible operation. If we remove a piece in
 387   // do_move() and then replace it in undo_move() we will put it at the end of
 388   // the list and not in its original place, it means index[] and pieceList[]
 389   // are not invariant to a do_move() + undo_move() sequence.
 390   byTypeBB[ALL_PIECES] ^= s;
 391   byTypeBB[type_of(pc)] ^= s;
 392   byColorBB[color_of(pc)] ^= s;
 393   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
 394   Square lastSquare = pieceList[pc][--pieceCount[pc]];
 395   index[lastSquare] = index[s];
 396   pieceList[pc][index[lastSquare]] = lastSquare;
 397   pieceList[pc][pieceCount[pc]] = SQ_NONE;
 398   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
 399 }
 400
 401 inline void Position::move_piece(Piece pc, Square from, Square to) {
 402
 403   // index[from] is not updated and becomes stale. This works as long as index[]
 404   // is accessed just by known occupied squares.
 405   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
 406   byTypeBB[ALL_PIECES] ^= from_to_bb;
 407   byTypeBB[type_of(pc)] ^= from_to_bb;
 408   byColorBB[color_of(pc)] ^= from_to_bb;
 409   board[from] = NO_PIECE;
 410   board[to] = pc;
 411   index[to] = index[from];
 412   pieceList[pc][index[to]] = to;
 413 }
 414
 415 #endif // #ifndef POSITION_H_INCLUDED