Eigen::HybridNonLinearSolver< FunctorType, Scalar > Class Template Reference

---

Detailed Description

template<typename FunctorType, typename Scalar = double>
class Eigen::HybridNonLinearSolver< FunctorType, Scalar >

Finds a zero of a system of n nonlinear functions in n variables by a modification of the Powell hybrid method ("dogleg").

The user must provide a subroutine which calculates the functions. The Jacobian is either provided by the user, or approximated using a forward-difference method.

Definition at line 57 of file NonLinearOptimization.

List of all members.

Classes
struct	Parameters
Public Types
typedef DenseIndex	Index
typedef Matrix< Scalar, Dynamic, 1 >	FVectorType
typedef Matrix< Scalar, Dynamic, Dynamic >	JacobianType
typedef Matrix< Scalar, Dynamic, Dynamic >	UpperTriangularType
Public Member Functions
	HybridNonLinearSolver (FunctorType &_functor)
HybridNonLinearSolverSpace::Status	hybrj1 (FVectorType &x, const Scalar tol=internal::sqrt(NumTraits< Scalar >::epsilon()))
HybridNonLinearSolverSpace::Status	solveInit (FVectorType &x)
HybridNonLinearSolverSpace::Status	solveOneStep (FVectorType &x)
HybridNonLinearSolverSpace::Status	solve (FVectorType &x)
HybridNonLinearSolverSpace::Status	hybrd1 (FVectorType &x, const Scalar tol=internal::sqrt(NumTraits< Scalar >::epsilon()))
HybridNonLinearSolverSpace::Status	solveNumericalDiffInit (FVectorType &x)
HybridNonLinearSolverSpace::Status	solveNumericalDiffOneStep (FVectorType &x)
HybridNonLinearSolverSpace::Status	solveNumericalDiff (FVectorType &x)
void	resetParameters (void)
Public Attributes
Parameters	parameters
FVectorType	fvec
FVectorType	qtf
FVectorType	diag
JacobianType	fjac
UpperTriangularType	R
Index	nfev
Index	njev
Index	iter
Scalar	fnorm
bool	useExternalScaling
Private Member Functions
HybridNonLinearSolver &	operator= (const HybridNonLinearSolver &)
Private Attributes
FunctorType &	functor
Index	n
Scalar	sum
bool	sing
Scalar	temp
Scalar	delta
bool	jeval
Index	ncsuc
Scalar	ratio
Scalar	pnorm
Scalar	xnorm
Scalar	fnorm1
Index	nslow1
Index	nslow2
Index	ncfail
Scalar	actred
Scalar	prered
FVectorType	wa1
FVectorType	wa2
FVectorType	wa3
FVectorType	wa4

---

Member Typedef Documentation

template<typename FunctorType , typename Scalar = double>

typedef Matrix< Scalar, Dynamic, 1 > Eigen::HybridNonLinearSolver< FunctorType, Scalar >::FVectorType

Definition at line 80 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

typedef DenseIndex Eigen::HybridNonLinearSolver< FunctorType, Scalar >::Index

Definition at line 60 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

typedef Matrix< Scalar, Dynamic, Dynamic > Eigen::HybridNonLinearSolver< FunctorType, Scalar >::JacobianType

Definition at line 81 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

typedef Matrix< Scalar, Dynamic, Dynamic > Eigen::HybridNonLinearSolver< FunctorType, Scalar >::UpperTriangularType

Definition at line 83 of file NonLinearOptimization.

---

Constructor & Destructor Documentation

template<typename FunctorType , typename Scalar = double>

Eigen::HybridNonLinearSolver< FunctorType, Scalar >::HybridNonLinearSolver

(

FunctorType &

_functor

)

[inline]

Definition at line 62 of file NonLinearOptimization.

---

Member Function Documentation

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::hybrd1	(	FVectorType &	x,
		const Scalar	tol = internal::sqrt(NumTraits<Scalar>::epsilon())
	)

Definition at line 370 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::hybrj1	(	FVectorType &	x,
		const Scalar	tol = internal::sqrt(NumTraits<Scalar>::epsilon())
	)

Definition at line 136 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

HybridNonLinearSolver& Eigen::HybridNonLinearSolver< FunctorType, Scalar >::operator=

(

const HybridNonLinearSolver< FunctorType, Scalar > &

)

[private]

template<typename FunctorType , typename Scalar = double>

void Eigen::HybridNonLinearSolver< FunctorType, Scalar >::resetParameters

(

void

)

[inline]

Definition at line 103 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::solve

(

FVectorType &

x

)

Definition at line 356 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::solveInit

(

FVectorType &

x

)

Definition at line 157 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::solveNumericalDiff

(

FVectorType &

x

)

Definition at line 596 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::solveNumericalDiffInit

(

FVectorType &

x

)

Definition at line 392 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::solveNumericalDiffOneStep

(

FVectorType &

x

)

Definition at line 438 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar >

HybridNonLinearSolverSpace::Status Eigen::HybridNonLinearSolver< FunctorType, Scalar >::solveOneStep

(

FVectorType &

x

)

Definition at line 200 of file NonLinearOptimization.

---

Member Data Documentation

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::actred [private]

Definition at line 126 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::delta [private]

Definition at line 119 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::diag

Definition at line 105 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

JacobianType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::fjac

Definition at line 106 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::fnorm

Definition at line 111 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::fnorm1 [private]

Definition at line 123 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FunctorType& Eigen::HybridNonLinearSolver< FunctorType, Scalar >::functor [private]

Definition at line 114 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::fvec

Definition at line 105 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::iter

Definition at line 110 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

bool Eigen::HybridNonLinearSolver< FunctorType, Scalar >::jeval [private]

Definition at line 120 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::n [private]

Definition at line 115 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::ncfail [private]

Definition at line 125 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::ncsuc [private]

Definition at line 121 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::nfev

Definition at line 108 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::njev

Definition at line 109 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::nslow1 [private]

Definition at line 124 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Index Eigen::HybridNonLinearSolver< FunctorType, Scalar >::nslow2 [private]

Definition at line 124 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Parameters Eigen::HybridNonLinearSolver< FunctorType, Scalar >::parameters

Definition at line 104 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::pnorm [private]

Definition at line 123 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::prered [private]

Definition at line 126 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::qtf

Definition at line 105 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

UpperTriangularType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::R

Definition at line 107 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::ratio [private]

Definition at line 122 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

bool Eigen::HybridNonLinearSolver< FunctorType, Scalar >::sing [private]

Definition at line 117 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::sum [private]

Definition at line 116 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::temp [private]

Definition at line 118 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

bool Eigen::HybridNonLinearSolver< FunctorType, Scalar >::useExternalScaling

Definition at line 112 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::wa1 [private]

Definition at line 127 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::wa2 [private]

Definition at line 127 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::wa3 [private]

Definition at line 127 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

FVectorType Eigen::HybridNonLinearSolver< FunctorType, Scalar >::wa4 [private]

Definition at line 127 of file NonLinearOptimization.

template<typename FunctorType , typename Scalar = double>

Scalar Eigen::HybridNonLinearSolver< FunctorType, Scalar >::xnorm [private]

Definition at line 123 of file NonLinearOptimization.