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