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