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