Use CheckInfo to store pinned bitboard
[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-2010 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 "move.h"
27 #include "types.h"
28
29 /// Maximum number of plies per game (220 should be enough, because the
30 /// maximum search depth is 100, and during position setup we reset the
31 /// move counter for every non-reversible move).
32 const int MaxGameLength = 220;
33
34 class Position;
35
36 /// struct checkInfo is initialized at c'tor time and keeps
37 /// info used to detect if a move gives check.
38
39 struct CheckInfo {
40
41     explicit CheckInfo(const Position&);
42
43     Bitboard dcCandidates;
44     Bitboard pinned;
45     Bitboard checkSq[8];
46     Square ksq;
47 };
48
49 /// Castle rights, encoded as bit fields
50
51 enum CastleRights {
52   CASTLES_NONE = 0,
53   WHITE_OO     = 1,
54   BLACK_OO     = 2,
55   WHITE_OOO    = 4,
56   BLACK_OOO    = 8,
57   ALL_CASTLES  = 15
58 };
59
60 /// Game phase
61 enum Phase {
62   PHASE_ENDGAME = 0,
63   PHASE_MIDGAME = 128
64 };
65
66
67 /// The StateInfo struct stores information we need to restore a Position
68 /// object to its previous state when we retract a move. Whenever a move
69 /// is made on the board (by calling Position::do_move), an StateInfo object
70 /// must be passed as a parameter.
71
72 struct StateInfo {
73   Key pawnKey, materialKey;
74   int castleRights, rule50, gamePly, pliesFromNull;
75   Square epSquare;
76   Score value;
77   Value npMaterial[2];
78
79   PieceType capturedType;
80   Key key;
81   Bitboard checkersBB;
82   StateInfo* previous;
83 };
84
85
86 /// The position data structure. A position consists of the following data:
87 ///
88 ///    * For each piece type, a bitboard representing the squares occupied
89 ///      by pieces of that type.
90 ///    * For each color, a bitboard representing the squares occupied by
91 ///      pieces of that color.
92 ///    * A bitboard of all occupied squares.
93 ///    * A bitboard of all checking pieces.
94 ///    * A 64-entry array of pieces, indexed by the squares of the board.
95 ///    * The current side to move.
96 ///    * Information about the castling rights for both sides.
97 ///    * The initial files of the kings and both pairs of rooks. This is
98 ///      used to implement the Chess960 castling rules.
99 ///    * The en passant square (which is SQ_NONE if no en passant capture is
100 ///      possible).
101 ///    * The squares of the kings for both sides.
102 ///    * Hash keys for the position itself, the current pawn structure, and
103 ///      the current material situation.
104 ///    * Hash keys for all previous positions in the game for detecting
105 ///      repetition draws.
106 ///    * A counter for detecting 50 move rule draws.
107
108 class Position {
109
110   Position(); // No default or copy c'tor allowed
111   Position(const Position& pos);
112
113 public:
114   enum GamePhase {
115       MidGame,
116       EndGame
117   };
118
119   // Constructors
120   Position(const Position& pos, int threadID);
121   Position(const std::string& fen, bool isChess960, int threadID);
122
123   // Text input/output
124   void from_fen(const std::string& fen, bool isChess960);
125   const std::string to_fen() const;
126   void print(Move m = MOVE_NONE) const;
127
128   // Copying
129   void flip();
130
131   // The piece on a given square
132   Piece piece_on(Square s) const;
133   PieceType type_of_piece_on(Square s) const;
134   Color color_of_piece_on(Square s) const;
135   bool square_is_empty(Square s) const;
136   bool square_is_occupied(Square s) const;
137   Value midgame_value_of_piece_on(Square s) const;
138   Value endgame_value_of_piece_on(Square s) const;
139
140   // Side to move
141   Color side_to_move() const;
142
143   // Bitboard representation of the position
144   Bitboard empty_squares() const;
145   Bitboard occupied_squares() const;
146   Bitboard pieces_of_color(Color c) const;
147   Bitboard pieces(PieceType pt) const;
148   Bitboard pieces(PieceType pt, Color c) const;
149   Bitboard pieces(PieceType pt1, PieceType pt2) const;
150   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
151
152   // Number of pieces of each color and type
153   int piece_count(Color c, PieceType pt) const;
154
155   // The en passant square
156   Square ep_square() const;
157
158   // Current king position for each color
159   Square king_square(Color c) const;
160
161   // Castling rights
162   bool can_castle_kingside(Color c) const;
163   bool can_castle_queenside(Color c) const;
164   bool can_castle(Color c) const;
165   Square initial_kr_square(Color c) const;
166   Square initial_qr_square(Color c) const;
167
168   // Bitboards for pinned pieces and discovered check candidates
169   Bitboard discovered_check_candidates(Color c) const;
170   Bitboard pinned_pieces(Color c) const;
171
172   // Checking pieces and under check information
173   Bitboard checkers() const;
174   bool in_check() const;
175
176   // Piece lists
177   Square piece_list(Color c, PieceType pt, int index) const;
178   const Square* piece_list_begin(Color c, PieceType pt) const;
179
180   // Information about attacks to or from a given square
181   Bitboard attackers_to(Square s) const;
182   Bitboard attackers_to(Square s, Bitboard occ) const;
183   Bitboard attacks_from(Piece p, Square s) const;
184   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
185   template<PieceType> Bitboard attacks_from(Square s) const;
186   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
187
188   // Properties of moves
189   bool pl_move_is_legal(Move m, Bitboard pinned) const;
190   bool move_is_pl(const Move m) const;
191   bool move_gives_check(Move m, const CheckInfo& ci) const;
192   bool move_is_capture(Move m) const;
193   bool move_is_passed_pawn_push(Move m) const;
194   bool move_attacks_square(Move m, Square s) const;
195
196   // Piece captured with previous moves
197   PieceType captured_piece_type() const;
198
199   // Information about pawns
200   bool pawn_is_passed(Color c, Square s) const;
201
202   // Weak squares
203   bool square_is_weak(Square s, Color c) const;
204
205   // Doing and undoing moves
206   void do_setup_move(Move m);
207   void do_move(Move m, StateInfo& st);
208   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
209   void undo_move(Move m);
210   void do_null_move(StateInfo& st);
211   void undo_null_move();
212
213   // Static exchange evaluation
214   int see(Move m) const;
215   int see_sign(Move m) const;
216   static int see_value(PieceType pt);
217
218   // Accessing hash keys
219   Key get_key() const;
220   Key get_exclusion_key() const;
221   Key get_pawn_key() const;
222   Key get_material_key() const;
223
224   // Incremental evaluation
225   Score value() const;
226   Value non_pawn_material(Color c) const;
227   static Score pst_delta(Piece piece, Square from, Square to);
228
229   // Game termination checks
230   bool is_mate() const;
231   template<bool SkipRepetition> bool is_draw() const;
232
233   // Number of plies from starting position
234   int startpos_ply_counter() const;
235
236   // Other properties of the position
237   bool opposite_colored_bishops() const;
238   bool has_pawn_on_7th(Color c) const;
239   bool is_chess960() const;
240
241   // Current thread ID searching on the position
242   int thread() const;
243
244   int64_t nodes_searched() const;
245   void set_nodes_searched(int64_t n);
246
247   // Position consistency check, for debugging
248   bool is_ok(int* failedStep = NULL) const;
249
250   // Global initialization
251   static void init();
252
253 private:
254
255   // Initialization helper functions (used while setting up a position)
256   void clear();
257   void detach();
258   void put_piece(Piece p, Square s);
259   void set_castle_kingside(Color c);
260   void set_castle_queenside(Color c);
261   bool set_castling_rights(char token);
262   bool move_is_pl_slow(const Move m) const;
263
264   // Helper functions for doing and undoing moves
265   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
266   void do_castle_move(Move m);
267   void undo_castle_move(Move m);
268   void find_checkers();
269
270   template<bool FindPinned>
271   Bitboard hidden_checkers(Color c) const;
272
273   // Computing hash keys from scratch (for initialization and debugging)
274   Key compute_key() const;
275   Key compute_pawn_key() const;
276   Key compute_material_key() const;
277
278   // Computing incremental evaluation scores and material counts
279   static Score pst(Color c, PieceType pt, Square s);
280   Score compute_value() const;
281   Value compute_non_pawn_material(Color c) const;
282
283   // Board
284   Piece board[64];
285
286   // Bitboards
287   Bitboard byTypeBB[8], byColorBB[2];
288
289   // Piece counts
290   int pieceCount[2][8]; // [color][pieceType]
291
292   // Piece lists
293   Square pieceList[2][8][16]; // [color][pieceType][index]
294   int index[64]; // [square]
295
296   // Other info
297   Color sideToMove;
298   Key history[MaxGameLength];
299   int castleRightsMask[64];
300   StateInfo startState;
301   File initialKFile, initialKRFile, initialQRFile;
302   bool chess960;
303   int startPosPlyCounter;
304   int threadID;
305   int64_t nodes;
306   StateInfo* st;
307
308   // Static variables
309   static Key zobrist[2][8][64];
310   static Key zobEp[64];
311   static Key zobCastle[16];
312   static Key zobSideToMove;
313   static Score PieceSquareTable[16][64];
314   static Key zobExclusion;
315   static const Value seeValues[8];
316   static const Value PieceValueMidgame[17];
317   static const Value PieceValueEndgame[17];
318 };
319
320 inline int64_t Position::nodes_searched() const {
321   return nodes;
322 }
323
324 inline void Position::set_nodes_searched(int64_t n) {
325   nodes = n;
326 }
327
328 inline Piece Position::piece_on(Square s) const {
329   return board[s];
330 }
331
332 inline Color Position::color_of_piece_on(Square s) const {
333   return color_of_piece(piece_on(s));
334 }
335
336 inline PieceType Position::type_of_piece_on(Square s) const {
337   return type_of_piece(piece_on(s));
338 }
339
340 inline bool Position::square_is_empty(Square s) const {
341   return piece_on(s) == PIECE_NONE;
342 }
343
344 inline bool Position::square_is_occupied(Square s) const {
345   return !square_is_empty(s);
346 }
347
348 inline Value Position::midgame_value_of_piece_on(Square s) const {
349   return PieceValueMidgame[piece_on(s)];
350 }
351
352 inline Value Position::endgame_value_of_piece_on(Square s) const {
353   return PieceValueEndgame[piece_on(s)];
354 }
355
356 inline Color Position::side_to_move() const {
357   return sideToMove;
358 }
359
360 inline Bitboard Position::occupied_squares() const {
361   return byTypeBB[0];
362 }
363
364 inline Bitboard Position::empty_squares() const {
365   return ~occupied_squares();
366 }
367
368 inline Bitboard Position::pieces_of_color(Color c) const {
369   return byColorBB[c];
370 }
371
372 inline Bitboard Position::pieces(PieceType pt) const {
373   return byTypeBB[pt];
374 }
375
376 inline Bitboard Position::pieces(PieceType pt, Color c) const {
377   return byTypeBB[pt] & byColorBB[c];
378 }
379
380 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
381   return byTypeBB[pt1] | byTypeBB[pt2];
382 }
383
384 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
385   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
386 }
387
388 inline int Position::piece_count(Color c, PieceType pt) const {
389   return pieceCount[c][pt];
390 }
391
392 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
393   return pieceList[c][pt][idx];
394 }
395
396 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
397   return pieceList[c][pt];
398 }
399
400 inline Square Position::ep_square() const {
401   return st->epSquare;
402 }
403
404 inline Square Position::king_square(Color c) const {
405   return pieceList[c][KING][0];
406 }
407
408 inline bool Position::can_castle_kingside(Color c) const {
409   return st->castleRights & (WHITE_OO << c);
410 }
411
412 inline bool Position::can_castle_queenside(Color c) const {
413   return st->castleRights & (WHITE_OOO << c);
414 }
415
416 inline bool Position::can_castle(Color c) const {
417   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
418 }
419
420 inline void Position::set_castle_kingside(Color c) {
421   st->castleRights |= (WHITE_OO << c);
422 }
423
424 inline void Position::set_castle_queenside(Color c) {
425   st->castleRights |= (WHITE_OOO << c);
426 }
427
428 inline Square Position::initial_kr_square(Color c) const {
429   return relative_square(c, make_square(initialKRFile, RANK_1));
430 }
431
432 inline Square Position::initial_qr_square(Color c) const {
433   return relative_square(c, make_square(initialQRFile, RANK_1));
434 }
435
436 template<>
437 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
438   return StepAttacksBB[make_piece(c, PAWN)][s];
439 }
440
441 template<PieceType Piece> // Knight and King and white pawns
442 inline Bitboard Position::attacks_from(Square s) const {
443   return StepAttacksBB[Piece][s];
444 }
445
446 template<>
447 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
448   return bishop_attacks_bb(s, occupied_squares());
449 }
450
451 template<>
452 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
453   return rook_attacks_bb(s, occupied_squares());
454 }
455
456 template<>
457 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
458   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
459 }
460
461 inline Bitboard Position::checkers() const {
462   return st->checkersBB;
463 }
464
465 inline bool Position::in_check() const {
466   return st->checkersBB != EmptyBoardBB;
467 }
468
469 inline bool Position::pawn_is_passed(Color c, Square s) const {
470   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
471 }
472
473 inline bool Position::square_is_weak(Square s, Color c) const {
474   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
475 }
476
477 inline int Position::see_value(PieceType pt) {
478   return seeValues[pt];
479 }
480
481 inline Key Position::get_key() const {
482   return st->key;
483 }
484
485 inline Key Position::get_exclusion_key() const {
486   return st->key ^ zobExclusion;
487 }
488
489 inline Key Position::get_pawn_key() const {
490   return st->pawnKey;
491 }
492
493 inline Key Position::get_material_key() const {
494   return st->materialKey;
495 }
496
497 inline Score Position::pst(Color c, PieceType pt, Square s) {
498   return PieceSquareTable[make_piece(c, pt)][s];
499 }
500
501 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
502   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
503 }
504
505 inline Score Position::value() const {
506   return st->value;
507 }
508
509 inline Value Position::non_pawn_material(Color c) const {
510   return st->npMaterial[c];
511 }
512
513 inline bool Position::move_is_passed_pawn_push(Move m) const {
514
515   Color c = side_to_move();
516   return   piece_on(move_from(m)) == make_piece(c, PAWN)
517         && pawn_is_passed(c, move_to(m));
518 }
519
520 inline int Position::startpos_ply_counter() const {
521   return startPosPlyCounter;
522 }
523
524 inline bool Position::opposite_colored_bishops() const {
525
526   return   piece_count(WHITE, BISHOP) == 1 && piece_count(BLACK, BISHOP) == 1
527         && opposite_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
528 }
529
530 inline bool Position::has_pawn_on_7th(Color c) const {
531   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
532 }
533
534 inline bool Position::is_chess960() const {
535   return chess960;
536 }
537
538 inline bool Position::move_is_capture(Move m) const {
539
540   assert (m != MOVE_NONE && m != MOVE_NULL);
541   return !move_is_special(m) ? !square_is_empty(move_to(m)) : move_is_ep(m);
542 }
543
544 inline PieceType Position::captured_piece_type() const {
545   return st->capturedType;
546 }
547
548 inline int Position::thread() const {
549   return threadID;
550 }
551
552 #endif // !defined(POSITION_H_INCLUDED)