roboptim::NagSolverCommon< T > Class Template Reference

NAG common solver. More...

#include <roboptim/core/plugin/nag/nag-common.hh>

Inheritance diagram for roboptim::NagSolverCommon< T >:

List of all members.

Public Types
enum	ConstraintType {   LINEAR = 0,   NONLINEAR = 1 }
	Categorize constraints. More...
typedef Solver< T >	solver_t
	Parent type (solver).
typedef solver_t::problem_t	problem_t
	Problem type.
Public Member Functions
	NagSolverCommon (const problem_t &pb)
	Instantiate the solver from a problem.
virtual	~NagSolverCommon ()
Protected Member Functions
void	initializeParameters ()
	Initialize parameters.
void	updateParameters (Nag_E04State *state, NagError *fail)
	Read parameters and update associated options in NAG.

---

Detailed Description

template<typename T>
class roboptim::NagSolverCommon< T >

NAG common solver.

This solver shares common piece of code of the different NAG solvers.

---

Member Typedef Documentation

template<typename T>

typedef solver_t::problem_t roboptim::NagSolverCommon< T >::problem_t

Problem type.

template<typename T>

typedef Solver<T> roboptim::NagSolverCommon< T >::solver_t

Parent type (solver).

---

Member Enumeration Documentation

template<typename T>

enum roboptim::NagSolverCommon::ConstraintType

Categorize constraints.

Used with the which method of the Boost.Variant, it allows to check for a constraint's real type.

Warning:

Make sure to keep enum values in the same order than the MPL vector used to specify CLIST.

Enumerator:

LINEAR	Constraint is a linear function.
NONLINEAR	Constraint is a differentiable or a twice differentiable function depending on the solve.

---

Constructor & Destructor Documentation

template<typename T >

roboptim::NagSolverCommon< T >::NagSolverCommon

(

const problem_t &

pb

)

[explicit]

Instantiate the solver from a problem.

Parameters:

problem

problem that will be solved

template<typename T >

roboptim::NagSolverCommon< T >::~NagSolverCommon

(

)

[virtual]

---

Member Function Documentation

template<typename T >

void roboptim::NagSolverCommon< T >::initializeParameters

(

)

[protected]

Initialize parameters.

Add solver parameters. Called during construction.

References DEFINE_PARAMETER.

template<typename T >

void roboptim::NagSolverCommon< T >::updateParameters	(	Nag_E04State *	state,
		NagError *	fail
	)		[protected]

Read parameters and update associated options in NAG.

Called before solving problem.

Parameters:

state	internal information required for NAG functions.
fail	NAG error argument