Simbody 3.7
Loading...
Searching...
No Matches
SimTK::Optimizer::OptimizerRep Class Referenceabstract

#include <OptimizerRep.h>

+ Inheritance diagram for SimTK::Optimizer::OptimizerRep:

Public Member Functions

virtual ~OptimizerRep ()
 
 OptimizerRep (const OptimizerSystem &sys)
 
 OptimizerRep ()
 
virtual OptimizerRepclone () const
 
virtual Real optimize (Vector &results)=0
 
const OptimizerSystemgetOptimizerSystem () 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 setAdvancedVectorOption (const std::string &option, const Vector 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
 
bool getAdvancedVectorOption (const std::string &option, Vector &value) const
 
void setMyHandle (Optimizer &cp)
 
const OptimizergetMyHandle () 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 DifferentiatorgetGradientDifferentiator () const
 
const DifferentiatorgetJacobianDifferentiator () const
 
virtual OptimizerAlgorithm getAlgorithm () 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

◆ ~OptimizerRep()

virtual SimTK::Optimizer::OptimizerRep::~OptimizerRep ( )
virtual

◆ OptimizerRep() [1/2]

SimTK::Optimizer::OptimizerRep::OptimizerRep ( const OptimizerSystem & sys)
inline

◆ OptimizerRep() [2/2]

SimTK::Optimizer::OptimizerRep::OptimizerRep ( )
inline

Member Function Documentation

◆ clone()

virtual OptimizerRep * SimTK::Optimizer::OptimizerRep::clone ( ) const
inlinevirtual

◆ isAvailable()

static bool SimTK::Optimizer::OptimizerRep::isAvailable ( )
inlinestatic

◆ optimize()

virtual Real SimTK::Optimizer::OptimizerRep::optimize ( Vector & results)
pure virtual

◆ getOptimizerSystem()

const OptimizerSystem & SimTK::Optimizer::OptimizerRep::getOptimizerSystem ( ) const
inline

◆ setDiagnosticsLevel()

void SimTK::Optimizer::OptimizerRep::setDiagnosticsLevel ( const int level)

◆ setConvergenceTolerance()

void SimTK::Optimizer::OptimizerRep::setConvergenceTolerance ( Real accuracy)

◆ setConstraintTolerance()

void SimTK::Optimizer::OptimizerRep::setConstraintTolerance ( Real tolerance)

◆ setMaxIterations()

void SimTK::Optimizer::OptimizerRep::setMaxIterations ( const int iter)

◆ setLimitedMemoryHistory()

void SimTK::Optimizer::OptimizerRep::setLimitedMemoryHistory ( const int history)

◆ setAdvancedStrOption()

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

◆ setAdvancedRealOption()

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

◆ setAdvancedIntOption()

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

◆ setAdvancedBoolOption()

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

◆ setAdvancedVectorOption()

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

◆ getAdvancedStrOption()

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

◆ getAdvancedRealOption()

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

◆ getAdvancedIntOption()

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

◆ getAdvancedBoolOption()

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

◆ getAdvancedVectorOption()

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

◆ setMyHandle()

void SimTK::Optimizer::OptimizerRep::setMyHandle ( Optimizer & cp)
inline

◆ getMyHandle()

const Optimizer & SimTK::Optimizer::OptimizerRep::getMyHandle ( ) const
inline

◆ clearMyHandle()

void SimTK::Optimizer::OptimizerRep::clearMyHandle ( )
inline

◆ useNumericalGradient()

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

◆ useNumericalJacobian()

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

◆ setDifferentiatorMethod()

void SimTK::Optimizer::OptimizerRep::setDifferentiatorMethod ( Differentiator::Method method)

◆ isUsingNumericalGradient()

bool SimTK::Optimizer::OptimizerRep::isUsingNumericalGradient ( ) const
inline

◆ isUsingNumericalJacobian()

bool SimTK::Optimizer::OptimizerRep::isUsingNumericalJacobian ( ) const
inline

◆ getDifferentiatorMethod()

Differentiator::Method SimTK::Optimizer::OptimizerRep::getDifferentiatorMethod ( ) const
inline

◆ getEstimatedAccuracyOfObjective()

Real SimTK::Optimizer::OptimizerRep::getEstimatedAccuracyOfObjective ( ) const
inline

◆ getEstimatedAccuracyOfConstraints()

Real SimTK::Optimizer::OptimizerRep::getEstimatedAccuracyOfConstraints ( ) const
inline

◆ getGradientDifferentiator()

const Differentiator & SimTK::Optimizer::OptimizerRep::getGradientDifferentiator ( ) const
inline

◆ getJacobianDifferentiator()

const Differentiator & SimTK::Optimizer::OptimizerRep::getJacobianDifferentiator ( ) const
inline

◆ getAlgorithm()

virtual OptimizerAlgorithm SimTK::Optimizer::OptimizerRep::getAlgorithm ( ) const
inlinevirtual

◆ numericalGradient_static()

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

◆ numericalJacobian_static()

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

◆ objectiveFuncWrapper()

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

◆ gradientFuncWrapper()

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

◆ constraintFuncWrapper()

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

◆ constraintJacobianWrapper()

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 )
staticprotected

◆ hessianWrapper()

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 )
staticprotected

Friends And Related Symbol Documentation

◆ Optimizer

friend class Optimizer
friend

Member Data Documentation

◆ diagnosticsLevel

int SimTK::Optimizer::OptimizerRep::diagnosticsLevel
protected

◆ convergenceTolerance

Real SimTK::Optimizer::OptimizerRep::convergenceTolerance
protected

◆ constraintTolerance

Real SimTK::Optimizer::OptimizerRep::constraintTolerance
protected

◆ maxIterations

int SimTK::Optimizer::OptimizerRep::maxIterations
protected

◆ limitedMemoryHistory

int SimTK::Optimizer::OptimizerRep::limitedMemoryHistory
protected

◆ diffMethod

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

◆ objectiveEstimatedAccuracy

Real SimTK::Optimizer::OptimizerRep::objectiveEstimatedAccuracy
protected

◆ constraintsEstimatedAccuracy

Real SimTK::Optimizer::OptimizerRep::constraintsEstimatedAccuracy
protected

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