newton_argument< _Scalar, NX, NY > Class Template Reference

Template object created to solve non linear problems using the Eigen library. More...

#include <newton_argument.H>

Public Types
enum	{ InputsAtCompileTime = NX , ValuesAtCompileTime = NY }
typedef _Scalar	Scalar
typedef Eigen::Matrix< Scalar, InputsAtCompileTime, 1 >	InputType
typedef Eigen::Matrix< Scalar, ValuesAtCompileTime, 1 >	ValueType
typedef Eigen::Matrix< Scalar, ValuesAtCompileTime, InputsAtCompileTime >	JacobianType

Public Member Functions
	newton_argument ()
	Constructor.
	newton_argument (int inputs, int values)
	Constructor.
int	operator() (const Eigen::VectorXd &x, Eigen::VectorXd &fvec) const
	Operator to compute the residual vector.
int	df (const Eigen::VectorXd &x, Eigen::VectorXd &fvec) const
	Operator to compute the jacobian matrix.
int	inputs () const
	Return the inputs.
int	values () const
	Return the values.

Public Attributes
int	m_inputs
int	m_values

Detailed Description

template<typename _Scalar, int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>
class newton_argument< _Scalar, NX, NY >

Template object created to solve non linear problems using the Eigen library.

Definition at line 44 of file newton_argument.H.

Member Typedef Documentation

InputType

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

typedef Eigen::Matrix<Scalar, InputsAtCompileTime, 1> newton_argument< _Scalar, NX, NY >::InputType

Definition at line 53 of file newton_argument.H.

JacobianType

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

typedef Eigen::Matrix<Scalar, ValuesAtCompileTime, InputsAtCompileTime> newton_argument< _Scalar, NX, NY >::JacobianType

Definition at line 56 of file newton_argument.H.

Scalar

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

typedef _Scalar newton_argument< _Scalar, NX, NY >::Scalar

Definition at line 47 of file newton_argument.H.

ValueType

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

typedef Eigen::Matrix<Scalar, ValuesAtCompileTime, 1> newton_argument< _Scalar, NX, NY >::ValueType

Definition at line 54 of file newton_argument.H.

Member Enumeration Documentation

anonymous enum

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

anonymous enum

Enumerator
InputsAtCompileTime
ValuesAtCompileTime

Definition at line 48 of file newton_argument.H.

Constructor & Destructor Documentation

newton_argument() [1/2]

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

newton_argument< _Scalar, NX, NY >::newton_argument ( )

inline

Constructor.

Definition at line 63 of file newton_argument.H.

newton_argument() [2/2]

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

newton_argument< _Scalar, NX, NY >::newton_argument ( int inputs, int values )

inline

Constructor.

Parameters

[in]	inputs	The inputs
[in]	values	The values

Definition at line 71 of file newton_argument.H.

Member Function Documentation

df()

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

int newton_argument< _Scalar, NX, NY >::df ( const Eigen::VectorXd & x, Eigen::VectorXd & fvec ) const

inline

Operator to compute the jacobian matrix.

Parameters

[in]	x	The x value used to compute the jacobian
	fvec	The jacobian vector

Returns

0

Definition at line 96 of file newton_argument.H.

inputs()

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

int newton_argument< _Scalar, NX, NY >::inputs ( ) const

inline

Return the inputs.

Returns

inputs

Definition at line 108 of file newton_argument.H.

operator()()

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

int newton_argument< _Scalar, NX, NY >::operator() ( const Eigen::VectorXd & x, Eigen::VectorXd & fvec ) const

inline

Operator to compute the residual vector.

Parameters

[in]	x	The x value used to compute the residual
	fvec	The residual vector

Returns

0

Definition at line 81 of file newton_argument.H.

values()

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

int newton_argument< _Scalar, NX, NY >::values ( ) const

inline

Return the values.

Returns

inputs

Definition at line 118 of file newton_argument.H.

Member Data Documentation

m_inputs

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

int newton_argument< _Scalar, NX, NY >::m_inputs

Definition at line 58 of file newton_argument.H.

m_values

template<typename _Scalar , int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>

int newton_argument< _Scalar, NX, NY >::m_values

Definition at line 58 of file newton_argument.H.

---

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

• /github/workspace/src/ITHACA_ROMPROBLEMS/NonLinearSolvers/newton_argument.H