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