SimTK::Optimizer::OptimizerRep Class Reference

#include <OptimizerRep.h>

Inheritance diagram for SimTK::Optimizer::OptimizerRep:

List of all members.

Public Member Functions
virtual	~OptimizerRep ()
	OptimizerRep (const OptimizerSystem &sys)
	OptimizerRep ()
virtual OptimizerRep *	clone () const
virtual Real	optimize (Vector &results)=0
const OptimizerSystem &	getOptimizerSystem () const
void	setDiagnosticsLevel (const int level)
void	setConvergenceTolerance (Real accuracy)
void	setConstraintTolerance (Real tolerance)
void	setMaxIterations (const int iter)
void	setLimitedMemoryHistory (const int history)
bool	setAdvancedStrOption (const std::string &option, const std::string &value)
bool	setAdvancedRealOption (const std::string &option, const Real value)
bool	setAdvancedIntOption (const std::string &option, const int value)
bool	setAdvancedBoolOption (const std::string &option, const bool value)
bool	getAdvancedStrOption (const std::string &option, std::string &value) const
bool	getAdvancedRealOption (const std::string &option, Real &value) const
bool	getAdvancedIntOption (const std::string &option, int &value) const
bool	getAdvancedBoolOption (const std::string &option, bool &value) const
void	setMyHandle (Optimizer &cp)
const Optimizer &	getMyHandle () const
void	clearMyHandle ()
void	useNumericalGradient (bool flag, Real objEstAccuracy)
void	useNumericalJacobian (bool flag, Real consEstAccuracy)
void	setDifferentiatorMethod (Differentiator::Method method)
bool	isUsingNumericalGradient () const
bool	isUsingNumericalJacobian () const
Differentiator::Method	getDifferentiatorMethod () const
Real	getEstimatedAccuracyOfObjective () const
Real	getEstimatedAccuracyOfConstraints () const
const Differentiator &	getGradientDifferentiator () const
const Differentiator &	getJacobianDifferentiator () const
Static Public Member Functions
static bool	isAvailable ()
static int	numericalGradient_static (const OptimizerSystem &, const Vector &parameters, const bool new_parameters, Vector &gradient)
static int	numericalJacobian_static (const OptimizerSystem &, const Vector &parameters, const bool new_parameters, Matrix &jacobian)
Static Protected Member Functions
static int	objectiveFuncWrapper (int n, const Real *x, int new_x, Real *f, void *rep)
static int	gradientFuncWrapper (int n, const Real *x, int new_x, Real *gradient, void *rep)
static int	constraintFuncWrapper (int n, const Real *x, int new_x, int m, Real *g, void *rep)
static int	constraintJacobianWrapper (int n, const Real *x, int new_x, int m, int nele_jac, int *iRow, int *jCol, Real *values, void *rep)
static int	hessianWrapper (int n, const Real *x, int new_x, Real obj_factor, int m, Real *lambda, int new_lambda, int nele_hess, int *iRow, int *jCol, Real *values, void *rep)
Protected Attributes
int	diagnosticsLevel
Real	convergenceTolerance
Real	constraintTolerance
int	maxIterations
int	limitedMemoryHistory
Differentiator::Method	diffMethod
Real	objectiveEstimatedAccuracy
Real	constraintsEstimatedAccuracy
Friends
class	Optimizer

---

Constructor & Destructor Documentation

virtual SimTK::Optimizer::OptimizerRep::~OptimizerRep

(

)

[virtual]

SimTK::Optimizer::OptimizerRep::OptimizerRep

(

const OptimizerSystem &

sys

)

[inline]

SimTK::Optimizer::OptimizerRep::OptimizerRep

(

)

[inline]

---

Member Function Documentation

virtual OptimizerRep* SimTK::Optimizer::OptimizerRep::clone

(

)

const [inline, virtual]

static bool SimTK::Optimizer::OptimizerRep::isAvailable

(

)

[inline, static]

virtual Real SimTK::Optimizer::OptimizerRep::optimize

(

Vector &

results

)

[pure virtual]

const OptimizerSystem& SimTK::Optimizer::OptimizerRep::getOptimizerSystem

(

)

const [inline]

void SimTK::Optimizer::OptimizerRep::setDiagnosticsLevel

(

const int

level

)

void SimTK::Optimizer::OptimizerRep::setConvergenceTolerance

(

Real

accuracy

)

void SimTK::Optimizer::OptimizerRep::setConstraintTolerance

(

Real

tolerance

)

void SimTK::Optimizer::OptimizerRep::setMaxIterations

(

const int

iter

)

void SimTK::Optimizer::OptimizerRep::setLimitedMemoryHistory

(

const int

history

)

bool SimTK::Optimizer::OptimizerRep::setAdvancedStrOption	(	const std::string &	option,
		const std::string &	value
	)

bool SimTK::Optimizer::OptimizerRep::setAdvancedRealOption	(	const std::string &	option,
		const Real	value
	)

bool SimTK::Optimizer::OptimizerRep::setAdvancedIntOption	(	const std::string &	option,
		const int	value
	)

bool SimTK::Optimizer::OptimizerRep::setAdvancedBoolOption	(	const std::string &	option,
		const bool	value
	)

bool SimTK::Optimizer::OptimizerRep::getAdvancedStrOption	(	const std::string &	option,
		std::string &	value
	)		const

bool SimTK::Optimizer::OptimizerRep::getAdvancedRealOption	(	const std::string &	option,
		Real &	value
	)		const

bool SimTK::Optimizer::OptimizerRep::getAdvancedIntOption	(	const std::string &	option,
		int &	value
	)		const

bool SimTK::Optimizer::OptimizerRep::getAdvancedBoolOption	(	const std::string &	option,
		bool &	value
	)		const

void SimTK::Optimizer::OptimizerRep::setMyHandle

(

Optimizer &

cp

)

[inline]

const Optimizer& SimTK::Optimizer::OptimizerRep::getMyHandle

(

)

const [inline]

void SimTK::Optimizer::OptimizerRep::clearMyHandle

(

)

[inline]

void SimTK::Optimizer::OptimizerRep::useNumericalGradient	(	bool	flag,
		Real	objEstAccuracy
	)

void SimTK::Optimizer::OptimizerRep::useNumericalJacobian	(	bool	flag,
		Real	consEstAccuracy
	)

void SimTK::Optimizer::OptimizerRep::setDifferentiatorMethod

(

Differentiator::Method

method

)

bool SimTK::Optimizer::OptimizerRep::isUsingNumericalGradient

(

)

const [inline]

bool SimTK::Optimizer::OptimizerRep::isUsingNumericalJacobian

(

)

const [inline]

Differentiator::Method SimTK::Optimizer::OptimizerRep::getDifferentiatorMethod

(

)

const [inline]

Real SimTK::Optimizer::OptimizerRep::getEstimatedAccuracyOfObjective

(

)

const [inline]

Real SimTK::Optimizer::OptimizerRep::getEstimatedAccuracyOfConstraints

(

)

const [inline]

const Differentiator& SimTK::Optimizer::OptimizerRep::getGradientDifferentiator

(

)

const [inline]

const Differentiator& SimTK::Optimizer::OptimizerRep::getJacobianDifferentiator

(

)

const [inline]

static int SimTK::Optimizer::OptimizerRep::numericalGradient_static	(	const OptimizerSystem &	,
		const Vector &	parameters,
		const bool	new_parameters,
		Vector &	gradient
	)		[static]

static int SimTK::Optimizer::OptimizerRep::numericalJacobian_static	(	const OptimizerSystem &	,
		const Vector &	parameters,
		const bool	new_parameters,
		Matrix &	jacobian
	)		[static]

static int SimTK::Optimizer::OptimizerRep::objectiveFuncWrapper	(	int	n,
		const Real *	x,
		int	new_x,
		Real *	f,
		void *	rep
	)		[static, protected]

static int SimTK::Optimizer::OptimizerRep::gradientFuncWrapper	(	int	n,
		const Real *	x,
		int	new_x,
		Real *	gradient,
		void *	rep
	)		[static, protected]

static int SimTK::Optimizer::OptimizerRep::constraintFuncWrapper	(	int	n,
		const Real *	x,
		int	new_x,
		int	m,
		Real *	g,
		void *	rep
	)		[static, protected]

static int SimTK::Optimizer::OptimizerRep::constraintJacobianWrapper	(	int	n,
		const Real *	x,
		int	new_x,
		int	m,
		int	nele_jac,
		int *	iRow,
		int *	jCol,
		Real *	values,
		void *	rep
	)		[static, protected]

static int SimTK::Optimizer::OptimizerRep::hessianWrapper	(	int	n,
		const Real *	x,
		int	new_x,
		Real	obj_factor,
		int	m,
		Real *	lambda,
		int	new_lambda,
		int	nele_hess,
		int *	iRow,
		int *	jCol,
		Real *	values,
		void *	rep
	)		[static, protected]

---

Friends And Related Function Documentation

friend class Optimizer [friend]

---

Member Data Documentation

int SimTK::Optimizer::OptimizerRep::diagnosticsLevel [protected]

Real SimTK::Optimizer::OptimizerRep::convergenceTolerance [protected]

Real SimTK::Optimizer::OptimizerRep::constraintTolerance [protected]

int SimTK::Optimizer::OptimizerRep::maxIterations [protected]

int SimTK::Optimizer::OptimizerRep::limitedMemoryHistory [protected]

Differentiator::Method SimTK::Optimizer::OptimizerRep::diffMethod [protected]

Real SimTK::Optimizer::OptimizerRep::objectiveEstimatedAccuracy [protected]

Real SimTK::Optimizer::OptimizerRep::constraintsEstimatedAccuracy [protected]

---

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

• OptimizerRep.h