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-2009 Marco Costalba
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/>.
21 #if !defined(POSITION_H_INCLUDED)
22 #define POSITION_H_INCLUDED
24 // Disable some silly and noisy warning from MSVC compiler
27 // Forcing value to bool 'true' or 'false' (performance warning)
28 #pragma warning(disable: 4800)
30 // Conditional expression is constant
31 #pragma warning(disable: 4127)
42 #include "direction.h"
53 /// FEN string for the initial position
54 const std::string StartPosition = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
56 /// Maximum number of plies per game (220 should be enough, because the
57 /// maximum search depth is 100, and during position setup we reset the
58 /// move counter for every non-reversible move).
59 const int MaxGameLength = 220;
66 /// struct checkInfo is initialized at c'tor time and keeps
67 /// info used to detect if a move gives check.
71 CheckInfo(const Position&);
74 Bitboard dcCandidates;
78 /// Castle rights, encoded as bit fields
96 /// The StateInfo struct stores information we need to restore a Position
97 /// object to its previous state when we retract a move. Whenever a move
98 /// is made on the board (by calling Position::do_move), an StateInfo object
99 /// must be passed as a parameter.
102 Key pawnKey, materialKey;
103 int castleRights, rule50, pliesFromNull;
115 /// The position data structure. A position consists of the following data:
117 /// * For each piece type, a bitboard representing the squares occupied
118 /// by pieces of that type.
119 /// * For each color, a bitboard representing the squares occupied by
120 /// pieces of that color.
121 /// * A bitboard of all occupied squares.
122 /// * A bitboard of all checking pieces.
123 /// * A 64-entry array of pieces, indexed by the squares of the board.
124 /// * The current side to move.
125 /// * Information about the castling rights for both sides.
126 /// * The initial files of the kings and both pairs of rooks. This is
127 /// used to implement the Chess960 castling rules.
128 /// * The en passant square (which is SQ_NONE if no en passant capture is
130 /// * The squares of the kings for both sides.
131 /// * Hash keys for the position itself, the current pawn structure, and
132 /// the current material situation.
133 /// * Hash keys for all previous positions in the game for detecting
134 /// repetition draws.
135 /// * A counter for detecting 50 move rule draws.
139 friend class MaterialInfo;
140 friend class EndgameFunctions;
150 explicit Position(const Position& pos);
151 explicit Position(const std::string& fen);
154 void from_fen(const std::string& fen);
155 const std::string to_fen() const;
156 void print(Move m = MOVE_NONE) const;
159 void fast_copy(const Position& pos);
160 void flipped_copy(const Position& pos);
162 // The piece on a given square
163 Piece piece_on(Square s) const;
164 PieceType type_of_piece_on(Square s) const;
165 Color color_of_piece_on(Square s) const;
166 bool square_is_empty(Square s) const;
167 bool square_is_occupied(Square s) const;
168 Value midgame_value_of_piece_on(Square s) const;
169 Value endgame_value_of_piece_on(Square s) const;
172 Color side_to_move() const;
174 // Bitboard representation of the position
175 Bitboard empty_squares() const;
176 Bitboard occupied_squares() const;
177 Bitboard pieces_of_color(Color c) const;
178 Bitboard pieces(PieceType pt) const;
179 Bitboard pieces(PieceType pt, Color c) const;
180 Bitboard pieces(PieceType pt1, PieceType pt2) const;
181 Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
183 // Number of pieces of each color and type
184 int piece_count(Color c, PieceType pt) const;
186 // The en passant square
187 Square ep_square() const;
189 // Current king position for each color
190 Square king_square(Color c) const;
193 bool can_castle_kingside(Color c) const;
194 bool can_castle_queenside(Color c) const;
195 bool can_castle(Color c) const;
196 Square initial_kr_square(Color c) const;
197 Square initial_qr_square(Color c) const;
199 // Bitboards for pinned pieces and discovered check candidates
200 Bitboard discovered_check_candidates(Color c) const;
201 Bitboard pinned_pieces(Color c) const;
203 // Checking pieces and under check information
204 Bitboard checkers() const;
205 bool is_check() const;
208 Square piece_list(Color c, PieceType pt, int index) const;
209 const Square* piece_list_begin(Color c, PieceType pt) const;
211 // Information about attacks to or from a given square
212 Bitboard attackers_to(Square s) const;
213 Bitboard attacks_from(Piece p, Square s) const;
214 template<PieceType> Bitboard attacks_from(Square s) const;
215 template<PieceType> Bitboard attacks_from(Square s, Color c) const;
217 // Properties of moves
218 bool pl_move_is_legal(Move m, Bitboard pinned) const;
219 bool pl_move_is_evasion(Move m, Bitboard pinned) const;
220 bool move_is_check(Move m) const;
221 bool move_is_check(Move m, const CheckInfo& ci) const;
222 bool move_is_capture(Move m) const;
223 bool move_is_capture_or_promotion(Move m) const;
224 bool move_is_passed_pawn_push(Move m) const;
225 bool move_attacks_square(Move m, Square s) const;
227 // Information about pawns
228 bool pawn_is_passed(Color c, Square s) const;
229 static bool pawn_is_passed(Bitboard theirPawns, Color c, Square s);
230 static bool pawn_is_isolated(Bitboard ourPawns, Square s);
231 static bool pawn_is_doubled(Bitboard ourPawns, Color c, Square s);
234 bool square_is_weak(Square s, Color c) const;
236 // Doing and undoing moves
238 void do_move(Move m, StateInfo& st);
239 void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
240 void undo_move(Move m);
241 void do_null_move(StateInfo& st);
242 void undo_null_move();
245 PieceType captured_piece() const;
247 // Static exchange evaluation
248 int see(Square from, Square to) const;
249 int see(Move m) const;
250 int see(Square to) const;
251 int see_sign(Move m) const;
253 // Accessing hash keys
255 Key get_exclusion_key() const;
256 Key get_pawn_key() const;
257 Key get_material_key() const;
259 // Incremental evaluation
261 Value non_pawn_material(Color c) const;
262 Score pst_delta(Piece piece, Square from, Square to) const;
264 // Game termination checks
265 bool is_mate() const;
266 bool is_draw() const;
268 // Check if one side threatens a mate in one
269 bool has_mate_threat(Color c);
271 // Number of plies since the last non-reversible move
272 int rule_50_counter() const;
274 // Other properties of the position
275 bool opposite_colored_bishops() const;
276 bool has_pawn_on_7th(Color c) const;
278 // Reset the gamePly variable to 0
279 void reset_game_ply();
281 // Position consistency check, for debugging
282 bool is_ok(int* failedStep = NULL) const;
284 // Static member functions
285 static void init_zobrist();
286 static void init_piece_square_tables();
290 // Initialization helper functions (used while setting up a position)
292 void put_piece(Piece p, Square s);
293 void allow_oo(Color c);
294 void allow_ooo(Color c);
296 // Helper functions for doing and undoing moves
297 void do_capture_move(Bitboard& key, PieceType capture, Color them, Square to, bool ep);
298 void do_castle_move(Move m);
299 void undo_castle_move(Move m);
300 void find_checkers();
302 template<bool FindPinned>
303 Bitboard hidden_checkers(Color c) const;
305 // Computing hash keys from scratch (for initialization and debugging)
306 Key compute_key() const;
307 Key compute_pawn_key() const;
308 Key compute_material_key() const;
310 // Computing incremental evaluation scores and material counts
311 Score pst(Color c, PieceType pt, Square s) const;
312 Score compute_value() const;
313 Value compute_non_pawn_material(Color c) const;
319 Bitboard byTypeBB[8], byColorBB[2];
322 int pieceCount[2][8]; // [color][pieceType]
325 Square pieceList[2][8][16]; // [color][pieceType][index]
326 int index[64]; // [square]
331 Key history[MaxGameLength];
332 File initialKFile, initialKRFile, initialQRFile;
333 StateInfo startState;
337 static int castleRightsMask[64];
338 static Key zobrist[2][8][64];
339 static Key zobEp[64];
340 static Key zobCastle[16];
341 static Key zobMaterial[2][8][16];
342 static Key zobSideToMove;
343 static Score PieceSquareTable[16][64];
344 static Key zobExclusion;
349 //// Inline functions
352 inline Piece Position::piece_on(Square s) const {
356 inline Color Position::color_of_piece_on(Square s) const {
357 return color_of_piece(piece_on(s));
360 inline PieceType Position::type_of_piece_on(Square s) const {
361 return type_of_piece(piece_on(s));
364 inline bool Position::square_is_empty(Square s) const {
365 return piece_on(s) == EMPTY;
368 inline bool Position::square_is_occupied(Square s) const {
369 return !square_is_empty(s);
372 inline Value Position::midgame_value_of_piece_on(Square s) const {
373 return piece_value_midgame(piece_on(s));
376 inline Value Position::endgame_value_of_piece_on(Square s) const {
377 return piece_value_endgame(piece_on(s));
380 inline Color Position::side_to_move() const {
384 inline Bitboard Position::occupied_squares() const {
388 inline Bitboard Position::empty_squares() const {
389 return ~(occupied_squares());
392 inline Bitboard Position::pieces_of_color(Color c) const {
396 inline Bitboard Position::pieces(PieceType pt) const {
400 inline Bitboard Position::pieces(PieceType pt, Color c) const {
401 return byTypeBB[pt] & byColorBB[c];
404 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
405 return byTypeBB[pt1] | byTypeBB[pt2];
408 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
409 return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
412 inline int Position::piece_count(Color c, PieceType pt) const {
413 return pieceCount[c][pt];
416 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
417 return pieceList[c][pt][index];
420 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
421 return pieceList[c][pt];
424 inline Square Position::ep_square() const {
428 inline Square Position::king_square(Color c) const {
429 return pieceList[c][KING][0];
432 inline bool Position::can_castle_kingside(Color side) const {
433 return st->castleRights & (1+int(side));
436 inline bool Position::can_castle_queenside(Color side) const {
437 return st->castleRights & (4+4*int(side));
440 inline bool Position::can_castle(Color side) const {
441 return can_castle_kingside(side) || can_castle_queenside(side);
444 inline Square Position::initial_kr_square(Color c) const {
445 return relative_square(c, make_square(initialKRFile, RANK_1));
448 inline Square Position::initial_qr_square(Color c) const {
449 return relative_square(c, make_square(initialQRFile, RANK_1));
453 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
454 return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
457 template<PieceType Piece> // Knight and King and white pawns
458 inline Bitboard Position::attacks_from(Square s) const {
459 return StepAttackBB[Piece][s];
463 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
464 return bishop_attacks_bb(s, occupied_squares());
468 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
469 return rook_attacks_bb(s, occupied_squares());
473 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
474 return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
477 inline Bitboard Position::checkers() const {
478 return st->checkersBB;
481 inline bool Position::is_check() const {
482 return st->checkersBB != EmptyBoardBB;
485 inline bool Position::pawn_is_passed(Color c, Square s) const {
486 return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
489 inline bool Position::pawn_is_passed(Bitboard theirPawns, Color c, Square s) {
490 return !(theirPawns & passed_pawn_mask(c, s));
493 inline bool Position::pawn_is_isolated(Bitboard ourPawns, Square s) {
494 return !(ourPawns & neighboring_files_bb(s));
497 inline bool Position::pawn_is_doubled(Bitboard ourPawns, Color c, Square s) {
498 return ourPawns & squares_behind(c, s);
501 inline bool Position::square_is_weak(Square s, Color c) const {
502 return !(pieces(PAWN, c) & outpost_mask(opposite_color(c), s));
505 inline Key Position::get_key() const {
509 inline Key Position::get_exclusion_key() const {
510 return st->key ^ zobExclusion;
513 inline Key Position::get_pawn_key() const {
517 inline Key Position::get_material_key() const {
518 return st->materialKey;
521 inline Score Position::pst(Color c, PieceType pt, Square s) const {
522 return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
525 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
526 return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
529 inline Score Position::value() const {
533 inline Value Position::non_pawn_material(Color c) const {
534 return st->npMaterial[c];
537 inline bool Position::move_is_passed_pawn_push(Move m) const {
539 Color c = side_to_move();
540 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
541 && pawn_is_passed(c, move_to(m));
544 inline int Position::rule_50_counter() const {
549 inline bool Position::opposite_colored_bishops() const {
551 return piece_count(WHITE, BISHOP) == 1
552 && piece_count(BLACK, BISHOP) == 1
553 && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
556 inline bool Position::has_pawn_on_7th(Color c) const {
558 return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
561 inline bool Position::move_is_capture(Move m) const {
563 // Move must not be MOVE_NONE !
564 return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
567 inline bool Position::move_is_capture_or_promotion(Move m) const {
569 // Move must not be MOVE_NONE !
570 return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
573 #endif // !defined(POSITION_H_INCLUDED)