git.sesse.net Git - stockfish/blob - src/nnue/features/half_ka_v2_hm.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 //Definition of input features HalfKP of NNUE evaluation function
  20
  21 #ifndef NNUE_FEATURES_HALF_KA_V2_HM_H_INCLUDED
  22 #define NNUE_FEATURES_HALF_KA_V2_HM_H_INCLUDED
  23
  24 #include <cstdint>
  25
  26 #include "../../misc.h"
  27 #include "../../types.h"
  28 #include "../nnue_common.h"
  29
  30 namespace Stockfish {
  31 struct StateInfo;
  32 class Position;
  33 }
  34
  35 namespace Stockfish::Eval::NNUE::Features {
  36
  37 // Feature HalfKAv2_hm: Combination of the position of own king
  38 // and the position of pieces. Position mirrored such that king always on e..h files.
  39 class HalfKAv2_hm {
  40
  41     // unique number for each piece type on each square
  42     enum {
  43         PS_NONE     = 0,
  44         PS_W_PAWN   = 0,
  45         PS_B_PAWN   = 1 * SQUARE_NB,
  46         PS_W_KNIGHT = 2 * SQUARE_NB,
  47         PS_B_KNIGHT = 3 * SQUARE_NB,
  48         PS_W_BISHOP = 4 * SQUARE_NB,
  49         PS_B_BISHOP = 5 * SQUARE_NB,
  50         PS_W_ROOK   = 6 * SQUARE_NB,
  51         PS_B_ROOK   = 7 * SQUARE_NB,
  52         PS_W_QUEEN  = 8 * SQUARE_NB,
  53         PS_B_QUEEN  = 9 * SQUARE_NB,
  54         PS_KING     = 10 * SQUARE_NB,
  55         PS_NB       = 11 * SQUARE_NB
  56     };
  57
  58     static constexpr IndexType PieceSquareIndex[COLOR_NB][PIECE_NB] = {
  59       // convention: W - us, B - them
  60       // viewed from other side, W and B are reversed
  61       {PS_NONE, PS_W_PAWN, PS_W_KNIGHT, PS_W_BISHOP, PS_W_ROOK, PS_W_QUEEN, PS_KING, PS_NONE,
  62        PS_NONE, PS_B_PAWN, PS_B_KNIGHT, PS_B_BISHOP, PS_B_ROOK, PS_B_QUEEN, PS_KING, PS_NONE},
  63       {PS_NONE, PS_B_PAWN, PS_B_KNIGHT, PS_B_BISHOP, PS_B_ROOK, PS_B_QUEEN, PS_KING, PS_NONE,
  64        PS_NONE, PS_W_PAWN, PS_W_KNIGHT, PS_W_BISHOP, PS_W_ROOK, PS_W_QUEEN, PS_KING, PS_NONE}};
  65
  66     // Index of a feature for a given king position and another piece on some square
  67     template<Color Perspective>
  68     static IndexType make_index(Square s, Piece pc, Square ksq);
  69
  70    public:
  71     // Feature name
  72     static constexpr const char* Name = "HalfKAv2_hm(Friend)";
  73
  74     // Hash value embedded in the evaluation file
  75     static constexpr std::uint32_t HashValue = 0x7f234cb8u;
  76
  77     // Number of feature dimensions
  78     static constexpr IndexType Dimensions =
  79       static_cast<IndexType>(SQUARE_NB) * static_cast<IndexType>(PS_NB) / 2;
  80
  81 #define B(v) (v * PS_NB)
  82     // clang-format off
  83     static constexpr int KingBuckets[COLOR_NB][SQUARE_NB] = {
  84       { B(28), B(29), B(30), B(31), B(31), B(30), B(29), B(28),
  85         B(24), B(25), B(26), B(27), B(27), B(26), B(25), B(24),
  86         B(20), B(21), B(22), B(23), B(23), B(22), B(21), B(20),
  87         B(16), B(17), B(18), B(19), B(19), B(18), B(17), B(16),
  88         B(12), B(13), B(14), B(15), B(15), B(14), B(13), B(12),
  89         B( 8), B( 9), B(10), B(11), B(11), B(10), B( 9), B( 8),
  90         B( 4), B( 5), B( 6), B( 7), B( 7), B( 6), B( 5), B( 4),
  91         B( 0), B( 1), B( 2), B( 3), B( 3), B( 2), B( 1), B( 0) },
  92       { B( 0), B( 1), B( 2), B( 3), B( 3), B( 2), B( 1), B( 0),
  93         B( 4), B( 5), B( 6), B( 7), B( 7), B( 6), B( 5), B( 4),
  94         B( 8), B( 9), B(10), B(11), B(11), B(10), B( 9), B( 8),
  95         B(12), B(13), B(14), B(15), B(15), B(14), B(13), B(12),
  96         B(16), B(17), B(18), B(19), B(19), B(18), B(17), B(16),
  97         B(20), B(21), B(22), B(23), B(23), B(22), B(21), B(20),
  98         B(24), B(25), B(26), B(27), B(27), B(26), B(25), B(24),
  99         B(28), B(29), B(30), B(31), B(31), B(30), B(29), B(28) }
 100     };
 101     // clang-format on
 102 #undef B
 103     // clang-format off
 104     // Orient a square according to perspective (rotates by 180 for black)
 105     static constexpr int OrientTBL[COLOR_NB][SQUARE_NB] = {
 106       { SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 107         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 108         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 109         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 110         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 111         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 112         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1,
 113         SQ_H1, SQ_H1, SQ_H1, SQ_H1, SQ_A1, SQ_A1, SQ_A1, SQ_A1 },
 114       { SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 115         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 116         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 117         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 118         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 119         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 120         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8,
 121         SQ_H8, SQ_H8, SQ_H8, SQ_H8, SQ_A8, SQ_A8, SQ_A8, SQ_A8 }
 122     };
 123     // clang-format on
 124
 125     // Maximum number of simultaneously active features.
 126     static constexpr IndexType MaxActiveDimensions = 32;
 127     using IndexList                                = ValueList<IndexType, MaxActiveDimensions>;
 128
 129     // Get a list of indices for active features
 130     template<Color Perspective>
 131     static void append_active_indices(const Position& pos, IndexList& active);
 132
 133     // Get a list of indices for recently changed features
 134     template<Color Perspective>
 135     static void
 136     append_changed_indices(Square ksq, const DirtyPiece& dp, IndexList& removed, IndexList& added);
 137
 138     // Returns the cost of updating one perspective, the most costly one.
 139     // Assumes no refresh needed.
 140     static int update_cost(const StateInfo* st);
 141     static int refresh_cost(const Position& pos);
 142
 143     // Returns whether the change stored in this StateInfo means that
 144     // a full accumulator refresh is required.
 145     static bool requires_refresh(const StateInfo* st, Color perspective);
 146 };
 147
 148 }  // namespace Stockfish::Eval::NNUE::Features
 149
 150 #endif  // #ifndef NNUE_FEATURES_HALF_KA_V2_HM_H_INCLUDED