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