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;
92 Square kingSquare[2], epSquare;
93 Value mgValue, egValue;
102 /// The position data structure. A position consists of the following data:
104 /// * For each piece type, a bitboard representing the squares occupied
105 /// by pieces of that type.
106 /// * For each color, a bitboard representing the squares occupied by
107 /// pieces of that color.
108 /// * A bitboard of all occupied squares.
109 /// * A bitboard of all checking pieces.
110 /// * A 64-entry array of pieces, indexed by the squares of the board.
111 /// * The current side to move.
112 /// * Information about the castling rights for both sides.
113 /// * The initial files of the kings and both pairs of rooks. This is
114 /// used to implement the Chess960 castling rules.
115 /// * The en passant square (which is SQ_NONE if no en passant capture is
117 /// * The squares of the kings for both sides.
118 /// * Hash keys for the position itself, the current pawn structure, and
119 /// the current material situation.
120 /// * Hash keys for all previous positions in the game for detecting
121 /// repetition draws.
122 /// * A counter for detecting 50 move rule draws.
126 friend class MaterialInfo;
127 friend class EndgameFunctions;
137 Position(const Position& pos);
138 Position(const std::string& fen);
141 void from_fen(const std::string& fen);
142 const std::string to_fen() const;
143 void print(Move m = MOVE_NONE) const;
146 void copy(const Position& pos);
147 void flipped_copy(const Position& pos);
149 // The piece on a given square
150 Piece piece_on(Square s) const;
151 PieceType type_of_piece_on(Square s) const;
152 Color color_of_piece_on(Square s) const;
153 bool square_is_empty(Square s) const;
154 bool square_is_occupied(Square s) const;
155 Value midgame_value_of_piece_on(Square s) const;
156 Value endgame_value_of_piece_on(Square s) const;
159 Color side_to_move() const;
161 // Bitboard representation of the position
162 Bitboard empty_squares() const;
163 Bitboard occupied_squares() const;
164 Bitboard pieces_of_color(Color c) const;
165 Bitboard pieces(PieceType pt) const;
166 Bitboard pieces(PieceType pt, Color c) const;
167 Bitboard pieces(PieceType pt1, PieceType pt2) const;
168 Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
170 // Number of pieces of each color and type
171 int piece_count(Color c, PieceType pt) const;
173 // The en passant square
174 Square ep_square() const;
176 // Current king position for each color
177 Square king_square(Color c) const;
180 bool can_castle_kingside(Color c) const;
181 bool can_castle_queenside(Color c) const;
182 bool can_castle(Color c) const;
183 Square initial_kr_square(Color c) const;
184 Square initial_qr_square(Color c) const;
187 Bitboard sliding_attacks(Square s, Direction d) const;
188 Bitboard ray_attacks(Square s, SignedDirection d) const;
189 Bitboard pawn_attacks(Color c, Square s) const;
192 Bitboard piece_attacks(Square s) const;
194 // Bitboards for pinned pieces and discovered check candidates
195 Bitboard discovered_check_candidates(Color c) const;
196 Bitboard pinned_pieces(Color c, Bitboard& p) const;
197 Bitboard pinned_pieces(Color c) const;
200 Bitboard checkers() const;
203 Square piece_list(Color c, PieceType pt, int index) const;
205 // Attack information for a given square
206 bool square_is_attacked(Square s, Color c) const;
207 Bitboard attacks_to(Square s) const;
208 Bitboard attacks_to(Square s, Color c) const;
209 bool is_check() const;
210 bool pawn_attacks_square(Color c, Square f, Square t) const;
213 Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
215 bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
217 // Properties of moves
218 bool pl_move_is_legal(Move m) const;
219 bool pl_move_is_legal(Move m, Bitboard pinned) const;
220 bool move_is_check(Move m) const;
221 bool move_is_check(Move m, Bitboard dcCandidates) const;
222 bool move_is_capture(Move m) const;
223 bool move_is_passed_pawn_push(Move m) const;
224 bool move_attacks_square(Move m, Square s) const;
226 // Information about pawns
227 bool pawn_is_passed(Color c, Square s) const;
228 static bool pawn_is_passed(Bitboard theirPawns, Color c, Square s);
229 static bool pawn_is_isolated(Bitboard ourPawns, Square s);
230 static bool pawn_is_doubled(Bitboard ourPawns, Color c, Square s);
233 bool square_is_weak(Square s, Color c) const;
235 // Doing and undoing moves
237 void do_move(Move m, StateInfo& st);
238 void do_move(Move m, StateInfo& st, Bitboard dcCandidates);
239 void undo_move(Move m);
240 void do_null_move(StateInfo& st);
241 void undo_null_move();
243 // Static exchange evaluation
244 int see(Square from, Square to) const;
245 int see(Move m) const;
246 int see(Square to) const;
247 int see_sign(Move m) const;
249 // Accessing hash keys
251 Key get_pawn_key() const;
252 Key get_material_key() const;
254 // Incremental evaluation
255 Value mg_value() const;
256 Value eg_value() const;
257 Value non_pawn_material(Color c) const;
258 Phase game_phase() const;
259 template<GamePhase> Value pst_delta(Piece piece, Square from, Square to) const;
261 // Game termination checks
262 bool is_mate() const;
263 bool is_draw() const;
265 // Check if one side threatens a mate in one
266 bool has_mate_threat(Color c);
268 // Number of plies since the last non-reversible move
269 int rule_50_counter() const;
271 // Other properties of the position
272 bool opposite_colored_bishops() const;
273 bool has_pawn_on_7th(Color c) const;
275 // Reset the gamePly variable to 0
276 void reset_game_ply();
278 // Position consistency check, for debugging
279 bool is_ok(int* failedStep = NULL) const;
281 // Static member functions:
282 static void init_zobrist();
283 static void init_piece_square_tables();
287 // Initialization helper functions (used while setting up a position)
289 void put_piece(Piece p, Square s);
290 void allow_oo(Color c);
291 void allow_ooo(Color c);
293 // Helper functions for doing and undoing moves
294 void do_capture_move(Bitboard& key, PieceType capture, Color them, Square to, bool ep);
295 void do_castle_move(Move m);
296 void undo_castle_move(Move m);
297 void find_checkers();
299 template<PieceType Piece>
300 void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
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 template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
312 template<GamePhase> Value compute_value() const;
313 Value compute_non_pawn_material(Color c) const;
316 Bitboard byColorBB[2], byTypeBB[8];
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 Value MgPieceSquareTable[16][64];
344 static Value EgPieceSquareTable[16][64];
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 Square Position::ep_square() const {
424 inline Square Position::king_square(Color c) const {
425 return st->kingSquare[c];
428 inline bool Position::can_castle_kingside(Color side) const {
429 return st->castleRights & (1+int(side));
432 inline bool Position::can_castle_queenside(Color side) const {
433 return st->castleRights & (4+4*int(side));
436 inline bool Position::can_castle(Color side) const {
437 return can_castle_kingside(side) || can_castle_queenside(side);
440 inline Square Position::initial_kr_square(Color c) const {
441 return relative_square(c, make_square(initialKRFile, RANK_1));
444 inline Square Position::initial_qr_square(Color c) const {
445 return relative_square(c, make_square(initialQRFile, RANK_1));
448 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
449 return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
452 template<PieceType Piece> // Knight and King
453 inline Bitboard Position::piece_attacks(Square s) const {
454 return StepAttackBB[Piece][s];
458 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
459 return StepAttackBB[WP][s] | StepAttackBB[BP][s];
463 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
464 return bishop_attacks_bb(s, occupied_squares());
468 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
469 return rook_attacks_bb(s, occupied_squares());
473 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
474 return piece_attacks<ROOK>(s) | piece_attacks<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_attacks_square(Color c, Square f, Square t) const {
486 return bit_is_set(pawn_attacks(c, f), t);
489 template<PieceType Piece>
490 inline Bitboard Position::piece_attacks_square(Square f, Square t) const {
491 return bit_is_set(piece_attacks<Piece>(f), t);
494 inline Bitboard Position::attacks_to(Square s, Color c) const {
496 return attacks_to(s) & pieces_of_color(c);
499 inline bool Position::square_is_attacked(Square s, Color c) const {
501 return attacks_to(s, c) != EmptyBoardBB;
504 inline bool Position::pawn_is_passed(Color c, Square s) const {
505 return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
508 inline bool Position::pawn_is_passed(Bitboard theirPawns, Color c, Square s) {
509 return !(theirPawns & passed_pawn_mask(c, s));
512 inline bool Position::pawn_is_isolated(Bitboard ourPawns, Square s) {
513 return !(ourPawns & neighboring_files_bb(s));
516 inline bool Position::pawn_is_doubled(Bitboard ourPawns, Color c, Square s) {
517 return ourPawns & squares_behind(c, s);
520 inline bool Position::square_is_weak(Square s, Color c) const {
521 return !(pieces(PAWN, c) & outpost_mask(opposite_color(c), s));
524 inline Key Position::get_key() const {
528 inline Key Position::get_pawn_key() const {
532 inline Key Position::get_material_key() const {
533 return st->materialKey;
536 template<Position::GamePhase Ph>
537 inline Value Position::pst(Color c, PieceType pt, Square s) const {
538 return (Ph == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
539 : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
542 template<Position::GamePhase Ph>
543 inline Value Position::pst_delta(Piece piece, Square from, Square to) const {
544 return (Ph == MidGame ? MgPieceSquareTable[piece][to] - MgPieceSquareTable[piece][from]
545 : EgPieceSquareTable[piece][to] - EgPieceSquareTable[piece][from]);
548 inline Value Position::mg_value() const {
552 inline Value Position::eg_value() const {
556 inline Value Position::non_pawn_material(Color c) const {
557 return st->npMaterial[c];
560 inline Phase Position::game_phase() const {
562 // Values modified by Joona Kiiski
563 static const Value MidgameLimit = Value(15581);
564 static const Value EndgameLimit = Value(3998);
566 Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
568 if (npm >= MidgameLimit)
569 return PHASE_MIDGAME;
570 else if(npm <= EndgameLimit)
571 return PHASE_ENDGAME;
573 return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
576 inline bool Position::move_is_passed_pawn_push(Move m) const {
578 Color c = side_to_move();
579 return piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
580 && pawn_is_passed(c, move_to(m));
583 inline int Position::rule_50_counter() const {
588 inline bool Position::opposite_colored_bishops() const {
590 return piece_count(WHITE, BISHOP) == 1
591 && piece_count(BLACK, BISHOP) == 1
592 && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
595 inline bool Position::has_pawn_on_7th(Color c) const {
597 return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
600 inline bool Position::move_is_capture(Move m) const {
602 // Move must not be MOVE_NONE !
604 return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
607 #endif // !defined(POSITION_H_INCLUDED)