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