85ea6a7a8020311046c04fe7b15a1d5faf158ebc
[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-2015 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 #ifndef POSITION_H_INCLUDED
21 #define POSITION_H_INCLUDED
22
23 #include <cassert>
24 #include <cstddef>  // For offsetof()
25 #include <string>
26
27 #include "bitboard.h"
28 #include "types.h"
29
30 class Position;
31 struct Thread;
32
33 /// CheckInfo struct is initialized at c'tor time and keeps info used to detect
34 /// if a move gives check.
35
36 struct CheckInfo {
37
38   explicit CheckInfo(const Position&);
39
40   Bitboard dcCandidates;
41   Bitboard pinned;
42   Bitboard checkSq[PIECE_TYPE_NB];
43   Square   ksq;
44 };
45
46
47 /// StateInfo struct stores information needed to restore a Position object to
48 /// its previous state when we retract a move. Whenever a move is made on the
49 /// board (by calling Position::do_move), a StateInfo object must be passed.
50
51 struct StateInfo {
52
53   // Copied when making a move
54   Key    pawnKey;
55   Key    materialKey;
56   Value  nonPawnMaterial[COLOR_NB];
57   int    castlingRights;
58   int    rule50;
59   int    pliesFromNull;
60   Score  psq;
61   Square epSquare;
62
63   // Not copied when making a move
64   Key        key;
65   Bitboard   checkersBB;
66   PieceType  capturedType;
67   StateInfo* previous;
68 };
69
70
71 /// When making a move the current StateInfo up to 'key' excluded is copied to
72 /// the new one. Here we calculate the quad words (64 bit) needed to be copied.
73 const size_t StateCopySize64 = offsetof(StateInfo, key) / sizeof(uint64_t) + 1;
74
75
76 /// Position class stores information regarding the board representation as
77 /// pieces, side to move, hash keys, castling info, etc. Important methods are
78 /// do_move() and undo_move(), used by the search to update node info when
79 /// traversing the search tree.
80
81 class Position {
82
83   friend std::ostream& operator<<(std::ostream&, const Position&);
84
85   Position(const Position&); // Disable the default copy constructor
86
87 public:
88   static void init();
89
90   Position() {} // To define the global object RootPos
91   Position(const Position& pos, Thread* th) { *this = pos; thisThread = th; }
92   Position(const std::string& f, bool c960, Thread* th) { set(f, c960, th); }
93   Position& operator=(const Position&); // To assign RootPos from UCI
94
95   // FEN string input/output
96   void set(const std::string& fenStr, bool isChess960, Thread* th);
97   const std::string fen() const;
98
99   // Position representation
100   Bitboard pieces() const;
101   Bitboard pieces(PieceType pt) const;
102   Bitboard pieces(PieceType pt1, PieceType pt2) const;
103   Bitboard pieces(Color c) const;
104   Bitboard pieces(Color c, PieceType pt) const;
105   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
106   Piece piece_on(Square s) const;
107   Square king_square(Color c) const;
108   Square ep_square() const;
109   bool empty(Square s) const;
110   template<PieceType Pt> int count(Color c) const;
111   template<PieceType Pt> const Square* list(Color c) const;
112
113   // Castling
114   int can_castle(Color c) const;
115   int can_castle(CastlingRight cr) const;
116   bool castling_impeded(CastlingRight cr) const;
117   Square castling_rook_square(CastlingRight cr) const;
118
119   // Checking
120   Bitboard checkers() const;
121   Bitboard discovered_check_candidates() const;
122   Bitboard pinned_pieces(Color c) const;
123
124   // Attacks to/from a given square
125   Bitboard attackers_to(Square s) const;
126   Bitboard attackers_to(Square s, Bitboard occupied) const;
127   Bitboard attacks_from(Piece pc, Square s) const;
128   template<PieceType> Bitboard attacks_from(Square s) const;
129   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
130
131   // Properties of moves
132   bool legal(Move m, Bitboard pinned) const;
133   bool pseudo_legal(const Move m) const;
134   bool capture(Move m) const;
135   bool capture_or_promotion(Move m) const;
136   bool gives_check(Move m, const CheckInfo& ci) const;
137   bool advanced_pawn_push(Move m) const;
138   Piece moved_piece(Move m) const;
139   PieceType captured_piece_type() const;
140
141   // Piece specific
142   bool pawn_passed(Color c, Square s) const;
143   bool pawn_on_7th(Color c) const;
144   bool opposite_bishops() const;
145
146   // Doing and undoing moves
147   void do_move(Move m, StateInfo& st);
148   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
149   void undo_move(Move m);
150   void do_null_move(StateInfo& st);
151   void undo_null_move();
152
153   // Static exchange evaluation
154   Value see(Move m) const;
155   Value see_sign(Move m) const;
156
157   // Accessing hash keys
158   Key key() const;
159   Key key_after(Move m) const;
160   Key exclusion_key() const;
161   Key material_key() const;
162   Key pawn_key() const;
163
164   // Other properties of the position
165   Color side_to_move() const;
166   Phase game_phase() const;
167   int game_ply() const;
168   bool is_chess960() const;
169   Thread* this_thread() const;
170   uint64_t nodes_searched() const;
171   void set_nodes_searched(uint64_t n);
172   bool is_draw() const;
173   Score psq_score() const;
174   Value non_pawn_material(Color c) const;
175
176   // Position consistency check, for debugging
177   bool pos_is_ok(int* step = nullptr) const;
178   void flip();
179
180 private:
181   // Initialization helpers (used while setting up a position)
182   void clear();
183   void set_castling_right(Color c, Square rfrom);
184   void set_state(StateInfo* si) const;
185
186   // Other helpers
187   Bitboard check_blockers(Color c, Color kingColor) const;
188   void put_piece(Square s, Color c, PieceType pt);
189   void remove_piece(Square s, Color c, PieceType pt);
190   void move_piece(Square from, Square to, Color c, PieceType pt);
191   template<bool Do>
192   void do_castling(Square from, Square& to, Square& rfrom, Square& rto);
193
194   // Data members
195   Piece board[SQUARE_NB];
196   Bitboard byTypeBB[PIECE_TYPE_NB];
197   Bitboard byColorBB[COLOR_NB];
198   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
199   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
200   int index[SQUARE_NB];
201   int castlingRightsMask[SQUARE_NB];
202   Square castlingRookSquare[CASTLING_RIGHT_NB];
203   Bitboard castlingPath[CASTLING_RIGHT_NB];
204   StateInfo startState;
205   uint64_t nodes;
206   int gamePly;
207   Color sideToMove;
208   Thread* thisThread;
209   StateInfo* st;
210   bool chess960;
211 };
212
213 inline Color Position::side_to_move() const {
214   return sideToMove;
215 }
216
217 inline bool Position::empty(Square s) const {
218   return board[s] == NO_PIECE;
219 }
220
221 inline Piece Position::piece_on(Square s) const {
222   return board[s];
223 }
224
225 inline Piece Position::moved_piece(Move m) const {
226   return board[from_sq(m)];
227 }
228
229 inline Bitboard Position::pieces() const {
230   return byTypeBB[ALL_PIECES];
231 }
232
233 inline Bitboard Position::pieces(PieceType pt) const {
234   return byTypeBB[pt];
235 }
236
237 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
238   return byTypeBB[pt1] | byTypeBB[pt2];
239 }
240
241 inline Bitboard Position::pieces(Color c) const {
242   return byColorBB[c];
243 }
244
245 inline Bitboard Position::pieces(Color c, PieceType pt) const {
246   return byColorBB[c] & byTypeBB[pt];
247 }
248
249 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
250   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
251 }
252
253 template<PieceType Pt> inline int Position::count(Color c) const {
254   return pieceCount[c][Pt];
255 }
256
257 template<PieceType Pt> inline const Square* Position::list(Color c) const {
258   return pieceList[c][Pt];
259 }
260
261 inline Square Position::king_square(Color c) const {
262   return pieceList[c][KING][0];
263 }
264
265 inline Square Position::ep_square() const {
266   return st->epSquare;
267 }
268
269 inline int Position::can_castle(CastlingRight cr) const {
270   return st->castlingRights & cr;
271 }
272
273 inline int Position::can_castle(Color c) const {
274   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
275 }
276
277 inline bool Position::castling_impeded(CastlingRight cr) const {
278   return byTypeBB[ALL_PIECES] & castlingPath[cr];
279 }
280
281 inline Square Position::castling_rook_square(CastlingRight cr) const {
282   return castlingRookSquare[cr];
283 }
284
285 template<PieceType Pt>
286 inline Bitboard Position::attacks_from(Square s) const {
287   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
288         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
289         : StepAttacksBB[Pt][s];
290 }
291
292 template<>
293 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
294   return StepAttacksBB[make_piece(c, PAWN)][s];
295 }
296
297 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
298   return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
299 }
300
301 inline Bitboard Position::attackers_to(Square s) const {
302   return attackers_to(s, byTypeBB[ALL_PIECES]);
303 }
304
305 inline Bitboard Position::checkers() const {
306   return st->checkersBB;
307 }
308
309 inline Bitboard Position::discovered_check_candidates() const {
310   return check_blockers(sideToMove, ~sideToMove);
311 }
312
313 inline Bitboard Position::pinned_pieces(Color c) const {
314   return check_blockers(c, c);
315 }
316
317 inline bool Position::pawn_passed(Color c, Square s) const {
318   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
319 }
320
321 inline bool Position::advanced_pawn_push(Move m) const {
322   return   type_of(moved_piece(m)) == PAWN
323         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
324 }
325
326 inline Key Position::key() const {
327   return st->key;
328 }
329
330 inline Key Position::pawn_key() const {
331   return st->pawnKey;
332 }
333
334 inline Key Position::material_key() const {
335   return st->materialKey;
336 }
337
338 inline Score Position::psq_score() const {
339   return st->psq;
340 }
341
342 inline Value Position::non_pawn_material(Color c) const {
343   return st->nonPawnMaterial[c];
344 }
345
346 inline int Position::game_ply() const {
347   return gamePly;
348 }
349
350 inline uint64_t Position::nodes_searched() const {
351   return nodes;
352 }
353
354 inline void Position::set_nodes_searched(uint64_t n) {
355   nodes = n;
356 }
357
358 inline bool Position::opposite_bishops() const {
359   return   pieceCount[WHITE][BISHOP] == 1
360         && pieceCount[BLACK][BISHOP] == 1
361         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
362 }
363
364 inline bool Position::pawn_on_7th(Color c) const {
365   return pieces(c, PAWN) & rank_bb(relative_rank(c, RANK_7));
366 }
367
368 inline bool Position::is_chess960() const {
369   return chess960;
370 }
371
372 inline bool Position::capture_or_promotion(Move m) const {
373
374   assert(is_ok(m));
375   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
376 }
377
378 inline bool Position::capture(Move m) const {
379
380   // Castling is encoded as "king captures the rook"
381   assert(is_ok(m));
382   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
383 }
384
385 inline PieceType Position::captured_piece_type() const {
386   return st->capturedType;
387 }
388
389 inline Thread* Position::this_thread() const {
390   return thisThread;
391 }
392
393 inline void Position::put_piece(Square s, Color c, PieceType pt) {
394
395   board[s] = make_piece(c, pt);
396   byTypeBB[ALL_PIECES] |= s;
397   byTypeBB[pt] |= s;
398   byColorBB[c] |= s;
399   index[s] = pieceCount[c][pt]++;
400   pieceList[c][pt][index[s]] = s;
401   pieceCount[c][ALL_PIECES]++;
402 }
403
404 inline void Position::move_piece(Square from, Square to, Color c, PieceType pt) {
405
406   // index[from] is not updated and becomes stale. This works as long as index[]
407   // is accessed just by known occupied squares.
408   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
409   byTypeBB[ALL_PIECES] ^= from_to_bb;
410   byTypeBB[pt] ^= from_to_bb;
411   byColorBB[c] ^= from_to_bb;
412   board[from] = NO_PIECE;
413   board[to] = make_piece(c, pt);
414   index[to] = index[from];
415   pieceList[c][pt][index[to]] = to;
416 }
417
418 inline void Position::remove_piece(Square s, Color c, PieceType pt) {
419
420   // WARNING: This is not a reversible operation. If we remove a piece in
421   // do_move() and then replace it in undo_move() we will put it at the end of
422   // the list and not in its original place, it means index[] and pieceList[]
423   // are not guaranteed to be invariant to a do_move() + undo_move() sequence.
424   byTypeBB[ALL_PIECES] ^= s;
425   byTypeBB[pt] ^= s;
426   byColorBB[c] ^= s;
427   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
428   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
429   index[lastSquare] = index[s];
430   pieceList[c][pt][index[lastSquare]] = lastSquare;
431   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
432   pieceCount[c][ALL_PIECES]--;
433 }
434
435 #endif // #ifndef POSITION_H_INCLUDED