]> git.sesse.net Git - stockfish/blob - src/movegen.h
Standardize Comments
[stockfish] / src / movegen.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #ifndef MOVEGEN_H_INCLUDED
20 #define MOVEGEN_H_INCLUDED
21
22 #include <algorithm> // IWYU pragma: keep
23 #include <cstddef>
24
25 #include "types.h"
26
27 namespace Stockfish {
28
29 class Position;
30
31 enum GenType {
32   CAPTURES,
33   QUIETS,
34   QUIET_CHECKS,
35   EVASIONS,
36   NON_EVASIONS,
37   LEGAL
38 };
39
40 struct ExtMove {
41   Move move;
42   int value;
43
44   operator Move() const { return move; }
45   void operator=(Move m) { move = m; }
46
47   // Inhibit unwanted implicit conversions to Move
48   // with an ambiguity that yields to a compile error.
49   operator float() const = delete;
50 };
51
52 inline bool operator<(const ExtMove& f, const ExtMove& s) {
53   return f.value < s.value;
54 }
55
56 template<GenType>
57 ExtMove* generate(const Position& pos, ExtMove* moveList);
58
59 // The MoveList struct wraps the generate() function and returns a convenient
60 // list of moves. Using MoveList is sometimes preferable to directly calling
61 // the lower level generate() function.
62 template<GenType T>
63 struct MoveList {
64
65   explicit MoveList(const Position& pos) : last(generate<T>(pos, moveList)) {}
66   const ExtMove* begin() const { return moveList; }
67   const ExtMove* end() const { return last; }
68   size_t size() const { return last - moveList; }
69   bool contains(Move move) const {
70     return std::find(begin(), end(), move) != end();
71   }
72
73 private:
74   ExtMove moveList[MAX_MOVES], *last;
75 };
76
77 } // namespace Stockfish
78
79 #endif // #ifndef MOVEGEN_H_INCLUDED