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