/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
- Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
+ Copyright (C) 2004-2022 The Stockfish developers (see AUTHORS file)
Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#if !defined(ENDGAME_H_INCLUDED)
+#ifndef ENDGAME_H_INCLUDED
#define ENDGAME_H_INCLUDED
+#include <memory>
+#include <string>
+#include <type_traits>
+#include <unordered_map>
+#include <utility>
+
#include "position.h"
#include "types.h"
-enum EndgameType {
-
- // Evaluation functions
- KXK, // Generic "mate lone king" eval
- KBNK, // KBN vs K
- KPK, // KP vs K
- KRKP, // KR vs KP
- KRKB, // KR vs KB
- KRKN, // KR vs KN
- KQKR, // KQ vs KR
- KBBKN, // KBB vs KN
- KNNK, // KNN vs K
- KmmKm, // K and two minors vs K and one or two minors
-
- // Scaling functions
- KBPsK, // KB+pawns vs K
- KQKRPs, // KQ vs KR+pawns
- KRPKR, // KRP vs KR
- KRPPKRP, // KRPP vs KRP
- KPsK, // King and pawns vs king
- KBPKB, // KBP vs KB
- KBPPKB, // KBPP vs KB
- KBPKN, // KBP vs KN
- KNPK, // KNP vs K
- KPKP // KP vs KP
+namespace Stockfish {
+
+/// EndgameCode lists all supported endgame functions by corresponding codes
+
+enum EndgameCode {
+
+ EVALUATION_FUNCTIONS,
+ KNNK, // KNN vs K
+ KNNKP, // KNN vs KP
+ KXK, // Generic "mate lone king" eval
+ KBNK, // KBN vs K
+ KPK, // KP vs K
+ KRKP, // KR vs KP
+ KRKB, // KR vs KB
+ KRKN, // KR vs KN
+ KQKP, // KQ vs KP
+ KQKR, // KQ vs KR
+
+ SCALING_FUNCTIONS,
+ KBPsK, // KB and pawns vs K
+ KQKRPs, // KQ vs KR and pawns
+ KRPKR, // KRP vs KR
+ KRPKB, // KRP vs KB
+ KRPPKRP, // KRPP vs KRP
+ KPsK, // K and pawns vs K
+ KBPKB, // KBP vs KB
+ KBPPKB, // KBPP vs KB
+ KBPKN, // KBP vs KN
+ KPKP // KP vs KP
};
-/// Template abstract base class for all special endgame functions
-template<typename T>
-class EndgameFunctionBase {
-public:
- EndgameFunctionBase(Color c) : strongerSide(c), weakerSide(opposite_color(c)) {}
- virtual ~EndgameFunctionBase() {}
- virtual T apply(const Position&) const = 0;
- Color color() const { return strongerSide; }
-
-protected:
- Color strongerSide, weakerSide;
-};
+/// Endgame functions can be of two types depending on whether they return a
+/// Value or a ScaleFactor.
+
+template<EndgameCode E> using
+eg_type = typename std::conditional<(E < SCALING_FUNCTIONS), Value, ScaleFactor>::type;
+
-typedef EndgameFunctionBase<Value> EndgameEvaluationFunctionBase;
-typedef EndgameFunctionBase<ScaleFactor> EndgameScalingFunctionBase;
+/// Base and derived functors for endgame evaluation and scaling functions
+template<typename T>
+struct EndgameBase {
-/// Templates subclass for various concrete endgames
+ explicit EndgameBase(Color c) : strongSide(c), weakSide(~c) {}
+ virtual ~EndgameBase() = default;
+ virtual T operator()(const Position&) const = 0;
-template<EndgameType>
-struct EvaluationFunction : public EndgameEvaluationFunctionBase {
- typedef EndgameEvaluationFunctionBase Base;
- explicit EvaluationFunction(Color c): EndgameEvaluationFunctionBase(c) {}
- Value apply(const Position&) const;
+ const Color strongSide, weakSide;
};
-template<EndgameType>
-struct ScalingFunction : public EndgameScalingFunctionBase {
- typedef EndgameScalingFunctionBase Base;
- explicit ScalingFunction(Color c) : EndgameScalingFunctionBase(c) {}
- ScaleFactor apply(const Position&) const;
+
+template<EndgameCode E, typename T = eg_type<E>>
+struct Endgame : public EndgameBase<T> {
+
+ explicit Endgame(Color c) : EndgameBase<T>(c) {}
+ T operator()(const Position&) const override;
};
-#endif // !defined(ENDGAME_H_INCLUDED)
+
+/// The Endgames namespace handles the pointers to endgame evaluation and scaling
+/// base objects in two std::map. We use polymorphism to invoke the actual
+/// endgame function by calling its virtual operator().
+
+namespace Endgames {
+
+ template<typename T> using Ptr = std::unique_ptr<EndgameBase<T>>;
+ template<typename T> using Map = std::unordered_map<Key, Ptr<T>>;
+
+ extern std::pair<Map<Value>, Map<ScaleFactor>> maps;
+
+ void init();
+
+ template<typename T>
+ Map<T>& map() {
+ return std::get<std::is_same<T, ScaleFactor>::value>(maps);
+ }
+
+ template<EndgameCode E, typename T = eg_type<E>>
+ void add(const std::string& code) {
+
+ StateInfo st;
+ map<T>()[Position().set(code, WHITE, &st).material_key()] = Ptr<T>(new Endgame<E>(WHITE));
+ map<T>()[Position().set(code, BLACK, &st).material_key()] = Ptr<T>(new Endgame<E>(BLACK));
+ }
+
+ template<typename T>
+ const EndgameBase<T>* probe(Key key) {
+ auto it = map<T>().find(key);
+ return it != map<T>().end() ? it->second.get() : nullptr;
+ }
+}
+
+} // namespace Stockfish
+
+#endif // #ifndef ENDGAME_H_INCLUDED