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 /// Castle rights, encoded as bit fields
84 /// The StateInfo struct stores information we need to restore a Position
85 /// object to its previous state when we retract a move. Whenever a move
86 /// is made on the board (by calling Position::do_move), an StateInfo object
87 /// must be passed as a parameter.
90 Key key, pawnKey, materialKey;
91 int castleRights, rule50;
93 Value mgValue, egValue;
101 /// The position data structure. A position consists of the following data:
103 /// * For each piece type, a bitboard representing the squares occupied
104 /// by pieces of that type.
105 /// * For each color, a bitboard representing the squares occupied by
106 /// pieces of that color.
107 /// * A bitboard of all occupied squares.
108 /// * A bitboard of all checking pieces.
109 /// * A 64-entry array of pieces, indexed by the squares of the board.
110 /// * The current side to move.
111 /// * Information about the castling rights for both sides.
112 /// * The initial files of the kings and both pairs of rooks. This is
113 /// used to implement the Chess960 castling rules.
114 /// * The en passant square (which is SQ_NONE if no en passant capture is
116 /// * The squares of the kings for both sides.
117 /// * Hash keys for the position itself, the current pawn structure, and
118 /// the current material situation.
119 /// * Hash keys for all previous positions in the game for detecting
120 /// repetition draws.
121 /// * A counter for detecting 50 move rule draws.
125 friend class MaterialInfo;
126 friend class EndgameFunctions;
131 Position(const Position& pos);
132 Position(const std::string& fen);
135 void from_fen(const std::string& fen);
136 const std::string to_fen() const;
137 void print(Move m = MOVE_NONE) const;
140 void copy(const Position &pos);
141 void flipped_copy(const Position &pos);
143 // The piece on a given square
144 Piece piece_on(Square s) const;
145 PieceType type_of_piece_on(Square s) const;
146 Color color_of_piece_on(Square s) const;
147 bool square_is_empty(Square s) const;
148 bool square_is_occupied(Square s) const;
149 Value midgame_value_of_piece_on(Square s) const;
150 Value endgame_value_of_piece_on(Square s) const;
153 Color side_to_move() const;
155 // Bitboard representation of the position
156 Bitboard empty_squares() const;
157 Bitboard occupied_squares() const;
158 Bitboard pieces_of_color(Color c) const;
159 Bitboard pieces_of_type(PieceType pt) const;
160 Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
161 Bitboard pawns() const;
162 Bitboard knights() const;
163 Bitboard bishops() const;
164 Bitboard rooks() const;
165 Bitboard queens() const;
166 Bitboard kings() const;
167 Bitboard rooks_and_queens() const;
168 Bitboard bishops_and_queens() const;
169 Bitboard sliders() const;
170 Bitboard pawns(Color c) const;
171 Bitboard knights(Color c) const;
172 Bitboard bishops(Color c) const;
173 Bitboard rooks(Color c) const;
174 Bitboard queens(Color c) const;
175 Bitboard kings(Color c) const;
176 Bitboard rooks_and_queens(Color c) const;
177 Bitboard bishops_and_queens(Color c) const;
178 Bitboard sliders_of_color(Color c) const;
180 // Number of pieces of each color and type
181 int piece_count(Color c, PieceType pt) const;
183 // The en passant square
184 Square ep_square() const;
186 // Current king position for each color
187 Square king_square(Color c) const;
190 bool can_castle_kingside(Color c) const;
191 bool can_castle_queenside(Color c) const;
192 bool can_castle(Color c) const;
193 Square initial_kr_square(Color c) const;
194 Square initial_qr_square(Color c) const;
197 Bitboard sliding_attacks(Square s, Direction d) const;
198 Bitboard ray_attacks(Square s, SignedDirection d) const;
199 Bitboard pawn_attacks(Color c, Square s) const;
202 Bitboard piece_attacks(Square s) const;
204 // Bitboards for pinned pieces and discovered check candidates
205 Bitboard discovered_check_candidates(Color c) const;
206 Bitboard pinned_pieces(Color c, Bitboard& p) const;
207 Bitboard pinned_pieces(Color c) const;
210 Bitboard checkers() const;
213 Square piece_list(Color c, PieceType pt, int index) const;
215 // Attack information for a given square
216 bool square_is_attacked(Square s, Color c) const;
217 Bitboard attacks_to(Square s) const;
218 Bitboard attacks_to(Square s, Color c) const;
219 bool is_check() const;
220 bool pawn_attacks_square(Color c, Square f, Square t) const;
223 Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
225 bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
227 // Properties of moves
228 bool pl_move_is_legal(Move m) const;
229 bool pl_move_is_legal(Move m, Bitboard pinned) const;
230 bool move_is_check(Move m) const;
231 bool move_is_check(Move m, Bitboard dcCandidates) const;
232 bool move_is_capture(Move m) const;
233 bool move_is_deep_pawn_push(Move m) const;
234 bool move_is_pawn_push_to_7th(Move m) const;
235 bool move_is_passed_pawn_push(Move m) const;
236 bool move_was_passed_pawn_push(Move m) const;
237 bool move_attacks_square(Move m, Square s) const;
239 // Information about pawns
240 bool pawn_is_passed(Color c, Square s) const;
241 bool pawn_is_isolated(Color c, Square s) const;
242 bool pawn_is_doubled(Color c, Square s) const;
244 // Open and half-open files
245 bool file_is_open(File f) const;
246 bool file_is_half_open(Color c, File f) const;
249 bool square_is_weak(Square s, Color c) const;
251 // Doing and undoing moves
252 void setStartState(const StateInfo& st);
253 void do_move(Move m, StateInfo& st);
254 void do_move(Move m, StateInfo& st, Bitboard dcCandidates);
255 void undo_move(Move m);
256 void do_null_move(StateInfo& st);
257 void undo_null_move();
259 // Static exchange evaluation
260 int see(Square from, Square to) const;
261 int see(Move m) const;
262 int see(Square to) const;
264 // Accessing hash keys
266 Key get_pawn_key() const;
267 Key get_material_key() const;
269 // Incremental evaluation
270 Value mg_value() const;
271 Value eg_value() const;
272 Value non_pawn_material(Color c) const;
273 Phase game_phase() const;
274 Value mg_pst_delta(Move m) const;
276 // Game termination checks
277 bool is_mate() const;
278 bool is_draw() const;
280 // Check if one side threatens a mate in one
281 bool has_mate_threat(Color c);
283 // Number of plies since the last non-reversible move
284 int rule_50_counter() const;
286 // Other properties of the position
287 bool opposite_colored_bishops() const;
288 bool has_pawn_on_7th(Color c) const;
290 // Reset the gamePly variable to 0
291 void reset_game_ply();
293 // Position consistency check, for debugging
294 bool is_ok(int* failedStep = NULL) const;
296 // Static member functions:
297 static void init_zobrist();
298 static void init_piece_square_tables();
302 // Initialization helper functions (used while setting up a position)
304 void put_piece(Piece p, Square s);
305 void allow_oo(Color c);
306 void allow_ooo(Color c);
308 // Helper functions for doing and undoing moves
309 void do_capture_move(PieceType capture, Color them, Square to);
310 void do_castle_move(Move m);
311 void do_promotion_move(Move m);
312 void do_ep_move(Move m);
313 void undo_castle_move(Move m);
314 void undo_promotion_move(Move m);
315 void undo_ep_move(Move m);
316 void find_checkers();
318 template<PieceType Piece>
319 void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
321 template<bool FindPinned>
322 Bitboard hidden_checkers(Color c) const;
324 // Computing hash keys from scratch (for initialization and debugging)
325 Key compute_key() const;
326 Key compute_pawn_key() const;
327 Key compute_material_key() const;
329 // Computing incremental evaluation scores and material counts
334 template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
335 template<GamePhase> Value compute_value() const;
336 Value compute_non_pawn_material(Color c) const;
339 Bitboard byColorBB[2], byTypeBB[8];
345 int pieceCount[2][8]; // [color][pieceType]
348 Square pieceList[2][8][16]; // [color][pieceType][index]
352 Square kingSquare[2];
355 Key history[MaxGameLength];
357 File initialKFile, initialKRFile, initialQRFile;
358 StateInfo startState;
362 static int castleRightsMask[64];
363 static Key zobrist[2][8][64];
364 static Key zobEp[64];
365 static Key zobCastle[16];
366 static Key zobMaterial[2][8][16];
367 static Key zobSideToMove;
368 static Value MgPieceSquareTable[16][64];
369 static Value EgPieceSquareTable[16][64];
374 //// Inline functions
377 inline Piece Position::piece_on(Square s) const {
381 inline Color Position::color_of_piece_on(Square s) const {
382 return color_of_piece(piece_on(s));
385 inline PieceType Position::type_of_piece_on(Square s) const {
386 return type_of_piece(piece_on(s));
389 inline bool Position::square_is_empty(Square s) const {
390 return piece_on(s) == EMPTY;
393 inline bool Position::square_is_occupied(Square s) const {
394 return !square_is_empty(s);
397 inline Value Position::midgame_value_of_piece_on(Square s) const {
398 return piece_value_midgame(piece_on(s));
401 inline Value Position::endgame_value_of_piece_on(Square s) const {
402 return piece_value_endgame(piece_on(s));
405 inline Color Position::side_to_move() const {
409 inline Bitboard Position::occupied_squares() const {
413 inline Bitboard Position::empty_squares() const {
414 return ~(occupied_squares());
417 inline Bitboard Position::pieces_of_color(Color c) const {
421 inline Bitboard Position::pieces_of_type(PieceType pt) const {
425 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
426 return pieces_of_color(c) & pieces_of_type(pt);
429 inline Bitboard Position::pawns() const {
430 return pieces_of_type(PAWN);
433 inline Bitboard Position::knights() const {
434 return pieces_of_type(KNIGHT);
437 inline Bitboard Position::bishops() const {
438 return pieces_of_type(BISHOP);
441 inline Bitboard Position::rooks() const {
442 return pieces_of_type(ROOK);
445 inline Bitboard Position::queens() const {
446 return pieces_of_type(QUEEN);
449 inline Bitboard Position::kings() const {
450 return pieces_of_type(KING);
453 inline Bitboard Position::rooks_and_queens() const {
454 return rooks() | queens();
457 inline Bitboard Position::bishops_and_queens() const {
458 return bishops() | queens();
461 inline Bitboard Position::sliders() const {
462 return bishops() | queens() | rooks();
465 inline Bitboard Position::pawns(Color c) const {
466 return pieces_of_color_and_type(c, PAWN);
469 inline Bitboard Position::knights(Color c) const {
470 return pieces_of_color_and_type(c, KNIGHT);
473 inline Bitboard Position::bishops(Color c) const {
474 return pieces_of_color_and_type(c, BISHOP);
477 inline Bitboard Position::rooks(Color c) const {
478 return pieces_of_color_and_type(c, ROOK);
481 inline Bitboard Position::queens(Color c) const {
482 return pieces_of_color_and_type(c, QUEEN);
485 inline Bitboard Position::kings(Color c) const {
486 return pieces_of_color_and_type(c, KING);
489 inline Bitboard Position::rooks_and_queens(Color c) const {
490 return rooks_and_queens() & pieces_of_color(c);
493 inline Bitboard Position::bishops_and_queens(Color c) const {
494 return bishops_and_queens() & pieces_of_color(c);
497 inline Bitboard Position::sliders_of_color(Color c) const {
498 return sliders() & pieces_of_color(c);
501 inline int Position::piece_count(Color c, PieceType pt) const {
502 return pieceCount[c][pt];
505 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
506 return pieceList[c][pt][index];
509 inline Square Position::ep_square() const {
513 inline Square Position::king_square(Color c) const {
514 return kingSquare[c];
517 inline bool Position::can_castle_kingside(Color side) const {
518 return st->castleRights & (1+int(side));
521 inline bool Position::can_castle_queenside(Color side) const {
522 return st->castleRights & (4+4*int(side));
525 inline bool Position::can_castle(Color side) const {
526 return can_castle_kingside(side) || can_castle_queenside(side);
529 inline Square Position::initial_kr_square(Color c) const {
530 return relative_square(c, make_square(initialKRFile, RANK_1));
533 inline Square Position::initial_qr_square(Color c) const {
534 return relative_square(c, make_square(initialQRFile, RANK_1));
537 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
538 return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
542 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
543 return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
547 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
548 return StepAttackBB[KNIGHT][s];
552 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
553 return bishop_attacks_bb(s, occupied_squares());
557 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
558 return rook_attacks_bb(s, occupied_squares());
562 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
563 return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
567 inline Bitboard Position::piece_attacks<KING>(Square s) const {
568 return StepAttackBB[KING][s];
571 inline Bitboard Position::checkers() const {
572 return st->checkersBB;
575 inline bool Position::is_check() const {
576 return st->checkersBB != EmptyBoardBB;
579 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
580 return bit_is_set(pawn_attacks(c, f), t);
583 template<PieceType Piece>
584 Bitboard Position::piece_attacks_square(Square f, Square t) const {
585 return bit_is_set(piece_attacks<Piece>(f), t);
588 inline Bitboard Position::attacks_to(Square s, Color c) const {
590 return attacks_to(s) & pieces_of_color(c);
593 inline bool Position::square_is_attacked(Square s, Color c) const {
595 return attacks_to(s, c) != EmptyBoardBB;
598 inline bool Position::pawn_is_passed(Color c, Square s) const {
599 return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
602 inline bool Position::pawn_is_isolated(Color c, Square s) const {
603 return !(pawns(c) & neighboring_files_bb(s));
606 inline bool Position::pawn_is_doubled(Color c, Square s) const {
607 return pawns(c) & squares_behind(c, s);
610 inline bool Position::file_is_open(File f) const {
611 return !(pawns() & file_bb(f));
614 inline bool Position::file_is_half_open(Color c, File f) const {
615 return !(pawns(c) & file_bb(f));
618 inline bool Position::square_is_weak(Square s, Color c) const {
619 return !(pawns(c) & outpost_mask(opposite_color(c), s));
622 inline Key Position::get_key() const {
626 inline Key Position::get_pawn_key() const {
630 inline Key Position::get_material_key() const {
631 return st->materialKey;
634 template<Position::GamePhase Phase>
635 inline Value Position::pst(Color c, PieceType pt, Square s) const {
636 return (Phase == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
637 : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
640 inline Value Position::mg_pst_delta(Move m) const {
641 return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
642 -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
645 inline Value Position::mg_value() const {
649 inline Value Position::eg_value() const {
653 inline Value Position::non_pawn_material(Color c) const {
654 return npMaterial[c];
657 inline Phase Position::game_phase() const {
659 // Values modified by Joona Kiiski
660 static const Value MidgameLimit = Value(15713);
661 static const Value EndgameLimit = Value(4428);
663 Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
665 if (npm >= MidgameLimit)
666 return PHASE_MIDGAME;
667 else if(npm <= EndgameLimit)
668 return PHASE_ENDGAME;
670 return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
673 inline bool Position::move_is_deep_pawn_push(Move m) const {
675 Color c = side_to_move();
676 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
677 && relative_rank(c, move_to(m)) > RANK_4;
680 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
682 Color c = side_to_move();
683 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
684 && relative_rank(c, move_to(m)) == RANK_7;
687 inline bool Position::move_is_passed_pawn_push(Move m) const {
689 Color c = side_to_move();
690 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
691 && pawn_is_passed(c, move_to(m));
694 inline bool Position::move_was_passed_pawn_push(Move m) const {
696 Color c = opposite_color(side_to_move());
697 return piece_on(move_to(m)) == piece_of_color_and_type(c, PAWN)
698 && pawn_is_passed(c, move_to(m));
701 inline int Position::rule_50_counter() const {
706 inline bool Position::opposite_colored_bishops() const {
708 return piece_count(WHITE, BISHOP) == 1
709 && piece_count(BLACK, BISHOP) == 1
710 && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
713 inline bool Position::has_pawn_on_7th(Color c) const {
715 return pawns(c) & relative_rank_bb(c, RANK_7);
718 inline bool Position::move_is_capture(Move m) const {
720 // Move must not be MOVE_NONE !
722 return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
725 #endif // !defined(POSITION_H_INCLUDED)