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