d2ad99557427dedae4dcd3cbebcd23d1e070b8db
[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 pieces() 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   bool castle_impeded(CastleRight f) const;
131   Square castle_rook_square(CastleRight f) const;
132
133   // Bitboards for pinned pieces and discovered check candidates
134   Bitboard discovered_check_candidates() const;
135   Bitboard pinned_pieces() const;
136
137   // Checking pieces and under check information
138   Bitboard checkers() const;
139   bool in_check() const;
140
141   // Piece lists
142   const Square* piece_list(Color c, PieceType pt) const;
143
144   // Information about attacks to or from a given square
145   Bitboard attackers_to(Square s) const;
146   Bitboard attackers_to(Square s, Bitboard occ) const;
147   Bitboard attacks_from(Piece p, Square s) const;
148   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
149   template<PieceType> Bitboard attacks_from(Square s) const;
150   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
151
152   // Properties of moves
153   bool move_gives_check(Move m, const CheckInfo& ci) const;
154   bool move_attacks_square(Move m, Square s) const;
155   bool pl_move_is_legal(Move m, Bitboard pinned) const;
156   bool is_pseudo_legal(const Move m) const;
157   bool is_capture(Move m) const;
158   bool is_capture_or_promotion(Move m) const;
159   bool is_passed_pawn_push(Move m) const;
160
161   // Piece captured with previous moves
162   PieceType captured_piece_type() const;
163
164   // Information about pawns
165   bool pawn_is_passed(Color c, Square s) const;
166
167   // Doing and undoing moves
168   void do_move(Move m, StateInfo& st);
169   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
170   void undo_move(Move m);
171   template<bool Do> void do_null_move(StateInfo& st);
172
173   // Static exchange evaluation
174   int see(Move m) const;
175   int see_sign(Move m) const;
176
177   // Accessing hash keys
178   Key key() const;
179   Key exclusion_key() const;
180   Key pawn_key() const;
181   Key material_key() const;
182
183   // Incremental evaluation
184   Score value() const;
185   Value non_pawn_material(Color c) const;
186   Score pst_delta(Piece piece, Square from, Square to) const;
187
188   // Other properties of the position
189   template<bool SkipRepetition> bool is_draw() const;
190   int startpos_ply_counter() const;
191   bool opposite_colored_bishops() const;
192   bool both_color_bishops(Color c) const;
193   bool has_pawn_on_7th(Color c) const;
194   bool is_chess960() const;
195   int thread() const;
196   int64_t nodes_searched() const;
197   void set_nodes_searched(int64_t n);
198
199   // Position consistency check, for debugging
200   bool pos_is_ok(int* failedStep = NULL) const;
201   void flip_me();
202
203   // Global initialization
204   static void init();
205
206 private:
207
208   // Initialization helper functions (used while setting up a position)
209   void clear();
210   void put_piece(Piece p, Square s);
211   void set_castle_right(Color c, Square rfrom);
212   bool move_is_legal(const Move m) const;
213
214   // Helper template functions
215   template<bool Do> void do_castle_move(Move m);
216   template<bool FindPinned> Bitboard hidden_checkers() const;
217
218   // Computing hash keys from scratch (for initialization and debugging)
219   Key compute_key() const;
220   Key compute_pawn_key() const;
221   Key compute_material_key() const;
222
223   // Computing incremental evaluation scores and material counts
224   Score pst(Piece p, Square s) const;
225   Score compute_value() const;
226   Value compute_non_pawn_material(Color c) const;
227
228   // Board
229   Piece board[64];             // [square]
230
231   // Bitboards
232   Bitboard byTypeBB[8];        // [pieceType]
233   Bitboard byColorBB[2];       // [color]
234   Bitboard occupied;
235
236   // Piece counts
237   int pieceCount[2][8];        // [color][pieceType]
238
239   // Piece lists
240   Square pieceList[2][8][16];  // [color][pieceType][index]
241   int index[64];               // [square]
242
243   // Other info
244   int castleRightsMask[64];    // [square]
245   Square castleRookSquare[16]; // [castleRight]
246   Bitboard castlePath[16];     // [castleRight]
247   StateInfo startState;
248   int64_t nodes;
249   int startPosPly;
250   Color sideToMove;
251   int threadID;
252   StateInfo* st;
253   int chess960;
254
255   // Static variables
256   static Score pieceSquareTable[16][64]; // [piece][square]
257   static Key zobrist[2][8][64];          // [color][pieceType][square]/[piece count]
258   static Key zobEp[8];                   // [file]
259   static Key zobCastle[16];              // [castleRight]
260   static Key zobSideToMove;
261   static Key zobExclusion;
262 };
263
264 inline int64_t Position::nodes_searched() const {
265   return nodes;
266 }
267
268 inline void Position::set_nodes_searched(int64_t n) {
269   nodes = n;
270 }
271
272 inline Piece Position::piece_on(Square s) const {
273   return board[s];
274 }
275
276 inline Piece Position::piece_moved(Move m) const {
277   return board[from_sq(m)];
278 }
279
280 inline bool Position::square_is_empty(Square s) const {
281   return board[s] == NO_PIECE;
282 }
283
284 inline Color Position::side_to_move() const {
285   return sideToMove;
286 }
287
288 inline Bitboard Position::pieces() const {
289   return occupied;
290 }
291
292 inline Bitboard Position::pieces(Color c) const {
293   return byColorBB[c];
294 }
295
296 inline Bitboard Position::pieces(PieceType pt) const {
297   return byTypeBB[pt];
298 }
299
300 inline Bitboard Position::pieces(PieceType pt, Color c) const {
301   return byTypeBB[pt] & byColorBB[c];
302 }
303
304 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
305   return byTypeBB[pt1] | byTypeBB[pt2];
306 }
307
308 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
309   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
310 }
311
312 inline int Position::piece_count(Color c, PieceType pt) const {
313   return pieceCount[c][pt];
314 }
315
316 inline const Square* Position::piece_list(Color c, PieceType pt) const {
317   return pieceList[c][pt];
318 }
319
320 inline Square Position::ep_square() const {
321   return st->epSquare;
322 }
323
324 inline Square Position::king_square(Color c) const {
325   return pieceList[c][KING][0];
326 }
327
328 inline bool Position::can_castle(CastleRight f) const {
329   return st->castleRights & f;
330 }
331
332 inline bool Position::can_castle(Color c) const {
333   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
334 }
335
336 inline bool Position::castle_impeded(CastleRight f) const {
337   return occupied & castlePath[f];
338 }
339
340 inline Square Position::castle_rook_square(CastleRight f) const {
341   return castleRookSquare[f];
342 }
343
344 template<PieceType Pt>
345 inline Bitboard Position::attacks_from(Square s) const {
346   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, pieces())
347         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
348         : StepAttacksBB[Pt][s];
349 }
350
351 template<>
352 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
353   return StepAttacksBB[make_piece(c, PAWN)][s];
354 }
355
356 inline Bitboard Position::attacks_from(Piece p, Square s) const {
357   return attacks_from(p, s, occupied);
358 }
359
360 inline Bitboard Position::attackers_to(Square s) const {
361   return attackers_to(s, occupied);
362 }
363
364 inline Bitboard Position::checkers() const {
365   return st->checkersBB;
366 }
367
368 inline bool Position::in_check() const {
369   return st->checkersBB != 0;
370 }
371
372 inline Bitboard Position::discovered_check_candidates() const {
373   return hidden_checkers<false>();
374 }
375
376 inline Bitboard Position::pinned_pieces() const {
377   return hidden_checkers<true>();
378 }
379
380 inline bool Position::pawn_is_passed(Color c, Square s) const {
381   return !(pieces(PAWN, ~c) & passed_pawn_mask(c, s));
382 }
383
384 inline Key Position::key() const {
385   return st->key;
386 }
387
388 inline Key Position::exclusion_key() const {
389   return st->key ^ zobExclusion;
390 }
391
392 inline Key Position::pawn_key() const {
393   return st->pawnKey;
394 }
395
396 inline Key Position::material_key() const {
397   return st->materialKey;
398 }
399
400 inline Score Position::pst(Piece p, Square s) const {
401   return pieceSquareTable[p][s];
402 }
403
404 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
405   return pieceSquareTable[piece][to] - pieceSquareTable[piece][from];
406 }
407
408 inline Score Position::value() const {
409   return st->value;
410 }
411
412 inline Value Position::non_pawn_material(Color c) const {
413   return st->npMaterial[c];
414 }
415
416 inline bool Position::is_passed_pawn_push(Move m) const {
417
418   return   board[from_sq(m)] == make_piece(sideToMove, PAWN)
419         && pawn_is_passed(sideToMove, to_sq(m));
420 }
421
422 inline int Position::startpos_ply_counter() const {
423   return startPosPly + st->pliesFromNull; // HACK
424 }
425
426 inline bool Position::opposite_colored_bishops() const {
427
428   return   pieceCount[WHITE][BISHOP] == 1
429         && pieceCount[BLACK][BISHOP] == 1
430         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
431 }
432
433 inline bool Position::both_color_bishops(Color c) const {
434   // Assumes that there are only two bishops
435   return  pieceCount[c][BISHOP] >= 2 &&
436           opposite_colors(pieceList[c][BISHOP][0], pieceList[c][BISHOP][1]);
437 }
438
439 inline bool Position::has_pawn_on_7th(Color c) const {
440   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
441 }
442
443 inline bool Position::is_chess960() const {
444   return chess960;
445 }
446
447 inline bool Position::is_capture_or_promotion(Move m) const {
448
449   assert(is_ok(m));
450   return is_special(m) ? !is_castle(m) : !square_is_empty(to_sq(m));
451 }
452
453 inline bool Position::is_capture(Move m) const {
454
455   // Note that castle is coded as "king captures the rook"
456   assert(is_ok(m));
457   return (!square_is_empty(to_sq(m)) && !is_castle(m)) || is_enpassant(m);
458 }
459
460 inline PieceType Position::captured_piece_type() const {
461   return st->capturedType;
462 }
463
464 inline int Position::thread() const {
465   return threadID;
466 }
467
468 #endif // !defined(POSITION_H_INCLUDED)