Merge remote-tracking branch 'upstream/master'
[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   Copyright (C) 2015-2019 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef POSITION_H_INCLUDED
22 #define POSITION_H_INCLUDED
23
24 #include <cassert>
25 #include <deque>
26 #include <memory> // For std::unique_ptr
27 #include <string>
28
29 #include "bitboard.h"
30 #include "types.h"
31
32
33 /// StateInfo struct stores information needed to restore a Position object to
34 /// its previous state when we retract a move. Whenever a move is made on the
35 /// board (by calling Position::do_move), a StateInfo object must be passed.
36
37 struct StateInfo {
38
39   // Copied when making a move
40   Key    pawnKey;
41   Key    materialKey;
42   Value  nonPawnMaterial[COLOR_NB];
43   int    castlingRights;
44   int    rule50;
45   int    pliesFromNull;
46   Square epSquare;
47
48   // Not copied when making a move (will be recomputed anyhow)
49   Key        key;
50   Bitboard   checkersBB;
51   Piece      capturedPiece;
52   StateInfo* previous;
53   Bitboard   blockersForKing[COLOR_NB];
54   Bitboard   pinners[COLOR_NB];
55   Bitboard   checkSquares[PIECE_TYPE_NB];
56 };
57
58 /// A list to keep track of the position states along the setup moves (from the
59 /// start position to the position just before the search starts). Needed by
60 /// 'draw by repetition' detection. Use a std::deque because pointers to
61 /// elements are not invalidated upon list resizing.
62 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
63
64
65 /// Position class stores information regarding the board representation as
66 /// pieces, side to move, hash keys, castling info, etc. Important methods are
67 /// do_move() and undo_move(), used by the search to update node info when
68 /// traversing the search tree.
69 class Thread;
70
71 class Position {
72 public:
73   static void init();
74
75   Position() = default;
76   Position(const Position&) = delete;
77   Position& operator=(const Position&) = delete;
78
79   // FEN string input/output
80   Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
81   Position& set(const std::string& code, Color c, StateInfo* si);
82   const std::string fen() const;
83
84   // Position representation
85   Bitboard pieces() const;
86   Bitboard pieces(PieceType pt) const;
87   Bitboard pieces(PieceType pt1, PieceType pt2) const;
88   Bitboard pieces(Color c) const;
89   Bitboard pieces(Color c, PieceType pt) const;
90   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
91   Piece piece_on(Square s) const;
92   Square ep_square() const;
93   bool empty(Square s) const;
94   template<PieceType Pt> int count(Color c) const;
95   template<PieceType Pt> int count() const;
96   template<PieceType Pt> const Square* squares(Color c) const;
97   template<PieceType Pt> Square square(Color c) const;
98   int semiopen_file(Color c, File f) const;
99
100   // Castling
101   int castling_rights(Color c) const;
102   bool can_castle(CastlingRight cr) const;
103   bool castling_impeded(CastlingRight cr) const;
104   Square castling_rook_square(CastlingRight cr) const;
105
106   // Checking
107   Bitboard checkers() const;
108   Bitboard blockers_for_king(Color c) const;
109   Bitboard check_squares(PieceType pt) const;
110
111   // Attacks to/from a given square
112   Bitboard attackers_to(Square s) const;
113   Bitboard attackers_to(Square s, Bitboard occupied) const;
114   Bitboard attacks_from(PieceType pt, Square s) const;
115   template<PieceType> Bitboard attacks_from(Square s) const;
116   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
117   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
118
119   // Properties of moves
120   bool legal(Move m) const;
121   bool pseudo_legal(const Move m) const;
122   bool capture(Move m) const;
123   bool capture_or_promotion(Move m) const;
124   bool gives_check(Move m) const;
125   bool advanced_pawn_push(Move m) const;
126   Piece moved_piece(Move m) const;
127   Piece captured_piece() const;
128
129   // Piece specific
130   bool pawn_passed(Color c, Square s) const;
131   bool opposite_bishops() const;
132   int  pawns_on_same_color_squares(Color c, Square s) const;
133
134   // Doing and undoing moves
135   void do_move(Move m, StateInfo& newSt);
136   void do_move(Move m, StateInfo& newSt, bool givesCheck);
137   void undo_move(Move m);
138   void do_null_move(StateInfo& newSt);
139   void undo_null_move();
140
141   // Static Exchange Evaluation
142   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
143
144   // Accessing hash keys
145   Key key() const;
146   Key key_after(Move m) const;
147   Key material_key() const;
148   Key pawn_key() const;
149
150   // Other properties of the position
151   Color side_to_move() const;
152   int game_ply() const;
153   bool is_chess960() const;
154   Thread* this_thread() const;
155   bool is_draw(int ply) const;
156   bool has_game_cycle(int ply) const;
157   bool has_repeated() const;
158   int rule50_count() const;
159   Score psq_score() const;
160   Value non_pawn_material(Color c) const;
161   Value non_pawn_material() const;
162
163   // Position consistency check, for debugging
164   bool pos_is_ok() const;
165   void flip();
166
167 private:
168   // Initialization helpers (used while setting up a position)
169   void set_castling_right(Color c, Square rfrom);
170   void set_state(StateInfo* si) const;
171   void set_check_info(StateInfo* si) const;
172
173   // Other helpers
174   void put_piece(Piece pc, Square s);
175   void remove_piece(Piece pc, Square s);
176   void move_piece(Piece pc, Square from, Square to);
177   template<bool Do>
178   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
179
180   // Data members
181   Piece board[SQUARE_NB];
182   Bitboard byTypeBB[PIECE_TYPE_NB];
183   Bitboard byColorBB[COLOR_NB];
184   int pieceCount[PIECE_NB];
185   Square pieceList[PIECE_NB][16];
186   int index[SQUARE_NB];
187   int castlingRightsMask[SQUARE_NB];
188   Square castlingRookSquare[CASTLING_RIGHT_NB];
189   Bitboard castlingPath[CASTLING_RIGHT_NB];
190   int gamePly;
191   Color sideToMove;
192   Score psq;
193   Thread* thisThread;
194   StateInfo* st;
195   bool chess960;
196 };
197
198 namespace PSQT {
199   extern Score psq[PIECE_NB][SQUARE_NB];
200 }
201
202 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
203
204 inline Color Position::side_to_move() const {
205   return sideToMove;
206 }
207
208 inline bool Position::empty(Square s) const {
209   return board[s] == NO_PIECE;
210 }
211
212 inline Piece Position::piece_on(Square s) const {
213   return board[s];
214 }
215
216 inline Piece Position::moved_piece(Move m) const {
217   return board[from_sq(m)];
218 }
219
220 inline Bitboard Position::pieces() const {
221   return byTypeBB[ALL_PIECES];
222 }
223
224 inline Bitboard Position::pieces(PieceType pt) const {
225   return byTypeBB[pt];
226 }
227
228 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
229   return byTypeBB[pt1] | byTypeBB[pt2];
230 }
231
232 inline Bitboard Position::pieces(Color c) const {
233   return byColorBB[c];
234 }
235
236 inline Bitboard Position::pieces(Color c, PieceType pt) const {
237   return byColorBB[c] & byTypeBB[pt];
238 }
239
240 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
241   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
242 }
243
244 template<PieceType Pt> inline int Position::count(Color c) const {
245   return pieceCount[make_piece(c, Pt)];
246 }
247
248 template<PieceType Pt> inline int Position::count() const {
249   return pieceCount[make_piece(WHITE, Pt)] + pieceCount[make_piece(BLACK, Pt)];
250 }
251
252 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
253   return pieceList[make_piece(c, Pt)];
254 }
255
256 template<PieceType Pt> inline Square Position::square(Color c) const {
257   assert(pieceCount[make_piece(c, Pt)] == 1);
258   return pieceList[make_piece(c, Pt)][0];
259 }
260
261 inline Square Position::ep_square() const {
262   return st->epSquare;
263 }
264
265 inline int Position::semiopen_file(Color c, File f) const {
266   return !(pieces(c, PAWN) & file_bb(f));
267 }
268
269 inline bool Position::can_castle(CastlingRight cr) const {
270   return st->castlingRights & cr;
271 }
272
273 inline int Position::castling_rights(Color c) const {
274   return st->castlingRights & (c == WHITE ? WHITE_CASTLING : BLACK_CASTLING);
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   assert(Pt != PAWN);
288   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
289         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
290         : PseudoAttacks[Pt][s];
291 }
292
293 template<>
294 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
295   return PawnAttacks[c][s];
296 }
297
298 inline Bitboard Position::attacks_from(PieceType pt, Square s) const {
299   return attacks_bb(pt, s, byTypeBB[ALL_PIECES]);
300 }
301
302 inline Bitboard Position::attackers_to(Square s) const {
303   return attackers_to(s, byTypeBB[ALL_PIECES]);
304 }
305
306 inline Bitboard Position::checkers() const {
307   return st->checkersBB;
308 }
309
310 inline Bitboard Position::blockers_for_king(Color c) const {
311   return st->blockersForKing[c];
312 }
313
314 inline Bitboard Position::check_squares(PieceType pt) const {
315   return st->checkSquares[pt];
316 }
317
318 inline bool Position::pawn_passed(Color c, Square s) const {
319   return !(pieces(~c, PAWN) & passed_pawn_span(c, s));
320 }
321
322 inline bool Position::advanced_pawn_push(Move m) const {
323   return   type_of(moved_piece(m)) == PAWN
324         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
325 }
326
327 inline int Position::pawns_on_same_color_squares(Color c, Square s) const {
328   return popcount(pieces(c, PAWN) & ((DarkSquares & s) ? DarkSquares : ~DarkSquares));
329 }
330
331 inline Key Position::key() const {
332   return st->key;
333 }
334
335 inline Key Position::pawn_key() const {
336   return st->pawnKey;
337 }
338
339 inline Key Position::material_key() const {
340   return st->materialKey;
341 }
342
343 inline Score Position::psq_score() const {
344   return psq;
345 }
346
347 inline Value Position::non_pawn_material(Color c) const {
348   return st->nonPawnMaterial[c];
349 }
350
351 inline Value Position::non_pawn_material() const {
352   return st->nonPawnMaterial[WHITE] + st->nonPawnMaterial[BLACK];
353 }
354
355 inline int Position::game_ply() const {
356   return gamePly;
357 }
358
359 inline int Position::rule50_count() const {
360   return st->rule50;
361 }
362
363 inline bool Position::opposite_bishops() const {
364   return   pieceCount[W_BISHOP] == 1
365         && pieceCount[B_BISHOP] == 1
366         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
367 }
368
369 inline bool Position::is_chess960() const {
370   return chess960;
371 }
372
373 inline bool Position::capture_or_promotion(Move m) const {
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   assert(is_ok(m));
380   // Castling is encoded as "king captures rook"
381   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
382 }
383
384 inline Piece Position::captured_piece() const {
385   return st->capturedPiece;
386 }
387
388 inline Thread* Position::this_thread() const {
389   return thisThread;
390 }
391
392 inline void Position::put_piece(Piece pc, Square s) {
393
394   board[s] = pc;
395   byTypeBB[ALL_PIECES] |= s;
396   byTypeBB[type_of(pc)] |= s;
397   byColorBB[color_of(pc)] |= s;
398   index[s] = pieceCount[pc]++;
399   pieceList[pc][index[s]] = s;
400   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
401   psq += PSQT::psq[pc][s];
402 }
403
404 inline void Position::remove_piece(Piece pc, Square s) {
405
406   // WARNING: This is not a reversible operation. If we remove a piece in
407   // do_move() and then replace it in undo_move() we will put it at the end of
408   // the list and not in its original place, it means index[] and pieceList[]
409   // are not invariant to a do_move() + undo_move() sequence.
410   byTypeBB[ALL_PIECES] ^= s;
411   byTypeBB[type_of(pc)] ^= s;
412   byColorBB[color_of(pc)] ^= s;
413   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
414   Square lastSquare = pieceList[pc][--pieceCount[pc]];
415   index[lastSquare] = index[s];
416   pieceList[pc][index[lastSquare]] = lastSquare;
417   pieceList[pc][pieceCount[pc]] = SQ_NONE;
418   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
419   psq -= PSQT::psq[pc][s];
420 }
421
422 inline void Position::move_piece(Piece pc, Square from, Square to) {
423
424   // index[from] is not updated and becomes stale. This works as long as index[]
425   // is accessed just by known occupied squares.
426   Bitboard fromTo = square_bb(from) | square_bb(to);
427   byTypeBB[ALL_PIECES] ^= fromTo;
428   byTypeBB[type_of(pc)] ^= fromTo;
429   byColorBB[color_of(pc)] ^= fromTo;
430   board[from] = NO_PIECE;
431   board[to] = pc;
432   index[to] = index[from];
433   pieceList[pc][index[to]] = to;
434   psq += PSQT::psq[pc][to] - PSQT::psq[pc][from];
435 }
436
437 inline void Position::do_move(Move m, StateInfo& newSt) {
438   do_move(m, newSt, gives_check(m));
439 }
440
441 #endif // #ifndef POSITION_H_INCLUDED