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 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 a 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 =
55 "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
57 /// Maximum number of plies per game (220 should be enough, because the
58 /// maximum search depth is 100, and during position setup we reset the
59 /// move counter for every non-reversible move):
60 const int MaxGameLength = 220;
67 /// Castle rights, encoded as bit fields
85 /// The StateInfo struct stores information we need to restore a Position
86 /// object to its previous state when we retract a move. Whenever a move
87 /// is made on the board (by calling Position::do_move), an StateInfo object
88 /// must be passed as a parameter.
91 Key key, pawnKey, materialKey;
92 int castleRights, rule50;
94 Value mgValue, egValue;
103 /// The position data structure. A position consists of the following data:
105 /// * For each piece type, a bitboard representing the squares occupied
106 /// by pieces of that type.
107 /// * For each color, a bitboard representing the squares occupiecd by
108 /// pieces of that color.
109 /// * A bitboard of all occupied squares.
110 /// * A bitboard of all checking pieces.
111 /// * A 64-entry array of pieces, indexed by the squares of the board.
112 /// * The current side to move.
113 /// * Information about the castling rights for both sides.
114 /// * The initial files of the kings and both pairs of rooks. This is
115 /// used to implement the Chess960 castling rules.
116 /// * The en passant square (which is SQ_NONE if no en passant capture is
118 /// * The squares of the kings for both sides.
119 /// * The last move played.
120 /// * Hash keys for the position itself, the current pawn structure, and
121 /// the current material situation.
122 /// * Hash keys for all previous positions in the game (for detecting
123 /// repetition draws.
124 /// * A counter for detecting 50 move rule draws.
128 friend class MaterialInfo;
129 friend class EndgameFunctions;
134 Position(const Position& pos);
135 Position(const std::string& fen);
138 void from_fen(const std::string& fen);
139 const std::string to_fen() const;
140 void print(Move m = MOVE_NONE) const;
143 void copy(const Position &pos);
144 void flipped_copy(const Position &pos);
146 // The piece on a given square
147 Piece piece_on(Square s) const;
148 PieceType type_of_piece_on(Square s) const;
149 Color color_of_piece_on(Square s) const;
150 bool square_is_empty(Square s) const;
151 bool square_is_occupied(Square s) const;
152 Value midgame_value_of_piece_on(Square s) const;
153 Value endgame_value_of_piece_on(Square s) const;
156 Color side_to_move() const;
158 // Bitboard representation of the position
159 Bitboard empty_squares() const;
160 Bitboard occupied_squares() const;
161 Bitboard pieces_of_color(Color c) const;
162 Bitboard pieces_of_type(PieceType pt) const;
163 Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
164 Bitboard pawns() const;
165 Bitboard knights() const;
166 Bitboard bishops() const;
167 Bitboard rooks() const;
168 Bitboard queens() const;
169 Bitboard kings() const;
170 Bitboard rooks_and_queens() const;
171 Bitboard bishops_and_queens() const;
172 Bitboard sliders() const;
173 Bitboard pawns(Color c) const;
174 Bitboard knights(Color c) const;
175 Bitboard bishops(Color c) const;
176 Bitboard rooks(Color c) const;
177 Bitboard queens(Color c) const;
178 Bitboard kings(Color c) const;
179 Bitboard rooks_and_queens(Color c) const;
180 Bitboard bishops_and_queens(Color c) const;
181 Bitboard sliders_of_color(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;
200 Bitboard sliding_attacks(Square s, Direction d) const;
201 Bitboard ray_attacks(Square s, SignedDirection d) const;
202 Bitboard pawn_attacks(Color c, Square s) const;
205 Bitboard piece_attacks(Square s) const;
207 // Bitboards for pinned pieces and discovered check candidates
208 Bitboard discovered_check_candidates(Color c) const;
209 Bitboard pinned_pieces(Color c, Bitboard& p) const;
210 Bitboard pinned_pieces(Color c) const;
213 Bitboard checkers() const;
216 Square piece_list(Color c, PieceType pt, int index) const;
218 // Attack information for a given square
219 bool square_is_attacked(Square s, Color c) const;
220 Bitboard attacks_to(Square s) const;
221 Bitboard attacks_to(Square s, Color c) const;
222 bool is_check() const;
223 bool pawn_attacks_square(Color c, Square f, Square t) const;
226 Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
228 bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
230 // Properties of moves
231 bool pl_move_is_legal(Move m) const;
232 bool pl_move_is_legal(Move m, Bitboard pinned) const;
233 bool move_is_check(Move m) const;
234 bool move_is_check(Move m, Bitboard dcCandidates) const;
235 bool move_is_capture(Move m) const;
236 bool move_is_deep_pawn_push(Move m) const;
237 bool move_is_pawn_push_to_7th(Move m) const;
238 bool move_is_passed_pawn_push(Move m) const;
239 bool move_was_passed_pawn_push(Move m) const;
240 bool move_attacks_square(Move m, Square s) const;
242 // Information about pawns
243 bool pawn_is_passed(Color c, Square s) const;
244 bool pawn_is_isolated(Color c, Square s) const;
245 bool pawn_is_doubled(Color c, Square s) const;
247 // Open and half-open files
248 bool file_is_open(File f) const;
249 bool file_is_half_open(Color c, File f) const;
252 bool square_is_weak(Square s, Color c) const;
254 // Doing and undoing moves
255 void setStartState(const StateInfo& st);
256 void do_move(Move m, StateInfo& st);
257 void do_move(Move m, StateInfo& st, Bitboard dcCandidates);
258 void undo_move(Move m);
259 void do_null_move(StateInfo& st);
260 void undo_null_move();
262 // Static exchange evaluation
263 int see(Square from, Square to) const;
264 int see(Move m) const;
265 int see(Square to) const;
267 // Accessing hash keys
269 Key get_pawn_key() const;
270 Key get_material_key() const;
272 // Incremental evaluation
273 Value mg_value() const;
274 Value eg_value() const;
275 Value non_pawn_material(Color c) const;
276 Phase game_phase() const;
277 Value mg_pst_delta(Move m) const;
279 // Game termination checks
280 bool is_mate() const;
281 bool is_draw() const;
283 // Check if one side threatens a mate in one
284 bool has_mate_threat(Color c);
286 // Number of plies since the last non-reversible move
287 int rule_50_counter() const;
289 // Other properties of the position
290 bool opposite_colored_bishops() const;
291 bool has_pawn_on_7th(Color c) const;
293 // Reset the gamePly variable to 0
294 void reset_game_ply();
296 // Position consistency check, for debugging
297 bool is_ok(int* failedStep = NULL) const;
299 // Static member functions:
300 static void init_zobrist();
301 static void init_piece_square_tables();
305 // Initialization helper functions (used while setting up a position)
307 void put_piece(Piece p, Square s);
308 void allow_oo(Color c);
309 void allow_ooo(Color c);
311 // Helper functions for doing and undoing moves
312 void do_capture_move(PieceType capture, Color them, Square to);
313 void do_castle_move(Move m);
314 void do_promotion_move(Move m);
315 void do_ep_move(Move m);
316 void undo_castle_move(Move m);
317 void undo_promotion_move(Move m);
318 void undo_ep_move(Move m);
319 void find_checkers();
321 template<PieceType Piece>
322 void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
324 template<bool FindPinned>
325 Bitboard hidden_checkers(Color c) const;
327 // Computing hash keys from scratch (for initialization and debugging)
328 Key compute_key() const;
329 Key compute_pawn_key() const;
330 Key compute_material_key() const;
332 // Computing incremental evaluation scores and material counts
337 template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
338 template<GamePhase> Value compute_value() const;
339 Value compute_non_pawn_material(Color c) const;
342 Bitboard byColorBB[2], byTypeBB[8];
348 int pieceCount[2][8]; // [color][pieceType]
351 Square pieceList[2][8][16]; // [color][pieceType][index]
355 Square kingSquare[2];
358 Key history[MaxGameLength];
360 File initialKFile, initialKRFile, initialQRFile;
361 StateInfo startState;
365 static int castleRightsMask[64];
366 static Key zobrist[2][8][64];
367 static Key zobEp[64];
368 static Key zobCastle[16];
369 static Key zobMaterial[2][8][16];
370 static Key zobSideToMove;
371 static Value MgPieceSquareTable[16][64];
372 static Value EgPieceSquareTable[16][64];
377 //// Inline functions
380 inline Piece Position::piece_on(Square s) const {
384 inline Color Position::color_of_piece_on(Square s) const {
385 return color_of_piece(piece_on(s));
388 inline PieceType Position::type_of_piece_on(Square s) const {
389 return type_of_piece(piece_on(s));
392 inline bool Position::square_is_empty(Square s) const {
393 return piece_on(s) == EMPTY;
396 inline bool Position::square_is_occupied(Square s) const {
397 return !square_is_empty(s);
400 inline Value Position::midgame_value_of_piece_on(Square s) const {
401 return piece_value_midgame(piece_on(s));
404 inline Value Position::endgame_value_of_piece_on(Square s) const {
405 return piece_value_endgame(piece_on(s));
408 inline Color Position::side_to_move() const {
412 inline Bitboard Position::occupied_squares() const {
416 inline Bitboard Position::empty_squares() const {
417 return ~(occupied_squares());
420 inline Bitboard Position::pieces_of_color(Color c) const {
424 inline Bitboard Position::pieces_of_type(PieceType pt) const {
428 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
429 return pieces_of_color(c) & pieces_of_type(pt);
432 inline Bitboard Position::pawns() const {
433 return pieces_of_type(PAWN);
436 inline Bitboard Position::knights() const {
437 return pieces_of_type(KNIGHT);
440 inline Bitboard Position::bishops() const {
441 return pieces_of_type(BISHOP);
444 inline Bitboard Position::rooks() const {
445 return pieces_of_type(ROOK);
448 inline Bitboard Position::queens() const {
449 return pieces_of_type(QUEEN);
452 inline Bitboard Position::kings() const {
453 return pieces_of_type(KING);
456 inline Bitboard Position::rooks_and_queens() const {
457 return rooks() | queens();
460 inline Bitboard Position::bishops_and_queens() const {
461 return bishops() | queens();
464 inline Bitboard Position::sliders() const {
465 return bishops() | queens() | rooks();
468 inline Bitboard Position::pawns(Color c) const {
469 return pieces_of_color_and_type(c, PAWN);
472 inline Bitboard Position::knights(Color c) const {
473 return pieces_of_color_and_type(c, KNIGHT);
476 inline Bitboard Position::bishops(Color c) const {
477 return pieces_of_color_and_type(c, BISHOP);
480 inline Bitboard Position::rooks(Color c) const {
481 return pieces_of_color_and_type(c, ROOK);
484 inline Bitboard Position::queens(Color c) const {
485 return pieces_of_color_and_type(c, QUEEN);
488 inline Bitboard Position::kings(Color c) const {
489 return pieces_of_color_and_type(c, KING);
492 inline Bitboard Position::rooks_and_queens(Color c) const {
493 return rooks_and_queens() & pieces_of_color(c);
496 inline Bitboard Position::bishops_and_queens(Color c) const {
497 return bishops_and_queens() & pieces_of_color(c);
500 inline Bitboard Position::sliders_of_color(Color c) const {
501 return sliders() & pieces_of_color(c);
504 inline int Position::piece_count(Color c, PieceType pt) const {
505 return pieceCount[c][pt];
508 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
509 return pieceList[c][pt][index];
512 inline Square Position::ep_square() const {
516 inline Square Position::king_square(Color c) const {
517 return kingSquare[c];
520 inline bool Position::can_castle_kingside(Color side) const {
521 return st->castleRights & (1+int(side));
524 inline bool Position::can_castle_queenside(Color side) const {
525 return st->castleRights & (4+4*int(side));
528 inline bool Position::can_castle(Color side) const {
529 return can_castle_kingside(side) || can_castle_queenside(side);
532 inline Square Position::initial_kr_square(Color c) const {
533 return relative_square(c, make_square(initialKRFile, RANK_1));
536 inline Square Position::initial_qr_square(Color c) const {
537 return relative_square(c, make_square(initialQRFile, RANK_1));
540 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
541 return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
545 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
546 return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
550 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
551 return StepAttackBB[KNIGHT][s];
555 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
556 return bishop_attacks_bb(s, occupied_squares());
560 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
561 return rook_attacks_bb(s, occupied_squares());
565 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
566 return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
570 inline Bitboard Position::piece_attacks<KING>(Square s) const {
571 return StepAttackBB[KING][s];
574 inline Bitboard Position::checkers() const {
575 return st->checkersBB;
578 inline bool Position::is_check() const {
579 return st->checkersBB != EmptyBoardBB;
582 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
583 return bit_is_set(pawn_attacks(c, f), t);
586 template<PieceType Piece>
587 Bitboard Position::piece_attacks_square(Square f, Square t) const {
588 return bit_is_set(piece_attacks<Piece>(f), t);
591 inline Bitboard Position::attacks_to(Square s, Color c) const {
593 return attacks_to(s) & pieces_of_color(c);
596 inline bool Position::square_is_attacked(Square s, Color c) const {
598 return attacks_to(s, c) != EmptyBoardBB;
601 inline bool Position::pawn_is_passed(Color c, Square s) const {
602 return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
605 inline bool Position::pawn_is_isolated(Color c, Square s) const {
606 return !(pawns(c) & neighboring_files_bb(s));
609 inline bool Position::pawn_is_doubled(Color c, Square s) const {
610 return pawns(c) & squares_behind(c, s);
613 inline bool Position::file_is_open(File f) const {
614 return !(pawns() & file_bb(f));
617 inline bool Position::file_is_half_open(Color c, File f) const {
618 return !(pawns(c) & file_bb(f));
621 inline bool Position::square_is_weak(Square s, Color c) const {
622 return !(pawns(c) & outpost_mask(opposite_color(c), s));
625 inline Key Position::get_key() const {
629 inline Key Position::get_pawn_key() const {
633 inline Key Position::get_material_key() const {
634 return st->materialKey;
637 template<Position::GamePhase Phase>
638 inline Value Position::pst(Color c, PieceType pt, Square s) const {
639 return (Phase == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
640 : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
643 inline Value Position::mg_pst_delta(Move m) const {
644 return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
645 -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
648 inline Value Position::mg_value() const {
652 inline Value Position::eg_value() const {
656 inline Value Position::non_pawn_material(Color c) const {
657 return npMaterial[c];
660 inline Phase Position::game_phase() const {
662 // Values modified by Joona Kiiski
663 static const Value MidgameLimit = Value(15713);
664 static const Value EndgameLimit = Value(4428);
666 Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
668 if (npm >= MidgameLimit)
669 return PHASE_MIDGAME;
670 else if(npm <= EndgameLimit)
671 return PHASE_ENDGAME;
673 return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
676 inline bool Position::move_is_deep_pawn_push(Move m) const {
678 Color c = side_to_move();
679 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
680 && relative_rank(c, move_to(m)) > RANK_4;
683 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
685 Color c = side_to_move();
686 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
687 && relative_rank(c, move_to(m)) == RANK_7;
690 inline bool Position::move_is_passed_pawn_push(Move m) const {
692 Color c = side_to_move();
693 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
694 && pawn_is_passed(c, move_to(m));
697 inline bool Position::move_was_passed_pawn_push(Move m) const {
699 Color c = opposite_color(side_to_move());
700 return piece_on(move_to(m)) == piece_of_color_and_type(c, PAWN)
701 && pawn_is_passed(c, move_to(m));
704 inline int Position::rule_50_counter() const {
709 inline bool Position::opposite_colored_bishops() const {
711 return piece_count(WHITE, BISHOP) == 1
712 && piece_count(BLACK, BISHOP) == 1
713 && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
716 inline bool Position::has_pawn_on_7th(Color c) const {
718 return pawns(c) & relative_rank_bb(c, RANK_7);
722 #endif // !defined(POSITION_H_INCLUDED)