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
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.
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.
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/>.
21 #ifndef POSITION_H_INCLUDED
22 #define POSITION_H_INCLUDED
25 #include <cstddef> // For offsetof()
27 #include <memory> // For std::unique_ptr
39 extern Score psq[COLOR_NB][PIECE_TYPE_NB][SQUARE_NB];
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.
51 // Copied when making a move
54 Value nonPawnMaterial[COLOR_NB];
61 // Not copied when making a move
64 PieceType capturedType;
66 Bitboard blockersForKing[COLOR_NB];
67 Bitboard checkSquares[PIECE_TYPE_NB];
70 // In a std::deque references to elements are unaffected upon resizing
71 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
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.
85 Position(const Position&) = delete;
86 Position& operator=(const Position&) = delete;
88 // FEN string input/output
89 Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
90 const std::string fen() const;
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;
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;
113 Bitboard checkers() const;
114 Bitboard discovered_check_candidates() const;
115 Bitboard pinned_pieces(Color c) const;
116 Bitboard check_squares(PieceType pt) const;
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;
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;
137 bool pawn_passed(Color c, Square s) const;
138 bool opposite_bishops() const;
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();
146 // Static exchange evaluation
147 Value see(Move m) const;
148 Value see_sign(Move m) const;
150 // Accessing hash keys
152 Key key_after(Move m) const;
153 Key exclusion_key() const;
154 Key material_key() const;
155 Key pawn_key() const;
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;
170 // Position consistency check, for debugging
171 bool pos_is_ok(int* failedStep = nullptr) const;
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;
181 void put_piece(Color c, PieceType pt, Square s);
182 void remove_piece(Color c, PieceType pt, Square s);
183 void move_piece(Color c, PieceType pt, Square from, Square to);
185 void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
188 Piece board[SQUARE_NB];
189 Bitboard byTypeBB[PIECE_TYPE_NB];
190 Bitboard byColorBB[COLOR_NB];
191 int pieceCount[COLOR_NB][PIECE_TYPE_NB];
192 Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
193 int index[SQUARE_NB];
194 int castlingRightsMask[SQUARE_NB];
195 Square castlingRookSquare[CASTLING_RIGHT_NB];
196 Bitboard castlingPath[CASTLING_RIGHT_NB];
205 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
207 inline Color Position::side_to_move() const {
211 inline bool Position::empty(Square s) const {
212 return board[s] == NO_PIECE;
215 inline Piece Position::piece_on(Square s) const {
219 inline Piece Position::moved_piece(Move m) const {
220 return board[from_sq(m)];
223 inline Bitboard Position::pieces() const {
224 return byTypeBB[ALL_PIECES];
227 inline Bitboard Position::pieces(PieceType pt) const {
231 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
232 return byTypeBB[pt1] | byTypeBB[pt2];
235 inline Bitboard Position::pieces(Color c) const {
239 inline Bitboard Position::pieces(Color c, PieceType pt) const {
240 return byColorBB[c] & byTypeBB[pt];
243 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
244 return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
247 template<PieceType Pt> inline int Position::count(Color c) const {
248 return pieceCount[c][Pt];
251 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
252 return pieceList[c][Pt];
255 template<PieceType Pt> inline Square Position::square(Color c) const {
256 assert(pieceCount[c][Pt] == 1);
257 return pieceList[c][Pt][0];
260 inline Square Position::ep_square() const {
264 inline int Position::can_castle(CastlingRight cr) const {
265 return st->castlingRights & cr;
268 inline int Position::can_castle(Color c) const {
269 return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
272 inline bool Position::castling_impeded(CastlingRight cr) const {
273 return byTypeBB[ALL_PIECES] & castlingPath[cr];
276 inline Square Position::castling_rook_square(CastlingRight cr) const {
277 return castlingRookSquare[cr];
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];
288 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
289 return StepAttacksBB[make_piece(c, PAWN)][s];
292 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
293 return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
296 inline Bitboard Position::attackers_to(Square s) const {
297 return attackers_to(s, byTypeBB[ALL_PIECES]);
300 inline Bitboard Position::checkers() const {
301 return st->checkersBB;
304 inline Bitboard Position::discovered_check_candidates() const {
305 return st->blockersForKing[~sideToMove] & pieces(sideToMove);
308 inline Bitboard Position::pinned_pieces(Color c) const {
309 return st->blockersForKing[c] & pieces(c);
312 inline Bitboard Position::check_squares(PieceType pt) const {
313 return st->checkSquares[pt];
316 inline bool Position::pawn_passed(Color c, Square s) const {
317 return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
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;
325 inline Key Position::key() const {
329 inline Key Position::pawn_key() const {
333 inline Key Position::material_key() const {
334 return st->materialKey;
337 inline Score Position::psq_score() const {
341 inline Value Position::non_pawn_material(Color c) const {
342 return st->nonPawnMaterial[c];
345 inline int Position::game_ply() const {
349 inline int Position::rule50_count() const {
353 inline uint64_t Position::nodes_searched() const {
357 inline void Position::set_nodes_searched(uint64_t n) {
361 inline bool Position::opposite_bishops() const {
362 return pieceCount[WHITE][BISHOP] == 1
363 && pieceCount[BLACK][BISHOP] == 1
364 && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
367 inline bool Position::is_chess960() const {
371 inline bool Position::capture_or_promotion(Move m) const {
374 return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
377 inline bool Position::capture(Move m) const {
379 // Castling is encoded as "king captures the rook"
381 return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
384 inline PieceType Position::captured_piece_type() const {
385 return st->capturedType;
388 inline Thread* Position::this_thread() const {
392 inline void Position::put_piece(Color c, PieceType pt, Square s) {
394 board[s] = make_piece(c, pt);
395 byTypeBB[ALL_PIECES] |= s;
398 index[s] = pieceCount[c][pt]++;
399 pieceList[c][pt][index[s]] = s;
400 pieceCount[c][ALL_PIECES]++;
403 inline void Position::remove_piece(Color c, PieceType pt, Square s) {
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;
412 /* board[s] = NO_PIECE; Not needed, overwritten by the capturing one */
413 Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
414 index[lastSquare] = index[s];
415 pieceList[c][pt][index[lastSquare]] = lastSquare;
416 pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
417 pieceCount[c][ALL_PIECES]--;
420 inline void Position::move_piece(Color c, PieceType pt, Square from, Square to) {
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[pt] ^= from_to_bb;
427 byColorBB[c] ^= from_to_bb;
428 board[from] = NO_PIECE;
429 board[to] = make_piece(c, pt);
430 index[to] = index[from];
431 pieceList[c][pt][index[to]] = to;
434 #endif // #ifndef POSITION_H_INCLUDED