48e8fbe419baf62ff913f06e2f4a8c44e55bfc7c
[stockfish] / src / position.h
1 /*
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-2012 Marco Costalba, Joona Kiiski, Tord Romstad
5
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.
10
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.
15
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/>.
18 */
19
20 #if !defined(POSITION_H_INCLUDED)
21 #define POSITION_H_INCLUDED
22
23 #include <cassert>
24
25 #include "bitboard.h"
26 #include "types.h"
27
28
29 /// The checkInfo struct is initialized at c'tor time and keeps info used
30 /// to detect if a move gives check.
31 class Position;
32
33 struct CheckInfo {
34
35   explicit CheckInfo(const Position&);
36
37   Bitboard dcCandidates;
38   Bitboard pinned;
39   Bitboard checkSq[8];
40   Square ksq;
41 };
42
43
44 /// The StateInfo struct stores information we need to restore a Position
45 /// object to its previous state when we retract a move. Whenever a move
46 /// is made on the board (by calling Position::do_move), an StateInfo object
47 /// must be passed as a parameter.
48
49 struct StateInfo {
50   Key pawnKey, materialKey;
51   Value npMaterial[2];
52   int castleRights, rule50, pliesFromNull;
53   Score value;
54   Square epSquare;
55
56   Key key;
57   Bitboard checkersBB;
58   PieceType capturedType;
59   StateInfo* previous;
60 };
61
62
63 /// The position data structure. A position consists of the following data:
64 ///
65 ///    * For each piece type, a bitboard representing the squares occupied
66 ///      by pieces of that type.
67 ///    * For each color, a bitboard representing the squares occupied by
68 ///      pieces of that color.
69 ///    * A bitboard of all occupied squares.
70 ///    * A bitboard of all checking pieces.
71 ///    * A 64-entry array of pieces, indexed by the squares of the board.
72 ///    * The current side to move.
73 ///    * Information about the castling rights for both sides.
74 ///    * The initial files of the kings and both pairs of rooks. This is
75 ///      used to implement the Chess960 castling rules.
76 ///    * The en passant square (which is SQ_NONE if no en passant capture is
77 ///      possible).
78 ///    * The squares of the kings for both sides.
79 ///    * Hash keys for the position itself, the current pawn structure, and
80 ///      the current material situation.
81 ///    * Hash keys for all previous positions in the game for detecting
82 ///      repetition draws.
83 ///    * A counter for detecting 50 move rule draws.
84
85 class Position {
86
87   // No copy c'tor or assignment operator allowed
88   Position(const Position&);
89   Position& operator=(const Position&);
90
91 public:
92   Position() {}
93   Position(const Position& pos, int th) { copy(pos, th); }
94   Position(const std::string& fen, bool isChess960, int th);
95
96   // Text input/output
97   void copy(const Position& pos, int th);
98   void from_fen(const std::string& fen, bool isChess960);
99   const std::string to_fen() const;
100   void print(Move m = MOVE_NONE) const;
101
102   // The piece on a given square
103   Piece piece_on(Square s) const;
104   Piece piece_moved(Move m) const;
105   bool square_is_empty(Square s) const;
106
107   // Side to move
108   Color side_to_move() const;
109
110   // Bitboard representation of the position
111   Bitboard occupied_squares() const;
112   Bitboard pieces(Color c) const;
113   Bitboard pieces(PieceType pt) const;
114   Bitboard pieces(PieceType pt, Color c) const;
115   Bitboard pieces(PieceType pt1, PieceType pt2) const;
116   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
117
118   // Number of pieces of each color and type
119   int piece_count(Color c, PieceType pt) const;
120
121   // The en passant square
122   Square ep_square() const;
123
124   // Current king position for each color
125   Square king_square(Color c) const;
126
127   // Castling rights
128   bool can_castle(CastleRight f) const;
129   bool can_castle(Color c) const;
130   Square castle_rook_square(CastleRight f) const;
131
132   // Bitboards for pinned pieces and discovered check candidates
133   Bitboard discovered_check_candidates() const;
134   Bitboard pinned_pieces() const;
135
136   // Checking pieces and under check information
137   Bitboard checkers() const;
138   bool in_check() const;
139
140   // Piece lists
141   const Square* piece_list(Color c, PieceType pt) const;
142
143   // Information about attacks to or from a given square
144   Bitboard attackers_to(Square s) const;
145   Bitboard attackers_to(Square s, Bitboard occ) const;
146   Bitboard attacks_from(Piece p, Square s) const;
147   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
148   template<PieceType> Bitboard attacks_from(Square s) const;
149   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
150
151   // Properties of moves
152   bool move_gives_check(Move m, const CheckInfo& ci) const;
153   bool move_attacks_square(Move m, Square s) const;
154   bool pl_move_is_legal(Move m, Bitboard pinned) const;
155   bool is_pseudo_legal(const Move m) const;
156   bool is_capture(Move m) const;
157   bool is_capture_or_promotion(Move m) const;
158   bool is_passed_pawn_push(Move m) const;
159
160   // Piece captured with previous moves
161   PieceType captured_piece_type() const;
162
163   // Information about pawns
164   bool pawn_is_passed(Color c, Square s) const;
165
166   // Doing and undoing moves
167   void do_move(Move m, StateInfo& st);
168   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
169   void undo_move(Move m);
170   template<bool Do> void do_null_move(StateInfo& st);
171
172   // Static exchange evaluation
173   int see(Move m) const;
174   int see_sign(Move m) const;
175
176   // Accessing hash keys
177   Key key() const;
178   Key exclusion_key() const;
179   Key pawn_key() const;
180   Key material_key() const;
181
182   // Incremental evaluation
183   Score value() const;
184   Value non_pawn_material(Color c) const;
185   Score pst_delta(Piece piece, Square from, Square to) const;
186
187   // Other properties of the position
188   template<bool SkipRepetition> bool is_draw() const;
189   int startpos_ply_counter() const;
190   bool opposite_colored_bishops() const;
191   bool both_color_bishops(Color c) const;
192   bool has_pawn_on_7th(Color c) const;
193   bool is_chess960() const;
194
195   // Current thread ID searching on the position
196   int thread() const;
197
198   int64_t nodes_searched() const;
199   void set_nodes_searched(int64_t n);
200
201   // Position consistency check, for debugging
202   bool pos_is_ok(int* failedStep = NULL) const;
203   void flip_me();
204
205   // Global initialization
206   static void init();
207
208 private:
209
210   // Initialization helper functions (used while setting up a position)
211   void clear();
212   void put_piece(Piece p, Square s);
213   void set_castle_right(Color c, Square rsq);
214   bool move_is_legal(const Move m) const;
215
216   // Helper template functions
217   template<bool Do> void do_castle_move(Move m);
218   template<bool FindPinned> Bitboard hidden_checkers() const;
219
220   // Computing hash keys from scratch (for initialization and debugging)
221   Key compute_key() const;
222   Key compute_pawn_key() const;
223   Key compute_material_key() const;
224
225   // Computing incremental evaluation scores and material counts
226   Score pst(Piece p, Square s) const;
227   Score compute_value() const;
228   Value compute_non_pawn_material(Color c) const;
229
230   // Board
231   Piece board[64];             // [square]
232
233   // Bitboards
234   Bitboard byTypeBB[8];        // [pieceType]
235   Bitboard byColorBB[2];       // [color]
236   Bitboard occupied;
237
238   // Piece counts
239   int pieceCount[2][8];        // [color][pieceType]
240
241   // Piece lists
242   Square pieceList[2][8][16];  // [color][pieceType][index]
243   int index[64];               // [square]
244
245   // Other info
246   int castleRightsMask[64];    // [square]
247   Square castleRookSquare[16]; // [castleRight]
248   StateInfo startState;
249   int64_t nodes;
250   int startPosPly;
251   Color sideToMove;
252   int threadID;
253   StateInfo* st;
254   int chess960;
255
256   // Static variables
257   static Score pieceSquareTable[16][64]; // [piece][square]
258   static Key zobrist[2][8][64];          // [color][pieceType][square]/[piece count]
259   static Key zobEp[8];                   // [file]
260   static Key zobCastle[16];              // [castleRight]
261   static Key zobSideToMove;
262   static Key zobExclusion;
263 };
264
265 inline int64_t Position::nodes_searched() const {
266   return nodes;
267 }
268
269 inline void Position::set_nodes_searched(int64_t n) {
270   nodes = n;
271 }
272
273 inline Piece Position::piece_on(Square s) const {
274   return board[s];
275 }
276
277 inline Piece Position::piece_moved(Move m) const {
278   return board[from_sq(m)];
279 }
280
281 inline bool Position::square_is_empty(Square s) const {
282   return board[s] == NO_PIECE;
283 }
284
285 inline Color Position::side_to_move() const {
286   return sideToMove;
287 }
288
289 inline Bitboard Position::occupied_squares() const {
290   return occupied;
291 }
292
293 inline Bitboard Position::pieces(Color c) const {
294   return byColorBB[c];
295 }
296
297 inline Bitboard Position::pieces(PieceType pt) const {
298   return byTypeBB[pt];
299 }
300
301 inline Bitboard Position::pieces(PieceType pt, Color c) const {
302   return byTypeBB[pt] & byColorBB[c];
303 }
304
305 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
306   return byTypeBB[pt1] | byTypeBB[pt2];
307 }
308
309 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
310   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
311 }
312
313 inline int Position::piece_count(Color c, PieceType pt) const {
314   return pieceCount[c][pt];
315 }
316
317 inline const Square* Position::piece_list(Color c, PieceType pt) const {
318   return pieceList[c][pt];
319 }
320
321 inline Square Position::ep_square() const {
322   return st->epSquare;
323 }
324
325 inline Square Position::king_square(Color c) const {
326   return pieceList[c][KING][0];
327 }
328
329 inline bool Position::can_castle(CastleRight f) const {
330   return st->castleRights & f;
331 }
332
333 inline bool Position::can_castle(Color c) const {
334   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
335 }
336
337 inline Square Position::castle_rook_square(CastleRight f) const {
338   return castleRookSquare[f];
339 }
340
341 template<PieceType Pt>
342 inline Bitboard Position::attacks_from(Square s) const {
343   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, occupied_squares())
344         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
345         : StepAttacksBB[Pt][s];
346 }
347
348 template<>
349 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
350   return StepAttacksBB[make_piece(c, PAWN)][s];
351 }
352
353 inline Bitboard Position::attacks_from(Piece p, Square s) const {
354   return attacks_from(p, s, occupied);
355 }
356
357 inline Bitboard Position::attackers_to(Square s) const {
358   return attackers_to(s, occupied);
359 }
360
361 inline Bitboard Position::checkers() const {
362   return st->checkersBB;
363 }
364
365 inline bool Position::in_check() const {
366   return st->checkersBB != 0;
367 }
368
369 inline Bitboard Position::discovered_check_candidates() const {
370   return hidden_checkers<false>();
371 }
372
373 inline Bitboard Position::pinned_pieces() const {
374   return hidden_checkers<true>();
375 }
376
377 inline bool Position::pawn_is_passed(Color c, Square s) const {
378   return !(pieces(PAWN, ~c) & passed_pawn_mask(c, s));
379 }
380
381 inline Key Position::key() const {
382   return st->key;
383 }
384
385 inline Key Position::exclusion_key() const {
386   return st->key ^ zobExclusion;
387 }
388
389 inline Key Position::pawn_key() const {
390   return st->pawnKey;
391 }
392
393 inline Key Position::material_key() const {
394   return st->materialKey;
395 }
396
397 inline Score Position::pst(Piece p, Square s) const {
398   return pieceSquareTable[p][s];
399 }
400
401 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
402   return pieceSquareTable[piece][to] - pieceSquareTable[piece][from];
403 }
404
405 inline Score Position::value() const {
406   return st->value;
407 }
408
409 inline Value Position::non_pawn_material(Color c) const {
410   return st->npMaterial[c];
411 }
412
413 inline bool Position::is_passed_pawn_push(Move m) const {
414
415   return   board[from_sq(m)] == make_piece(sideToMove, PAWN)
416         && pawn_is_passed(sideToMove, to_sq(m));
417 }
418
419 inline int Position::startpos_ply_counter() const {
420   return startPosPly + st->pliesFromNull; // HACK
421 }
422
423 inline bool Position::opposite_colored_bishops() const {
424
425   return   pieceCount[WHITE][BISHOP] == 1
426         && pieceCount[BLACK][BISHOP] == 1
427         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
428 }
429
430 inline bool Position::both_color_bishops(Color c) const {
431   // Assumes that there are only two bishops
432   return  pieceCount[c][BISHOP] >= 2 &&
433           opposite_colors(pieceList[c][BISHOP][0], pieceList[c][BISHOP][1]);
434 }
435
436 inline bool Position::has_pawn_on_7th(Color c) const {
437   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
438 }
439
440 inline bool Position::is_chess960() const {
441   return chess960;
442 }
443
444 inline bool Position::is_capture_or_promotion(Move m) const {
445
446   assert(is_ok(m));
447   return is_special(m) ? !is_castle(m) : !square_is_empty(to_sq(m));
448 }
449
450 inline bool Position::is_capture(Move m) const {
451
452   // Note that castle is coded as "king captures the rook"
453   assert(is_ok(m));
454   return (!square_is_empty(to_sq(m)) && !is_castle(m)) || is_enpassant(m);
455 }
456
457 inline PieceType Position::captured_piece_type() const {
458   return st->capturedType;
459 }
460
461 inline int Position::thread() const {
462   return threadID;
463 }
464
465 #endif // !defined(POSITION_H_INCLUDED)