Ensure MathsProvider template arguments are forwarded through ModelT:…

…:parseJson (#150)

* Ensure MathsProvider template arguments are forwarded through ModelT::parseJson

* Apply clang-format

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

RTNeural/ModelT.h

@@ -163,8 +163,8 @@ namespace modelt_detail
         }
     }
 
-    template <typename T, int in_size, int out_size, SampleRateCorrectionMode mode>
-    void loadLayer(GRULayerT<T, in_size, out_size, mode>& gru, int& json_stream_idx, const nlohmann::json& l,
+    template <typename T, int in_size, int out_size, SampleRateCorrectionMode mode, typename MathsProvider>
+    void loadLayer(GRULayerT<T, in_size, out_size, mode, MathsProvider>& gru, int& json_stream_idx, const nlohmann::json& l,
         const std::string& type, int layerDims, bool debug)
     {
         using namespace json_parser;
@@ -179,8 +179,8 @@ namespace modelt_detail
         json_stream_idx++;
     }
 
-    template <typename T, int in_size, int out_size, SampleRateCorrectionMode mode>
-    void loadLayer(LSTMLayerT<T, in_size, out_size, mode>& lstm, int& json_stream_idx, const nlohmann::json& l,
+    template <typename T, int in_size, int out_size, SampleRateCorrectionMode mode, typename MathsProvider>
+    void loadLayer(LSTMLayerT<T, in_size, out_size, mode, MathsProvider>& lstm, int& json_stream_idx, const nlohmann::json& l,
         const std::string& type, int layerDims, bool debug)
     {
         using namespace json_parser;

RTNeural/conv1d/conv1d.tpp

@@ -42,7 +42,7 @@ Conv1D<T>::Conv1D(int in_size, int out_size, int kernel_size, int dilation, int
 template <typename T>
 Conv1D<T>::Conv1D(std::initializer_list<int> sizes)
     : Conv1D<T>(*sizes.begin(), *(sizes.begin() + 1), *(sizes.begin() + 2),
-          *(sizes.begin() + 3), *(sizes.begin() + 4))
+        *(sizes.begin() + 3), *(sizes.begin() + 4))
 {
 }
 

RTNeural/conv1d/conv1d_eigen.tpp

@@ -26,7 +26,7 @@ Conv1D<T>::Conv1D(int in_size, int out_size, int kernel_size, int dilation, int
 template <typename T>
 Conv1D<T>::Conv1D(std::initializer_list<int> sizes)
     : Conv1D<T>(*sizes.begin(), *(sizes.begin() + 1), *(sizes.begin() + 2),
-                *(sizes.begin() + 3), *(sizes.begin() + 4))
+        *(sizes.begin() + 3), *(sizes.begin() + 4))
 {
 }
 

RTNeural/conv1d/conv1d_xsimd.tpp

@@ -24,7 +24,7 @@ Conv1D<T>::Conv1D(int in_size, int out_size, int kernel_size, int dilation, int
 template <typename T>
 Conv1D<T>::Conv1D(std::initializer_list<int> sizes)
     : Conv1D<T>(*sizes.begin(), *(sizes.begin() + 1), *(sizes.begin() + 2),
-          *(sizes.begin() + 3), *(sizes.begin() + 4))
+        *(sizes.begin() + 3), *(sizes.begin() + 4))
 {
 }
 

RTNeural/conv1d/strided_conv1d.h

@@ -33,7 +33,7 @@ class StridedConv1D final : public Layer<T>
 
     StridedConv1D(std::initializer_list<int> sizes)
         : StridedConv1D<T>(*sizes.begin(), *(sizes.begin() + 1), *(sizes.begin() + 2),
-              *(sizes.begin() + 3), *(sizes.begin() + 4), *(sizes.begin() + 5))
+            *(sizes.begin() + 3), *(sizes.begin() + 4), *(sizes.begin() + 5))
     {
     }
 

tests/functional/model_test.cpp

@@ -1,7 +1,7 @@
 #include <gmock/gmock.h>
 
 #include "load_csv.hpp"
-#include <RTNeural/RTNeural.h>
+#include "test_maths_provider.hpp"
 
 using namespace testing;
 
@@ -49,6 +49,21 @@ auto loadTemplatedModel()
     modelT.parseJson(jsonStream, true);
     return modelT;
 }
+
+auto loadTemplatedModelWithMathsProvider()
+{
+    auto modelT = RTNeural::ModelT<TestType, 1, 1,
+        RTNeural::DenseT<TestType, 1, 8>,
+        RTNeural::TanhActivationT<TestType, 8, TestMathsProvider>,
+        RTNeural::Conv1DT<TestType, 8, 4, 3, 2>,
+        RTNeural::TanhActivationT<TestType, 4, TestMathsProvider>,
+        RTNeural::GRULayerT<TestType, 4, 8, RTNeural::SampleRateCorrectionMode::None, TestMathsProvider>,
+        RTNeural::DenseT<TestType, 8, 1>> {};
+
+    std::ifstream jsonStream(model_file, std::ifstream::binary);
+    modelT.parseJson(jsonStream, true);
+    return modelT;
+}
 }
 
 TEST(TestModel, templateModelOutputMatchesDynamicModel)
@@ -67,3 +82,20 @@ TEST(TestModel, templateModelOutputMatchesDynamicModel)
 
     EXPECT_THAT(yData, Pointwise(DoubleNear(threshold), yRefData));
 }
+
+TEST(TestModel, templateModelWithMathsProviderOutputMatchesDynamicModel)
+{
+    constexpr double threshold = 1.0e-12;
+
+    auto xData = loadInputData();
+    auto yRefData = std::vector<TestType>(xData.size(), TestType { 0 });
+    auto yData = std::vector<TestType>(xData.size(), TestType { 0 });
+
+    auto modelRef = loadDynamicModel();
+    processModel(*modelRef.get(), xData, yRefData);
+
+    auto modelT = loadTemplatedModelWithMathsProvider();
+    processModel(modelT, xData, yData);
+
+    EXPECT_THAT(yData, Pointwise(DoubleNear(threshold), yRefData));
+}

tests/functional/templated_tests.cpp

@@ -2,7 +2,7 @@
 
 #include "load_csv.hpp"
 #include "test_configs.hpp"
-#include <RTNeural/RTNeural.h>
+#include "test_maths_provider.hpp"
 
 namespace
 {
@@ -58,6 +58,22 @@ TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForDense)
     runTestTemplated<TestType, ModelType>(tests.at("dense"));
 }
 
+TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForDenseWithMathsProvider)
+{
+    using ModelType = ModelT<TestType, 1, 1,
+        DenseT<TestType, 1, 8>,
+        TanhActivationT<TestType, 8, TestMathsProvider>,
+        DenseT<TestType, 8, 8>,
+        ReLuActivationT<TestType, 8>,
+        DenseT<TestType, 8, 8>,
+        ELuActivationT<TestType, 8, 1, 1, TestMathsProvider>,
+        DenseT<TestType, 8, 8>,
+        SoftmaxActivationT<TestType, 8, TestMathsProvider>,
+        DenseT<TestType, 8, 1>>;
+
+    runTestTemplated<TestType, ModelType>(tests.at("dense"));
+}
+
 TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForConv1D)
 {
     using ModelType = ModelT<TestType, 1, 1,
@@ -92,6 +108,19 @@ TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForGRU)
     runTestTemplated<TestType, ModelType>(tests.at("gru"));
 }
 
+TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForGRUWithMathsProvider)
+{
+    using ModelType = ModelT<TestType, 1, 1,
+        DenseT<TestType, 1, 8>,
+        TanhActivationT<TestType, 8, TestMathsProvider>,
+        GRULayerT<TestType, 8, 8, RTNeural::SampleRateCorrectionMode::None, TestMathsProvider>,
+        DenseT<TestType, 8, 8>,
+        SigmoidActivationT<TestType, 8, TestMathsProvider>,
+        DenseT<TestType, 8, 1>>;
+
+    runTestTemplated<TestType, ModelType>(tests.at("gru"));
+}
+
 TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForGRU1D)
 {
     using ModelType = ModelT<TestType, 1, 1,
@@ -103,6 +132,17 @@ TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForGRU1D)
     runTestTemplated<TestType, ModelType>(tests.at("gru_1d"));
 }
 
+TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForGRU1DWithMathsProvider)
+{
+    using ModelType = ModelT<TestType, 1, 1,
+        GRULayerT<TestType, 1, 8, RTNeural::SampleRateCorrectionMode::None, TestMathsProvider>,
+        DenseT<TestType, 8, 8>,
+        SigmoidActivationT<TestType, 8, TestMathsProvider>,
+        DenseT<TestType, 8, 1>>;
+
+    runTestTemplated<TestType, ModelType>(tests.at("gru_1d"));
+}
+
 TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForLSTM)
 {
     using ModelType = ModelT<TestType, 1, 1,
@@ -114,6 +154,17 @@ TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForLSTM)
     runTestTemplated<TestType, ModelType>(tests.at("lstm"));
 }
 
+TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForLSTMWithMathsProvider)
+{
+    using ModelType = ModelT<TestType, 1, 1,
+        DenseT<TestType, 1, 8>,
+        TanhActivationT<TestType, 8, TestMathsProvider>,
+        LSTMLayerT<TestType, 8, 8, RTNeural::SampleRateCorrectionMode::None, TestMathsProvider>,
+        DenseT<TestType, 8, 1>>;
+
+    runTestTemplated<TestType, ModelType>(tests.at("lstm"));
+}
+
 TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForLSTM1D)
 {
     using ModelType = ModelT<TestType, 1, 1,
@@ -122,3 +173,12 @@ TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForLSTM1D)
 
     runTestTemplated<TestType, ModelType>(tests.at("lstm_1d"));
 }
+
+TEST(TestTemplatedModels, modelOutputMatchesPythonImplementationForLSTM1DWithMathsProvider)
+{
+    using ModelType = ModelT<TestType, 1, 1,
+        LSTMLayerT<TestType, 1, 8, RTNeural::SampleRateCorrectionMode::None, TestMathsProvider>,
+        DenseT<TestType, 8, 1>>;
+
+    runTestTemplated<TestType, ModelType>(tests.at("lstm_1d"));
+}

tests/functional/test_maths_provider.hpp

@@ -0,0 +1,35 @@
+#pragma once
+
+#include <RTNeural/RTNeural.h>
+
+#if RTNEURAL_USE_XSIMD
+struct TestMathsProvider
+{
+    template <typename T>
+    static T tanh(T x) { using std::tanh; using xsimd::tanh; return tanh(x); }
+    template <typename T>
+    static T sigmoid(T x) { using std::exp; using xsimd::exp; return (T)1 / ((T)1 + exp(-x)); }
+    template <typename T>
+    static T exp(T x) { using std::exp; using xsimd::exp; return exp(x); }
+};
+#elif RTNEURAL_USE_EIGEN
+struct TestMathsProvider
+{
+    template <typename Matrix>
+    static auto tanh(const Matrix& x) { return x.array().tanh(); }
+    template <typename Matrix>
+    static auto sigmoid(const Matrix& x) { using T = typename Matrix::Scalar; return (T)1 / (((T)-1 * x.array()).array().exp() + (T)1); }
+    template <typename Matrix>
+    static auto exp(const Matrix& x) { return x.array().exp(); }
+};
+#else
+struct TestMathsProvider
+{
+    template <typename T>
+    static T tanh(T x) { return std::tanh(x); }
+    template <typename T>
+    static T sigmoid(T x) { return (T)1 / ((T)1 + std::exp(-x)); }
+    template <typename T>
+    static T exp(T x) { return std::exp(x); }
+};
+#endif

tests/functional/torch_conv1d_stride_test.cpp

@@ -108,9 +108,9 @@ void testTorchConv1DModelComptime()
         const auto out_idx = (i - start_point) / STRIDE;
 #if RTNEURAL_USE_XSIMD
         int batch_idx = 0;
-        for (auto& batch : model.outs)
+        for(auto& batch : model.outs)
         {
-            batch.store_aligned (outputs[out_idx].data() + batch_idx);
+            batch.store_aligned(outputs[out_idx].data() + batch_idx);
             batch_idx += xsimd::batch<T>::size;
         }
 #else

tests/functional/torch_convtranspose1d_test.cpp

@@ -30,7 +30,7 @@ void testTorchConvTranspose1DModel(const std::string& model_file_path,
     std::ifstream modelInputsFile { std::string { RTNEURAL_ROOT_DIR } + model_input_file_path };
     const auto inputs = RTNeural::torch_helpers::detail::transpose(load_csv::loadFile2d<T>(modelInputsFile));
 #if RTNEURAL_USE_XSIMD
-    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int) xsimd::batch<T>::size) * xsimd::batch<T>::size>;
+    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int)xsimd::batch<T>::size) * xsimd::batch<T>::size>;
     std::vector<Array, xsimd::aligned_allocator<Array>> outputs {};
 #else
     std::vector<std::array<T, OUT_SIZE>> outputs {};
@@ -77,7 +77,7 @@ void testTorchConvTranspose1DModel(const std::string& model_file_path,
 
     for(size_t n = 0; n < expected_y.size(); ++n)
     {
-        for(size_t j = 0; j < (size_t) OUT_SIZE; ++j)
+        for(size_t j = 0; j < (size_t)OUT_SIZE; ++j)
         {
             expectNear(outputs[n][j], expected_y[n][j]);
         }
@@ -101,7 +101,7 @@ void testTorchConvTranspose1DModelComptime(const std::string& model_file_path,
     std::ifstream modelInputsFile { std::string { RTNEURAL_ROOT_DIR } + model_input_file_path };
     const auto inputs = RTNeural::torch_helpers::detail::transpose(load_csv::loadFile2d<T>(modelInputsFile));
 #if RTNEURAL_USE_XSIMD
-    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int) xsimd::batch<T>::size) * xsimd::batch<T>::size>;
+    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int)xsimd::batch<T>::size) * xsimd::batch<T>::size>;
     std::vector<Array, xsimd::aligned_allocator<Array>> outputs {};
 #else
     std::vector<std::array<T, OUT_SIZE>> outputs {};
@@ -207,7 +207,7 @@ void testTorchConvTranspose1DModelComptime(const std::string& model_file_path,
 
     for(size_t n = 0; n < expected_y.size(); ++n)
     {
-        for(size_t j = 0; j < (size_t) OUT_SIZE; ++j)
+        for(size_t j = 0; j < (size_t)OUT_SIZE; ++j)
         {
             expectNear(outputs[n][j], expected_y[n][j]);
         }
@@ -231,7 +231,7 @@ void testStreamingTorchConvTranspose1DModel(const std::string& model_file_path,
     std::ifstream modelInputsFile { std::string { RTNEURAL_ROOT_DIR } + model_input_file_path };
     const auto inputs = RTNeural::torch_helpers::detail::transpose(load_csv::loadFile2d<T>(modelInputsFile));
 #if RTNEURAL_USE_XSIMD
-    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int) xsimd::batch<T>::size) * xsimd::batch<T>::size>;
+    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int)xsimd::batch<T>::size) * xsimd::batch<T>::size>;
     std::vector<Array, xsimd::aligned_allocator<Array>> outputs {};
 #else
     std::vector<std::array<T, OUT_SIZE>> outputs {};
@@ -263,7 +263,7 @@ void testStreamingTorchConvTranspose1DModel(const std::string& model_file_path,
 
     for(size_t n = 0; n < expected_y.size(); ++n)
     {
-        for(size_t j = 0; j < (size_t) OUT_SIZE; ++j)
+        for(size_t j = 0; j < (size_t)OUT_SIZE; ++j)
         {
             expectNear(outputs[n][j], expected_y[n][j]);
         }
@@ -287,7 +287,7 @@ void testStreamingTorchConvTranspose1DModelComptime(const std::string& model_fil
     std::ifstream modelInputsFile { std::string { RTNEURAL_ROOT_DIR } + model_input_file_path };
     const auto inputs = RTNeural::torch_helpers::detail::transpose(load_csv::loadFile2d<T>(modelInputsFile));
 #if RTNEURAL_USE_XSIMD
-    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int) xsimd::batch<T>::size) * xsimd::batch<T>::size>;
+    using Array = std::array<T, RTNeural::ceil_div(OUT_SIZE, (int)xsimd::batch<T>::size) * xsimd::batch<T>::size>;
     std::vector<Array, xsimd::aligned_allocator<Array>> outputs {};
 #else
     std::vector<std::array<T, OUT_SIZE>> outputs {};
@@ -370,7 +370,7 @@ void testStreamingTorchConvTranspose1DModelComptime(const std::string& model_fil
 
     for(size_t n = 0; n < expected_y.size(); ++n)
     {
-        for(size_t j = 0; j < (size_t) OUT_SIZE; ++j)
+        for(size_t j = 0; j < (size_t)OUT_SIZE; ++j)
         {
             expectNear(outputs[n][j], expected_y[n][j]);
         }