Program Listing for File least-squares-conjugate-gradient.hpp

↰ Return to documentation for file (include/nanoeigenpy/solvers/least-squares-conjugate-gradient.hpp)

#pragma once

#include "nanoeigenpy/fwd.hpp"
#include "nanoeigenpy/solvers/iterative-solver-base.hpp"
#include <nanobind/eigen/dense.h>
#include <Eigen/IterativeLinearSolvers>

namespace nanoeigenpy {

template <typename LeastSquaresConjugateGradient>
struct LeastSquaresConjugateGradientVisitor
    : nb::def_visitor<
          LeastSquaresConjugateGradientVisitor<LeastSquaresConjugateGradient>> {
  using MatrixType = typename LeastSquaresConjugateGradient::MatrixType;
  using CtorArg = nb::DMap<const MatrixType>;

  template <typename... Ts>
  void execute(nb::class_<LeastSquaresConjugateGradient, Ts...>& cl) {
    using namespace nb::literals;
    cl.def(nb::init<>(), "Default constructor.")
        .def(nb::init<CtorArg>(), "A"_a,
             "Initialize the solver with matrix A for further || Ax - b || "
             "solving.\n"
             "This constructor is a shortcut for the default constructor "
             "followed by a call to compute().")
        .def(IterativeSolverVisitor<LeastSquaresConjugateGradient>());
  }

  static void expose(nb::module_& m, const char* name) {
    if (check_registration_alias<LeastSquaresConjugateGradient>(m)) {
      return;
    }
    nb::class_<LeastSquaresConjugateGradient>(m, name)
        .def(LeastSquaresConjugateGradientVisitor<
             LeastSquaresConjugateGradient>())
        .def(IdVisitor());
  }
};

template <typename LeastSquaresConjugateGradient>
void exposeLeastSquaresConjugateGradient(nb::module_& m, const char* name) {
  LeastSquaresConjugateGradientVisitor<LeastSquaresConjugateGradient>::expose(
      m, name);
}

}  // namespace nanoeigenpy