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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
6 Stockfish is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 Stockfish is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #if !defined(POSITION_H_INCLUDED)
21 #define POSITION_H_INCLUDED
27 /// Maximum number of plies per game (220 should be enough, because the
28 /// maximum search depth is 100, and during position setup we reset the
29 /// move counter for every non-reversible move).
30 const int MaxGameLength = 220;
34 /// struct checkInfo is initialized at c'tor time and keeps
35 /// info used to detect if a move gives check.
39 explicit CheckInfo(const Position&);
41 Bitboard dcCandidates;
46 /// Castle rights, encoded as bit fields
64 /// The StateInfo struct stores information we need to restore a Position
65 /// object to its previous state when we retract a move. Whenever a move
66 /// is made on the board (by calling Position::do_move), an StateInfo object
67 /// must be passed as a parameter.
70 Key pawnKey, materialKey;
71 int castleRights, rule50, gamePly, pliesFromNull;
76 PieceType capturedType;
83 /// The position data structure. A position consists of the following data:
85 /// * For each piece type, a bitboard representing the squares occupied
86 /// by pieces of that type.
87 /// * For each color, a bitboard representing the squares occupied by
88 /// pieces of that color.
89 /// * A bitboard of all occupied squares.
90 /// * A bitboard of all checking pieces.
91 /// * A 64-entry array of pieces, indexed by the squares of the board.
92 /// * The current side to move.
93 /// * Information about the castling rights for both sides.
94 /// * The initial files of the kings and both pairs of rooks. This is
95 /// used to implement the Chess960 castling rules.
96 /// * The en passant square (which is SQ_NONE if no en passant capture is
98 /// * The squares of the kings for both sides.
99 /// * Hash keys for the position itself, the current pawn structure, and
100 /// the current material situation.
101 /// * Hash keys for all previous positions in the game for detecting
102 /// repetition draws.
103 /// * A counter for detecting 50 move rule draws.
107 friend class MaterialInfo;
108 friend class EndgameFunctions;
110 Position(); // No default or copy c'tor allowed
111 Position(const Position& pos);
120 Position(const Position& pos, int threadID);
121 Position(const std::string& fen, bool isChess960, int threadID);
124 void from_fen(const std::string& fen, bool isChess960);
125 const std::string to_fen() const;
126 void print(Move m = MOVE_NONE) const;
129 void flipped_copy(const Position& pos);
131 // The piece on a given square
132 Piece piece_on(Square s) const;
133 PieceType type_of_piece_on(Square s) const;
134 Color color_of_piece_on(Square s) const;
135 bool square_is_empty(Square s) const;
136 bool square_is_occupied(Square s) const;
137 Value midgame_value_of_piece_on(Square s) const;
138 Value endgame_value_of_piece_on(Square s) const;
141 Color side_to_move() const;
143 // Bitboard representation of the position
144 Bitboard empty_squares() const;
145 Bitboard occupied_squares() const;
146 Bitboard pieces_of_color(Color c) const;
147 Bitboard pieces(PieceType pt) const;
148 Bitboard pieces(PieceType pt, Color c) const;
149 Bitboard pieces(PieceType pt1, PieceType pt2) const;
150 Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
152 // Number of pieces of each color and type
153 int piece_count(Color c, PieceType pt) const;
155 // The en passant square
156 Square ep_square() const;
158 // Current king position for each color
159 Square king_square(Color c) const;
162 bool can_castle_kingside(Color c) const;
163 bool can_castle_queenside(Color c) const;
164 bool can_castle(Color c) const;
165 Square initial_kr_square(Color c) const;
166 Square initial_qr_square(Color c) const;
168 // Bitboards for pinned pieces and discovered check candidates
169 Bitboard discovered_check_candidates(Color c) const;
170 Bitboard pinned_pieces(Color c) const;
172 // Checking pieces and under check information
173 Bitboard checkers() const;
174 bool is_check() const;
177 Square piece_list(Color c, PieceType pt, int index) const;
178 const Square* piece_list_begin(Color c, PieceType pt) const;
180 // Information about attacks to or from a given square
181 Bitboard attackers_to(Square s) const;
182 Bitboard attacks_from(Piece p, Square s) const;
183 static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
184 template<PieceType> Bitboard attacks_from(Square s) const;
185 template<PieceType> Bitboard attacks_from(Square s, Color c) const;
187 // Properties of moves
188 bool pl_move_is_legal(Move m, Bitboard pinned) const;
189 bool pl_move_is_evasion(Move m, Bitboard pinned) const;
190 bool move_is_check(Move m) const;
191 bool move_is_check(Move m, const CheckInfo& ci) const;
192 bool move_is_capture(Move m) const;
193 bool move_is_capture_or_promotion(Move m) const;
194 bool move_is_passed_pawn_push(Move m) const;
195 bool move_attacks_square(Move m, Square s) const;
197 // Piece captured with previous moves
198 PieceType captured_piece_type() const;
200 // Information about pawns
201 bool pawn_is_passed(Color c, Square s) const;
204 bool square_is_weak(Square s, Color c) const;
206 // Doing and undoing moves
207 void do_setup_move(Move m);
208 void do_move(Move m, StateInfo& st);
209 void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
210 void undo_move(Move m);
211 void do_null_move(StateInfo& st);
212 void undo_null_move();
214 // Static exchange evaluation
215 int see(Square from, Square to) const;
216 int see(Move m) const;
217 int see_sign(Move m) const;
219 // Accessing hash keys
221 Key get_exclusion_key() const;
222 Key get_pawn_key() const;
223 Key get_material_key() const;
225 // Incremental evaluation
227 Value non_pawn_material(Color c) const;
228 static Score pst_delta(Piece piece, Square from, Square to);
230 // Game termination checks
231 bool is_mate() const;
232 bool is_draw() const;
234 // Check if side to move could be mated in one
235 bool has_mate_threat();
237 // Number of plies from starting position
238 int startpos_ply_counter() const;
240 // Other properties of the position
241 bool opposite_colored_bishops() const;
242 bool has_pawn_on_7th(Color c) const;
243 bool is_chess960() const;
245 // Current thread ID searching on the position
248 int64_t nodes_searched() const;
249 void set_nodes_searched(int64_t n);
251 // Position consistency check, for debugging
252 bool is_ok(int* failedStep = NULL) const;
254 // Static member functions
255 static void init_zobrist();
256 static void init_piece_square_tables();
260 // Initialization helper functions (used while setting up a position)
263 void put_piece(Piece p, Square s);
264 void do_allow_oo(Color c);
265 void do_allow_ooo(Color c);
266 bool set_castling_rights(char token);
268 // Helper functions for doing and undoing moves
269 void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
270 void do_castle_move(Move m);
271 void undo_castle_move(Move m);
272 void find_checkers();
274 template<bool FindPinned>
275 Bitboard hidden_checkers(Color c) const;
277 // Computing hash keys from scratch (for initialization and debugging)
278 Key compute_key() const;
279 Key compute_pawn_key() const;
280 Key compute_material_key() const;
282 // Computing incremental evaluation scores and material counts
283 static Score pst(Color c, PieceType pt, Square s);
284 Score compute_value() const;
285 Value compute_non_pawn_material(Color c) const;
291 Bitboard byTypeBB[8], byColorBB[2];
294 int pieceCount[2][8]; // [color][pieceType]
297 Square pieceList[2][8][16]; // [color][pieceType][index]
298 int index[64]; // [square]
302 Key history[MaxGameLength];
303 int castleRightsMask[64];
304 StateInfo startState;
305 File initialKFile, initialKRFile, initialQRFile;
307 int startPosPlyCounter;
313 static Key zobrist[2][8][64];
314 static Key zobEp[64];
315 static Key zobCastle[16];
316 static Key zobSideToMove;
317 static Score PieceSquareTable[16][64];
318 static Key zobExclusion;
319 static const Value seeValues[8];
320 static const Value PieceValueMidgame[17];
321 static const Value PieceValueEndgame[17];
324 inline int64_t Position::nodes_searched() const {
328 inline void Position::set_nodes_searched(int64_t n) {
332 inline Piece Position::piece_on(Square s) const {
336 inline Color Position::color_of_piece_on(Square s) const {
337 return color_of_piece(piece_on(s));
340 inline PieceType Position::type_of_piece_on(Square s) const {
341 return type_of_piece(piece_on(s));
344 inline bool Position::square_is_empty(Square s) const {
345 return piece_on(s) == PIECE_NONE;
348 inline bool Position::square_is_occupied(Square s) const {
349 return !square_is_empty(s);
352 inline Value Position::midgame_value_of_piece_on(Square s) const {
353 return PieceValueMidgame[piece_on(s)];
356 inline Value Position::endgame_value_of_piece_on(Square s) const {
357 return PieceValueEndgame[piece_on(s)];
360 inline Color Position::side_to_move() const {
364 inline Bitboard Position::occupied_squares() const {
368 inline Bitboard Position::empty_squares() const {
369 return ~occupied_squares();
372 inline Bitboard Position::pieces_of_color(Color c) const {
376 inline Bitboard Position::pieces(PieceType pt) const {
380 inline Bitboard Position::pieces(PieceType pt, Color c) const {
381 return byTypeBB[pt] & byColorBB[c];
384 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
385 return byTypeBB[pt1] | byTypeBB[pt2];
388 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
389 return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
392 inline int Position::piece_count(Color c, PieceType pt) const {
393 return pieceCount[c][pt];
396 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
397 return pieceList[c][pt][idx];
400 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
401 return pieceList[c][pt];
404 inline Square Position::ep_square() const {
408 inline Square Position::king_square(Color c) const {
409 return pieceList[c][KING][0];
412 inline bool Position::can_castle_kingside(Color side) const {
413 return st->castleRights & (1+int(side));
416 inline bool Position::can_castle_queenside(Color side) const {
417 return st->castleRights & (4+4*int(side));
420 inline bool Position::can_castle(Color side) const {
421 return can_castle_kingside(side) || can_castle_queenside(side);
424 inline Square Position::initial_kr_square(Color c) const {
425 return relative_square(c, make_square(initialKRFile, RANK_1));
428 inline Square Position::initial_qr_square(Color c) const {
429 return relative_square(c, make_square(initialQRFile, RANK_1));
433 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
434 return StepAttacksBB[make_piece(c, PAWN)][s];
437 template<PieceType Piece> // Knight and King and white pawns
438 inline Bitboard Position::attacks_from(Square s) const {
439 return StepAttacksBB[Piece][s];
443 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
444 return bishop_attacks_bb(s, occupied_squares());
448 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
449 return rook_attacks_bb(s, occupied_squares());
453 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
454 return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
457 inline Bitboard Position::checkers() const {
458 return st->checkersBB;
461 inline bool Position::is_check() const {
462 return st->checkersBB != EmptyBoardBB;
465 inline bool Position::pawn_is_passed(Color c, Square s) const {
466 return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
469 inline bool Position::square_is_weak(Square s, Color c) const {
470 return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
473 inline Key Position::get_key() const {
477 inline Key Position::get_exclusion_key() const {
478 return st->key ^ zobExclusion;
481 inline Key Position::get_pawn_key() const {
485 inline Key Position::get_material_key() const {
486 return st->materialKey;
489 inline Score Position::pst(Color c, PieceType pt, Square s) {
490 return PieceSquareTable[make_piece(c, pt)][s];
493 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
494 return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
497 inline Score Position::value() const {
501 inline Value Position::non_pawn_material(Color c) const {
502 return st->npMaterial[c];
505 inline bool Position::move_is_passed_pawn_push(Move m) const {
507 Color c = side_to_move();
508 return piece_on(move_from(m)) == make_piece(c, PAWN)
509 && pawn_is_passed(c, move_to(m));
512 inline int Position::startpos_ply_counter() const {
513 return startPosPlyCounter;
516 inline bool Position::opposite_colored_bishops() const {
518 return piece_count(WHITE, BISHOP) == 1 && piece_count(BLACK, BISHOP) == 1
519 && opposite_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
522 inline bool Position::has_pawn_on_7th(Color c) const {
523 return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
526 inline bool Position::is_chess960() const {
530 inline bool Position::move_is_capture(Move m) const {
532 // Move must not be MOVE_NONE !
533 return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
536 inline bool Position::move_is_capture_or_promotion(Move m) const {
538 // Move must not be MOVE_NONE !
539 return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
542 inline PieceType Position::captured_piece_type() const {
543 return st->capturedType;
546 inline int Position::thread() const {
550 inline void Position::do_allow_oo(Color c) {
551 st->castleRights |= (1 + int(c));
554 inline void Position::do_allow_ooo(Color c) {
555 st->castleRights |= (4 + 4*int(c));
558 #endif // !defined(POSITION_H_INCLUDED)