Small codestyle touches
[stockfish] / src / move.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
21 #if !defined(MOVE_H_INCLUDED)
22 #define MOVE_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include <iostream>
29
30 #include "misc.h"
31 #include "piece.h"
32 #include "square.h"
33
34 // Maximum number of allowed moves per position
35 const int MOVES_MAX = 256;
36
37 ////
38 //// Types
39 ////
40
41 class Position;
42
43 /// A move needs 17 bits to be stored
44 ///
45 /// bit  0- 5: destination square (from 0 to 63)
46 /// bit  6-11: origin square (from 0 to 63)
47 /// bit 12-14: promotion piece type
48 /// bit    15: en passant flag
49 /// bit    16: castle flag
50 ///
51 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in
52 /// because in any normal move destination square is always different
53 /// from origin square while MOVE_NONE and MOVE_NULL have the same
54 /// origin and destination square, 0 and 1 respectively.
55
56 enum Move {
57   MOVE_NONE = 0,
58   MOVE_NULL = 65
59 };
60
61
62 struct MoveStack {
63   Move move;
64   int score;
65 };
66
67 // Note that operator< is set up such that sorting will be in descending order
68 inline bool operator<(const MoveStack& f, const MoveStack& s) { return s.score < f.score; }
69
70 // An helper insertion sort implementation
71 template<typename T>
72 inline void insertion_sort(T* firstMove, T* lastMove)
73 {
74     T value;
75     T *cur, *p, *d;
76
77     if (firstMove != lastMove)
78         for (cur = firstMove + 1; cur != lastMove; cur++)
79         {
80             p = d = cur;
81             value = *p--;
82             if (value < *p)
83             {
84                 do *d = *p;
85                 while (--d != firstMove && value < *--p);
86                 *d = value;
87             }
88         }
89 }
90
91 // Our dedicated sort in range [firstMove, lastMove), first splits
92 // positive scores from ramining then order seaprately the two sets.
93 template<typename T>
94 inline void sort_moves(T* firstMove, T* lastMove, T** lastPositive)
95 {
96     T tmp;
97     T *p, *d;
98
99     d = lastMove;
100     p = firstMove - 1;
101
102     d->score = -1; // right guard
103
104     // Split positives vs non-positives
105     do {
106         while ((++p)->score > 0) {}
107
108         if (p != d)
109         {
110             while (--d != p && d->score <= 0) {}
111
112             tmp = *p;
113             *p = *d;
114             *d = tmp;
115         }
116
117     } while (p != d);
118
119     // Sort just positive scored moves, remaining only when we get there
120     insertion_sort<T>(firstMove, p);
121     *lastPositive = p;
122 }
123
124 // Picks up the best move in range [curMove, lastMove), one per cycle.
125 // It is faster then sorting all the moves in advance when moves are few,
126 // as normally are the possible captures. Note that is not a stable alghoritm.
127 template<typename T>
128 inline T pick_best(T* curMove, T* lastMove)
129 {
130     T bestMove, tmp;
131
132     bestMove = *curMove;
133     while (++curMove != lastMove)
134     {
135         if (*curMove < bestMove)
136         {
137             tmp = *curMove;
138             *curMove = bestMove;
139             bestMove = tmp;
140         }
141     }
142     return bestMove;
143 }
144
145 ////
146 //// Inline functions
147 ////
148
149 inline Square move_from(Move m) {
150   return Square((int(m) >> 6) & 0x3F);
151 }
152
153 inline Square move_to(Move m) {
154   return Square(m & 0x3F);
155 }
156
157 inline PieceType move_promotion_piece(Move m) {
158   return PieceType((int(m) >> 12) & 7);
159 }
160
161 inline int move_is_special(Move m) {
162   return m & (0x1F << 12);
163 }
164
165 inline int move_is_promotion(Move m) {
166   return m & (7 << 12);
167 }
168
169 inline int move_is_ep(Move m) {
170   return m & (1 << 15);
171 }
172
173 inline int move_is_castle(Move m) {
174   return m & (1 << 16);
175 }
176
177 inline bool move_is_short_castle(Move m) {
178   return move_is_castle(m) && (move_to(m) > move_from(m));
179 }
180
181 inline bool move_is_long_castle(Move m) {
182   return move_is_castle(m) && (move_to(m) < move_from(m));
183 }
184
185 inline Move make_promotion_move(Square from, Square to, PieceType promotion) {
186   return Move(int(to) | (int(from) << 6) | (int(promotion) << 12));
187 }
188
189 inline Move make_move(Square from, Square to) {
190   return Move(int(to) | (int(from) << 6));
191 }
192
193 inline Move make_castle_move(Square from, Square to) {
194   return Move(int(to) | (int(from) << 6) | (1 << 16));
195 }
196
197 inline Move make_ep_move(Square from, Square to) {
198   return Move(int(to) | (int(from) << 6) | (1 << 15));
199 }
200
201
202 ////
203 //// Prototypes
204 ////
205
206 extern std::ostream& operator<<(std::ostream& os, Move m);
207 extern Move move_from_string(const Position& pos, const std::string &str);
208 extern const std::string move_to_string(Move m, bool chess960);
209 extern bool move_is_ok(Move m);
210
211
212 #endif // !defined(MOVE_H_INCLUDED)