3ea5f6dfbe9fbd82f6965c206d08361fed5d9e1a
[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(Square from, Square to) const;
217   int see(Move m) const;
218   int see_sign(Move m) const;
219
220   // Accessing hash keys
221   Key get_key() const;
222   Key get_exclusion_key() const;
223   Key get_pawn_key() const;
224   Key get_material_key() const;
225
226   // Incremental evaluation
227   Score value() const;
228   Value non_pawn_material(Color c) const;
229   static Score pst_delta(Piece piece, Square from, Square to);
230
231   // Game termination checks
232   bool is_mate() const;
233   bool is_draw() const;
234
235   // Number of plies from starting position
236   int startpos_ply_counter() const;
237
238   // Other properties of the position
239   bool opposite_colored_bishops() const;
240   bool has_pawn_on_7th(Color c) const;
241   bool is_chess960() const;
242
243   // Current thread ID searching on the position
244   int thread() const;
245
246   int64_t nodes_searched() const;
247   void set_nodes_searched(int64_t n);
248
249   // Position consistency check, for debugging
250   bool is_ok(int* failedStep = NULL) const;
251
252   // Static member functions
253   static void init_zobrist();
254   static void init_piece_square_tables();
255
256 private:
257
258   // Initialization helper functions (used while setting up a position)
259   void clear();
260   void detach();
261   void put_piece(Piece p, Square s);
262   void do_allow_oo(Color c);
263   void do_allow_ooo(Color c);
264   bool set_castling_rights(char token);
265
266   // Helper functions for doing and undoing moves
267   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
268   void do_castle_move(Move m);
269   void undo_castle_move(Move m);
270   void find_checkers();
271
272   template<bool FindPinned>
273   Bitboard hidden_checkers(Color c) const;
274
275   // Computing hash keys from scratch (for initialization and debugging)
276   Key compute_key() const;
277   Key compute_pawn_key() const;
278   Key compute_material_key() const;
279
280   // Computing incremental evaluation scores and material counts
281   static Score pst(Color c, PieceType pt, Square s);
282   Score compute_value() const;
283   Value compute_non_pawn_material(Color c) const;
284
285   // Board
286   Piece board[64];
287
288   // Bitboards
289   Bitboard byTypeBB[8], byColorBB[2];
290
291   // Piece counts
292   int pieceCount[2][8]; // [color][pieceType]
293
294   // Piece lists
295   Square pieceList[2][8][16]; // [color][pieceType][index]
296   int index[64]; // [square]
297
298   // Other info
299   Color sideToMove;
300   Key history[MaxGameLength];
301   int castleRightsMask[64];
302   StateInfo startState;
303   File initialKFile, initialKRFile, initialQRFile;
304   bool chess960;
305   int startPosPlyCounter;
306   int threadID;
307   int64_t nodes;
308   StateInfo* st;
309
310   // Static variables
311   static Key zobrist[2][8][64];
312   static Key zobEp[64];
313   static Key zobCastle[16];
314   static Key zobSideToMove;
315   static Score PieceSquareTable[16][64];
316   static Key zobExclusion;
317   static const Value seeValues[8];
318   static const Value PieceValueMidgame[17];
319   static const Value PieceValueEndgame[17];
320 };
321
322 inline int64_t Position::nodes_searched() const {
323   return nodes;
324 }
325
326 inline void Position::set_nodes_searched(int64_t n) {
327   nodes = n;
328 }
329
330 inline Piece Position::piece_on(Square s) const {
331   return board[s];
332 }
333
334 inline Color Position::color_of_piece_on(Square s) const {
335   return color_of_piece(piece_on(s));
336 }
337
338 inline PieceType Position::type_of_piece_on(Square s) const {
339   return type_of_piece(piece_on(s));
340 }
341
342 inline bool Position::square_is_empty(Square s) const {
343   return piece_on(s) == PIECE_NONE;
344 }
345
346 inline bool Position::square_is_occupied(Square s) const {
347   return !square_is_empty(s);
348 }
349
350 inline Value Position::midgame_value_of_piece_on(Square s) const {
351   return PieceValueMidgame[piece_on(s)];
352 }
353
354 inline Value Position::endgame_value_of_piece_on(Square s) const {
355   return PieceValueEndgame[piece_on(s)];
356 }
357
358 inline Color Position::side_to_move() const {
359   return sideToMove;
360 }
361
362 inline Bitboard Position::occupied_squares() const {
363   return byTypeBB[0];
364 }
365
366 inline Bitboard Position::empty_squares() const {
367   return ~occupied_squares();
368 }
369
370 inline Bitboard Position::pieces_of_color(Color c) const {
371   return byColorBB[c];
372 }
373
374 inline Bitboard Position::pieces(PieceType pt) const {
375   return byTypeBB[pt];
376 }
377
378 inline Bitboard Position::pieces(PieceType pt, Color c) const {
379   return byTypeBB[pt] & byColorBB[c];
380 }
381
382 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
383   return byTypeBB[pt1] | byTypeBB[pt2];
384 }
385
386 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
387   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
388 }
389
390 inline int Position::piece_count(Color c, PieceType pt) const {
391   return pieceCount[c][pt];
392 }
393
394 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
395   return pieceList[c][pt][idx];
396 }
397
398 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
399   return pieceList[c][pt];
400 }
401
402 inline Square Position::ep_square() const {
403   return st->epSquare;
404 }
405
406 inline Square Position::king_square(Color c) const {
407   return pieceList[c][KING][0];
408 }
409
410 inline bool Position::can_castle_kingside(Color side) const {
411   return st->castleRights & (1+int(side));
412 }
413
414 inline bool Position::can_castle_queenside(Color side) const {
415   return st->castleRights & (4+4*int(side));
416 }
417
418 inline bool Position::can_castle(Color side) const {
419   return can_castle_kingside(side) || can_castle_queenside(side);
420 }
421
422 inline Square Position::initial_kr_square(Color c) const {
423   return relative_square(c, make_square(initialKRFile, RANK_1));
424 }
425
426 inline Square Position::initial_qr_square(Color c) const {
427   return relative_square(c, make_square(initialQRFile, RANK_1));
428 }
429
430 template<>
431 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
432   return StepAttacksBB[make_piece(c, PAWN)][s];
433 }
434
435 template<PieceType Piece> // Knight and King and white pawns
436 inline Bitboard Position::attacks_from(Square s) const {
437   return StepAttacksBB[Piece][s];
438 }
439
440 template<>
441 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
442   return bishop_attacks_bb(s, occupied_squares());
443 }
444
445 template<>
446 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
447   return rook_attacks_bb(s, occupied_squares());
448 }
449
450 template<>
451 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
452   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
453 }
454
455 inline Bitboard Position::checkers() const {
456   return st->checkersBB;
457 }
458
459 inline bool Position::in_check() const {
460   return st->checkersBB != EmptyBoardBB;
461 }
462
463 inline bool Position::pawn_is_passed(Color c, Square s) const {
464   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
465 }
466
467 inline bool Position::square_is_weak(Square s, Color c) const {
468   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
469 }
470
471 inline Key Position::get_key() const {
472   return st->key;
473 }
474
475 inline Key Position::get_exclusion_key() const {
476   return st->key ^ zobExclusion;
477 }
478
479 inline Key Position::get_pawn_key() const {
480   return st->pawnKey;
481 }
482
483 inline Key Position::get_material_key() const {
484   return st->materialKey;
485 }
486
487 inline Score Position::pst(Color c, PieceType pt, Square s) {
488   return PieceSquareTable[make_piece(c, pt)][s];
489 }
490
491 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
492   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
493 }
494
495 inline Score Position::value() const {
496   return st->value;
497 }
498
499 inline Value Position::non_pawn_material(Color c) const {
500   return st->npMaterial[c];
501 }
502
503 inline bool Position::move_is_passed_pawn_push(Move m) const {
504
505   Color c = side_to_move();
506   return   piece_on(move_from(m)) == make_piece(c, PAWN)
507         && pawn_is_passed(c, move_to(m));
508 }
509
510 inline int Position::startpos_ply_counter() const {
511   return startPosPlyCounter;
512 }
513
514 inline bool Position::opposite_colored_bishops() const {
515
516   return   piece_count(WHITE, BISHOP) == 1 && piece_count(BLACK, BISHOP) == 1
517         && opposite_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
518 }
519
520 inline bool Position::has_pawn_on_7th(Color c) const {
521   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
522 }
523
524 inline bool Position::is_chess960() const {
525   return chess960;
526 }
527
528 inline bool Position::move_is_capture(Move m) const {
529
530   assert (m != MOVE_NONE && m != MOVE_NULL);
531   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
532 }
533
534 inline bool Position::move_is_capture_or_promotion(Move m) const {
535
536   assert (m != MOVE_NONE && m != MOVE_NULL);
537   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
538 }
539
540 inline PieceType Position::captured_piece_type() const {
541   return st->capturedType;
542 }
543
544 inline int Position::thread() const {
545   return threadID;
546 }
547
548 inline void Position::do_allow_oo(Color c) {
549   st->castleRights |= (1 + int(c));
550 }
551
552 inline void Position::do_allow_ooo(Color c) {
553   st->castleRights |= (4 + 4*int(c));
554 }
555
556 #endif // !defined(POSITION_H_INCLUDED)