git.sesse.net Git - stockfish/blob - src/nnue/features/feature_set.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2020 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 // A class template that represents the input feature set of the NNUE evaluation function
  20
  21 #ifndef NNUE_FEATURE_SET_H_INCLUDED
  22 #define NNUE_FEATURE_SET_H_INCLUDED
  23
  24 #include "features_common.h"
  25 #include <array>
  26
  27 namespace Eval::NNUE::Features {
  28
  29   // Class template that represents a list of values
  30   template <typename T, T... Values>
  31   struct CompileTimeList;
  32
  33   template <typename T, T First, T... Remaining>
  34   struct CompileTimeList<T, First, Remaining...> {
  35     static constexpr bool Contains(T value) {
  36       return value == First || CompileTimeList<T, Remaining...>::Contains(value);
  37     }
  38     static constexpr std::array<T, sizeof...(Remaining) + 1>
  39         kValues = {{First, Remaining...}};
  40   };
  41
  42   // Base class of feature set
  43   template <typename Derived>
  44   class FeatureSetBase {
  45
  46    public:
  47     // Get a list of indices for active features
  48     template <typename IndexListType>
  49     static void AppendActiveIndices(
  50         const Position& pos, TriggerEvent trigger, IndexListType active[2]) {
  51
  52       for (Color perspective : { WHITE, BLACK }) {
  53         Derived::CollectActiveIndices(
  54             pos, trigger, perspective, &active[perspective]);
  55       }
  56     }
  57
  58     // Get a list of indices for recently changed features
  59     template <typename PositionType, typename IndexListType>
  60     static void AppendChangedIndices(
  61         const PositionType& pos, TriggerEvent trigger,
  62         IndexListType removed[2], IndexListType added[2], bool reset[2]) {
  63
  64       const auto& dp = pos.state()->dirtyPiece;
  65       if (dp.dirty_num == 0) return;
  66
  67       for (Color perspective : { WHITE, BLACK }) {
  68         reset[perspective] = false;
  69         switch (trigger) {
  70           case TriggerEvent::kFriendKingMoved:
  71             reset[perspective] = dp.piece[0] == make_piece(perspective, KING);
  72             break;
  73           default:
  74             assert(false);
  75             break;
  76         }
  77         if (reset[perspective]) {
  78           Derived::CollectActiveIndices(
  79               pos, trigger, perspective, &added[perspective]);
  80         } else {
  81           Derived::CollectChangedIndices(
  82               pos, trigger, perspective,
  83               &removed[perspective], &added[perspective]);
  84         }
  85       }
  86     }
  87   };
  88
  89   // Class template that represents the feature set
  90   template <typename FeatureType>
  91   class FeatureSet<FeatureType> : public FeatureSetBase<FeatureSet<FeatureType>> {
  92
  93    public:
  94     // Hash value embedded in the evaluation file
  95     static constexpr std::uint32_t kHashValue = FeatureType::kHashValue;
  96     // Number of feature dimensions
  97     static constexpr IndexType kDimensions = FeatureType::kDimensions;
  98     // Maximum number of simultaneously active features
  99     static constexpr IndexType kMaxActiveDimensions =
 100         FeatureType::kMaxActiveDimensions;
 101     // Trigger for full calculation instead of difference calculation
 102     using SortedTriggerSet =
 103         CompileTimeList<TriggerEvent, FeatureType::kRefreshTrigger>;
 104     static constexpr auto kRefreshTriggers = SortedTriggerSet::kValues;
 105
 106    private:
 107     // Get a list of indices for active features
 108     static void CollectActiveIndices(
 109         const Position& pos, const TriggerEvent trigger, const Color perspective,
 110         IndexList* const active) {
 111       if (FeatureType::kRefreshTrigger == trigger) {
 112         FeatureType::AppendActiveIndices(pos, perspective, active);
 113       }
 114     }
 115
 116     // Get a list of indices for recently changed features
 117     static void CollectChangedIndices(
 118         const Position& pos, const TriggerEvent trigger, const Color perspective,
 119         IndexList* const removed, IndexList* const added) {
 120
 121       if (FeatureType::kRefreshTrigger == trigger) {
 122         FeatureType::AppendChangedIndices(pos, perspective, removed, added);
 123       }
 124     }
 125
 126     // Make the base class and the class template that recursively uses itself a friend
 127     friend class FeatureSetBase<FeatureSet>;
 128     template <typename... FeatureTypes>
 129     friend class FeatureSet;
 130   };
 131
 132 }  // namespace Eval::NNUE::Features
 133
 134 #endif // #ifndef NNUE_FEATURE_SET_H_INCLUDED