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