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