NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm > Class Template Reference

Adaptor functor for Eigen::Matrix based residual and Jacobian types. More...

#include <NestedSolve.h>

Public Member Functions
	DynamicMatrixEigenAdaptorFunctor (R &residual_lambda, J &jacobian_lambda)
int	operator() (V &guess, V &residual)
int	df (V &guess, typename NestedSolveTempl< is_ad >::template CorrespondingJacobian< V > &jacobian)
const Real &	getResidualNorm ()

Private Types
using	V = typename NestedSolveTempl< is_ad >::DynamicVector

Private Attributes
R &	_residual_lambda
J &	_jacobian_lambda
Real	_residual_norm

Detailed Description

template<bool is_ad, typename R, typename J, bool store_residual_norm>
class NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >

Adaptor functor for Eigen::Matrix based residual and Jacobian types.

No type conversion required.

Definition at line 624 of file NestedSolve.h.

Member Typedef Documentation

V

template<bool is_ad, typename R, typename J, bool store_residual_norm>

using NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::V = typename NestedSolveTempl<is_ad>::DynamicVector

private

Definition at line 626 of file NestedSolve.h.

Constructor & Destructor Documentation

DynamicMatrixEigenAdaptorFunctor()

template<bool is_ad, typename R, typename J, bool store_residual_norm>

NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::DynamicMatrixEigenAdaptorFunctor ( R &  residual_lambda, J &  jacobian_lambda  )

inline

Definition at line 629 of file NestedSolve.h.

    : _residual_lambda(residual_lambda), _jacobian_lambda(jacobian_lambda)
  {
  }

Member Function Documentation

df()

template<bool is_ad, typename R, typename J, bool store_residual_norm>

int NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::df ( V &  guess, typename NestedSolveTempl< is_ad >::template CorrespondingJacobian< V > &  jacobian  )

inline

Definition at line 640 of file NestedSolve.h.

  {
    _jacobian_lambda(guess, jacobian);
    return 0;
  }

getResidualNorm()

template<bool is_ad, typename R, typename J, bool store_residual_norm>

const Real& NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::getResidualNorm ( )

inline

Definition at line 646 of file NestedSolve.h.

  {
    if constexpr (store_residual_norm)
      return _residual_norm;
  }

operator()()

template<bool is_ad, typename R, typename J, bool store_residual_norm>

int NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::operator() ( V &  guess, V &  residual  )

inline

Definition at line 633 of file NestedSolve.h.

  {
    _residual_lambda(guess, residual);
    if constexpr (store_residual_norm)
      _residual_norm = NestedSolveTempl<is_ad>::normSquare(residual);
    return 0;
  }

Member Data Documentation

_jacobian_lambda

template<bool is_ad, typename R, typename J, bool store_residual_norm>

J& NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::_jacobian_lambda

private

Definition at line 654 of file NestedSolve.h.

Referenced by NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::df().

_residual_lambda

template<bool is_ad, typename R, typename J, bool store_residual_norm>

R& NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::_residual_lambda

private

Definition at line 653 of file NestedSolve.h.

Referenced by NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::operator()().

_residual_norm

template<bool is_ad, typename R, typename J, bool store_residual_norm>

Real NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::_residual_norm

private

Definition at line 656 of file NestedSolve.h.

Referenced by NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::getResidualNorm(), and NestedSolveInternal::DynamicMatrixEigenAdaptorFunctor< is_ad, R, J, store_residual_norm >::operator()().

---

The documentation for this class was generated from the following file:

• include/utils/NestedSolve.h