]> git.sesse.net Git - stockfish/blob - src/position.h
Assorted work in uci.cpp
[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 "types.h"
28
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 nonPawnMaterial[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   // Disable the default copy constructor
80   Position(const Position&); 
81
82 public:
83   Position() {}
84   Position(const Position& pos, Thread* th) { *this = pos; thisThread = th; }
85   Position(const std::string& f, bool c960, Thread* th) { set(f, c960, th); }
86   Position& operator=(const Position&);
87   static void init();
88
89   // FEN string input/output
90   void set(const std::string& fenStr, bool isChess960, Thread* th);
91   const std::string fen() const;
92
93   // Position representation
94   Bitboard pieces() const;
95   Bitboard pieces(PieceType pt) const;
96   Bitboard pieces(PieceType pt1, PieceType pt2) const;
97   Bitboard pieces(Color c) const;
98   Bitboard pieces(Color c, PieceType pt) const;
99   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
100   Piece piece_on(Square s) const;
101   Square king_square(Color c) const;
102   Square ep_square() const;
103   bool empty(Square s) const;
104   template<PieceType Pt> int count(Color c) const;
105   template<PieceType Pt> const Square* list(Color c) const;
106
107   // Castling
108   int can_castle(Color c) const;
109   int can_castle(CastlingRight cr) const;
110   bool castling_impeded(CastlingRight cr) const;
111   Square castling_rook_square(CastlingRight cr) const;
112
113   // Checking
114   Bitboard checkers() const;
115   Bitboard discovered_check_candidates() const;
116   Bitboard pinned_pieces(Color c) const;
117
118   // Attacks to/from a given square
119   Bitboard attackers_to(Square s) const;
120   Bitboard attackers_to(Square s, Bitboard occupied) const;
121   Bitboard attacks_from(Piece pc, Square s) const;
122   template<PieceType> Bitboard attacks_from(Square s) const;
123   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
124
125   // Properties of moves
126   bool legal(Move m, Bitboard pinned) const;
127   bool pseudo_legal(const Move m) const;
128   bool capture(Move m) const;
129   bool capture_or_promotion(Move m) const;
130   bool gives_check(Move m, const CheckInfo& ci) const;
131   bool advanced_pawn_push(Move m) const;
132   Piece moved_piece(Move m) const;
133   PieceType captured_piece_type() const;
134
135   // Piece specific
136   bool pawn_passed(Color c, Square s) const;
137   bool pawn_on_7th(Color c) const;
138   bool bishop_pair(Color c) const;
139   bool opposite_bishops() const;
140
141   // Doing and undoing moves
142   void do_move(Move m, StateInfo& st);
143   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
144   void undo_move(Move m);
145   void do_null_move(StateInfo& st);
146   void undo_null_move();
147
148   // Static exchange evaluation
149   Value see(Move m) const;
150   Value see_sign(Move m) const;
151
152   // Accessing hash keys
153   Key key() const;
154   Key key_after(Move m) const;
155   Key exclusion_key() const;
156   Key pawn_key() const;
157   Key material_key() const;
158
159   // Incremental piece-square evaluation
160   Score psq_score() const;
161   Value non_pawn_material(Color c) const;
162
163   // Other properties of the position
164   Color side_to_move() const;
165   Phase game_phase() const;
166   int game_ply() const;
167   bool is_chess960() const;
168   Thread* this_thread() const;
169   uint64_t nodes_searched() const;
170   void set_nodes_searched(uint64_t n);
171   bool is_draw() const;
172   int rule50_count() const;
173
174   // Position consistency check, for debugging
175   bool pos_is_ok(int* step = NULL) const;
176   void flip();
177
178 private:
179   // Initialization helpers (used while setting up a position)
180   void clear();
181   void set_castling_right(Color c, Square rfrom);
182   void set_state(StateInfo* si) const;
183
184   // Helper functions
185   Bitboard check_blockers(Color c, Color kingColor) const;
186   void put_piece(Square s, Color c, PieceType pt);
187   void remove_piece(Square s, Color c, PieceType pt);
188   void move_piece(Square from, Square to, Color c, PieceType pt);
189   template<bool Do>
190   void do_castling(Square from, Square& to, Square& rfrom, Square& rto);
191
192   // Board and pieces
193   Piece board[SQUARE_NB];
194   Bitboard byTypeBB[PIECE_TYPE_NB];
195   Bitboard byColorBB[COLOR_NB];
196   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
197   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
198   int index[SQUARE_NB];
199
200   // Other info
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 uint64_t Position::nodes_searched() const {
214   return nodes;
215 }
216
217 inline void Position::set_nodes_searched(uint64_t n) {
218   nodes = n;
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 bool Position::empty(Square s) const {
230   return board[s] == NO_PIECE;
231 }
232
233 inline Color Position::side_to_move() const {
234   return sideToMove;
235 }
236
237 inline Bitboard Position::pieces() const {
238   return byTypeBB[ALL_PIECES];
239 }
240
241 inline Bitboard Position::pieces(PieceType pt) const {
242   return byTypeBB[pt];
243 }
244
245 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
246   return byTypeBB[pt1] | byTypeBB[pt2];
247 }
248
249 inline Bitboard Position::pieces(Color c) const {
250   return byColorBB[c];
251 }
252
253 inline Bitboard Position::pieces(Color c, PieceType pt) const {
254   return byColorBB[c] & byTypeBB[pt];
255 }
256
257 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
258   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
259 }
260
261 template<PieceType Pt> inline int Position::count(Color c) const {
262   return pieceCount[c][Pt];
263 }
264
265 template<PieceType Pt> inline const Square* Position::list(Color c) const {
266   return pieceList[c][Pt];
267 }
268
269 inline Square Position::ep_square() const {
270   return st->epSquare;
271 }
272
273 inline Square Position::king_square(Color c) const {
274   return pieceList[c][KING][0];
275 }
276
277 inline int Position::can_castle(CastlingRight cr) const {
278   return st->castlingRights & cr;
279 }
280
281 inline int Position::can_castle(Color c) const {
282   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
283 }
284
285 inline bool Position::castling_impeded(CastlingRight cr) const {
286   return byTypeBB[ALL_PIECES] & castlingPath[cr];
287 }
288
289 inline Square Position::castling_rook_square(CastlingRight cr) const {
290   return castlingRookSquare[cr];
291 }
292
293 template<PieceType Pt>
294 inline Bitboard Position::attacks_from(Square s) const {
295
296   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
297         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
298         : StepAttacksBB[Pt][s];
299 }
300
301 template<>
302 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
303   return StepAttacksBB[make_piece(c, PAWN)][s];
304 }
305
306 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
307   return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
308 }
309
310 inline Bitboard Position::attackers_to(Square s) const {
311   return attackers_to(s, byTypeBB[ALL_PIECES]);
312 }
313
314 inline Bitboard Position::checkers() const {
315   return st->checkersBB;
316 }
317
318 inline Bitboard Position::discovered_check_candidates() const {
319   return check_blockers(sideToMove, ~sideToMove);
320 }
321
322 inline Bitboard Position::pinned_pieces(Color c) const {
323   return check_blockers(c, c);
324 }
325
326 inline bool Position::pawn_passed(Color c, Square s) const {
327   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
328 }
329
330 inline bool Position::advanced_pawn_push(Move m) const {
331   return   type_of(moved_piece(m)) == PAWN
332         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
333 }
334
335 inline Key Position::key() const {
336   return st->key;
337 }
338
339 inline Key Position::pawn_key() const {
340   return st->pawnKey;
341 }
342
343 inline Key Position::material_key() const {
344   return st->materialKey;
345 }
346
347 inline Score Position::psq_score() const {
348   return st->psq;
349 }
350
351 inline Value Position::non_pawn_material(Color c) const {
352   return st->nonPawnMaterial[c];
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
365   return   pieceCount[WHITE][BISHOP] == 1
366         && pieceCount[BLACK][BISHOP] == 1
367         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
368 }
369
370 inline bool Position::bishop_pair(Color c) const {
371
372   return   pieceCount[c][BISHOP] >= 2
373         && opposite_colors(pieceList[c][BISHOP][0], pieceList[c][BISHOP][1]);
374 }
375
376 inline bool Position::pawn_on_7th(Color c) const {
377   return pieces(c, PAWN) & rank_bb(relative_rank(c, RANK_7));
378 }
379
380 inline bool Position::is_chess960() const {
381   return chess960;
382 }
383
384 inline bool Position::capture_or_promotion(Move m) const {
385
386   assert(is_ok(m));
387   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
388 }
389
390 inline bool Position::capture(Move m) const {
391
392   // Note that castling is encoded as "king captures the rook"
393   assert(is_ok(m));
394   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
395 }
396
397 inline PieceType Position::captured_piece_type() const {
398   return st->capturedType;
399 }
400
401 inline Thread* Position::this_thread() const {
402   return thisThread;
403 }
404
405 inline void Position::put_piece(Square s, Color c, PieceType pt) {
406
407   board[s] = make_piece(c, pt);
408   byTypeBB[ALL_PIECES] |= s;
409   byTypeBB[pt] |= s;
410   byColorBB[c] |= s;
411   index[s] = pieceCount[c][pt]++;
412   pieceList[c][pt][index[s]] = s;
413   pieceCount[c][ALL_PIECES]++;
414 }
415
416 inline void Position::move_piece(Square from, Square to, Color c, PieceType pt) {
417
418   // index[from] is not updated and becomes stale. This works as long
419   // as index[] is accessed just by known occupied squares.
420   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
421   byTypeBB[ALL_PIECES] ^= from_to_bb;
422   byTypeBB[pt] ^= from_to_bb;
423   byColorBB[c] ^= from_to_bb;
424   board[from] = NO_PIECE;
425   board[to] = make_piece(c, pt);
426   index[to] = index[from];
427   pieceList[c][pt][index[to]] = to;
428 }
429
430 inline void Position::remove_piece(Square s, Color c, PieceType pt) {
431
432   // WARNING: This is not a reversible operation. If we remove a piece in
433   // do_move() and then replace it in undo_move() we will put it at the end of
434   // the list and not in its original place, it means index[] and pieceList[]
435   // are not guaranteed to be invariant to a do_move() + undo_move() sequence.
436   byTypeBB[ALL_PIECES] ^= s;
437   byTypeBB[pt] ^= s;
438   byColorBB[c] ^= s;
439   /* board[s] = NO_PIECE; */ // Not needed, will be overwritten by capturing
440   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
441   index[lastSquare] = index[s];
442   pieceList[c][pt][index[lastSquare]] = lastSquare;
443   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
444   pieceCount[c][ALL_PIECES]--;
445 }
446
447 #endif // #ifndef POSITION_H_INCLUDED