Program Listing for File is-approx.hpp

↰ Return to documentation for file (include/nanoeigenpy/utils/is-approx.hpp)

#pragma once

#include "nanoeigenpy/fwd.hpp"

#include <Eigen/Core>
#include <Eigen/SparseCore>
#include <nanobind/nanobind.h>

namespace nanoeigenpy {
using namespace nb::literals;

template <typename MatrixOrVectorType1, typename MatrixOrVectorType2>
EIGEN_DONT_INLINE bool is_approx(
    const Eigen::MatrixBase<MatrixOrVectorType1>& mat1,
    const Eigen::MatrixBase<MatrixOrVectorType2>& mat2,
    const typename MatrixOrVectorType1::RealScalar& prec) {
  return mat1.isApprox(mat2, prec);
}

template <typename MatrixOrVectorType1, typename MatrixOrVectorType2>
EIGEN_DONT_INLINE bool is_approx(
    const Eigen::MatrixBase<MatrixOrVectorType1>& mat1,
    const Eigen::MatrixBase<MatrixOrVectorType2>& mat2) {
  return is_approx(
      mat1, mat2,
      Eigen::NumTraits<
          typename MatrixOrVectorType1::RealScalar>::dummy_precision());
}

template <typename MatrixOrVectorType1, typename MatrixOrVectorType2>
EIGEN_DONT_INLINE bool is_approx(
    const Eigen::SparseMatrixBase<MatrixOrVectorType1>& mat1,
    const Eigen::SparseMatrixBase<MatrixOrVectorType2>& mat2,
    const typename MatrixOrVectorType1::RealScalar& prec) {
  return mat1.isApprox(mat2, prec);
}

template <typename MatrixOrVectorType1, typename MatrixOrVectorType2>
EIGEN_DONT_INLINE bool is_approx(
    const Eigen::SparseMatrixBase<MatrixOrVectorType1>& mat1,
    const Eigen::SparseMatrixBase<MatrixOrVectorType2>& mat2) {
  return is_approx(
      mat1, mat2,
      Eigen::NumTraits<
          typename MatrixOrVectorType1::RealScalar>::dummy_precision());
}

namespace nb = nanobind;

template <typename Scalar>
void exposeIsApprox(nb::module_ m) {
  static constexpr int Options = 0;
  using Eigen::Dynamic;
  using MatrixXs = Eigen::Matrix<Scalar, Dynamic, Dynamic, Options>;
  using VectorXs = Eigen::Matrix<Scalar, Dynamic, 1, Options>;
  using RealScalar = typename MatrixXs::RealScalar;

  const RealScalar dummy_precision =
      Eigen::NumTraits<RealScalar>::dummy_precision();

  // is_approx for dense matrices
  m.def(
      "is_approx",
      [](const MatrixXs& mat1, const MatrixXs& mat2, RealScalar precision) {
        return is_approx(mat1, mat2, precision);
      },
      "mat1"_a, "mat2"_a, "precision"_a = dummy_precision,
      "Check if two dense matrices are approximately equal.");

  // is_approx for dense vectors
  m.def(
      "is_approx",
      [](const VectorXs& vec1, const VectorXs& vec2, RealScalar precision) {
        return is_approx(vec1, vec2, precision);
      },
      "vec1"_a, "vec2"_a, "precision"_a = dummy_precision,
      "Check if two dense vectors are approximately equal.");
}

}  // namespace nanoeigenpy