eigen-tensor.gtest.hpp

Go to the documentation of this file.

/* This file is part of OpenKalman, a header-only C++ library for
 * Kalman filters and other recursive filters.
 *
 * Copyright (c) 2023 Christopher Lee Ogden <ogden@gatech.edu>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

#ifndef EIGEN_TENSOR_GTEST_HPP
#define EIGEN_TENSOR_GTEST_HPP

#include "linear-algebra/interfaces/eigen-tensor/eigen-tensor.hpp"
#include "linear-algebra/interfaces/eigen/tests/eigen.gtest.hpp"

namespace OpenKalman::test
{

#ifdef __cpp_concepts
  template<Eigen3::eigen_tensor_general Arg1, Eigen3::eigen_tensor_general Arg2, typename Err> requires
    (Eigen3::eigen_tensor_general<Arg1, true> or Eigen3::eigen_tensor_general<Arg2, true>) and
    (std::is_arithmetic_v<Err> or Eigen3::eigen_tensor_general<Err>)
  struct TestComparison<Arg1, Arg2, Err>
#else
  template<typename Arg1, typename Arg2, typename Err>
  struct TestComparison<Arg1, Arg2, Err, std::enable_if_t<
    Eigen3::eigen_tensor_general<Arg1> and Eigen3::eigen_tensor_general<Arg2> and
    (Eigen3::eigen_tensor_general<Arg1, true> or Eigen3::eigen_tensor_general<Arg2, true>) and
    (std::is_arithmetic_v<Err> or Eigen3::eigen_tensor_general<Err>)>>
#endif
    : ::testing::AssertionResult
  {

  private:

    static ::testing::AssertionResult
    compare(const Arg1& arg1, const Arg2& arg2, const Err& err)
    {
      using Scalar = scalar_type_of_t<Arg1>;
      auto diff = arg1 - arg2;
      using T0 = Eigen::Tensor<Scalar, 0>;
      if constexpr (std::is_arithmetic_v<Err>)
      {
        auto lhs = T0{(diff.square()).sum()}.coeff(0);
        auto sum1 = T0{(arg1.square()).sum()}.coeff(0);
        auto sum2 = T0{(arg2.square()).sum()}.coeff(0);
        auto err2 = err * err;
        auto rhs = err2 * std::min(sum1, sum2);
        if (lhs <= rhs or (sum1 <= err2 and sum2 <= err2))
        {
          return ::testing::AssertionSuccess();
        }
      }
      else
      {
        if (T0{(diff.abs() - err).maximum()}.coeff(0) <= 0)
        {
          return ::testing::AssertionSuccess();
        }
      }

      return ::testing::AssertionFailure() << std::endl << arg1 << std::endl << "is not near" << std::endl <<
        arg2 << std::endl;
    }

  public:

    TestComparison(const Arg1& arg1, const Arg2& arg2, const Err& err)
      : ::testing::AssertionResult {compare(arg1, arg2, err)} {};

   };


#ifdef __cpp_concepts
  template<typename Arg1, typename Arg2, typename Err> requires
    (not Eigen3::eigen_tensor_general<Arg1> or not Eigen3::eigen_tensor_general<Arg2>) and
    (Eigen3::eigen_tensor_general<Arg1, true> or Eigen3::eigen_tensor_general<Arg2, true>) and
    (Eigen3::eigen_tensor_general<Arg1> or Eigen3::eigen_general<Arg1>) and
    (Eigen3::eigen_tensor_general<Arg2> or Eigen3::eigen_general<Arg2>) and
    (std::is_arithmetic_v<Err> or Eigen3::eigen_tensor_general<Err>)
  struct TestComparison<Arg1, Arg2, Err>
#else
  template<typename Arg1, typename Arg2, typename Err>
  struct TestComparison<Arg1, Arg2, Err, std::enable_if_t<
    (not Eigen3::eigen_tensor_general<Arg1> or not Eigen3::eigen_tensor_general<Arg2>) and
    (Eigen3::eigen_tensor_general<Arg1, true> or Eigen3::eigen_tensor_general<Arg2, true>) and
    (Eigen3::eigen_tensor_general<Arg1> or Eigen3::eigen_general<Arg1>) and
    (Eigen3::eigen_tensor_general<Arg2> or Eigen3::eigen_general<Arg2>) and
    (std::is_arithmetic_v<Err> or Eigen3::eigen_tensor_general<Err>)>>
#endif
    : ::testing::AssertionResult
  {
  private:

    using A = std::conditional_t<Eigen3::eigen_tensor_general<Arg1, true>, Arg1, Arg2>;

  public:
    TestComparison(const Arg1& arg1, const Arg2& arg2, const Err& err)
      : ::testing::AssertionResult {is_near(to_native_matrix<A>(arg1), to_native_matrix<A>(arg2), err)} {};

  };


} // namespace OpenKalman::test

#endif //EIGEN_TENSOR_GTEST_HPP