Optimizer Class Reference
API for SimTK Simmath's optimizers.
More...
#include <Optimizer.h>
List of all members.
Detailed Description
API for SimTK Simmath's optimizers.
An optimizer finds a local minimum to an objective function. The optimizer can be constrained to search for a minimum within a feasible region. The feasible region can be defined by setting limits on the parameters of the objective function and/or supplying constraint functions that must be satisfied. The optimizer starts searching for a minimum beginning at a user supplied initial value for the set of parameters.
The objective function and constraints are specified by supplying the Optimizer with a concrete implemenation of an OptimizerSystem class. The OptimizerSystem can be passed to the Optimizer either through the Optimizer constructor or by calling the setOptimizerSystem method. The Optimizer class will select the best optimization algorithm to solve the problem based on the constraints supplied by the OptimizerSystem. A user can also override the optimization algorithm selected by the Optimizer by specifying the optimization algorithm.
Constructor & Destructor Documentation
Member Function Documentation
bool isUsingNumericalGradient |
( |
|
) |
const |
Indicate whether the Optimizer is currently set to use a numerical gradient.
bool isUsingNumericalJacobian |
( |
|
) |
const |
Indicate whether the Optimizer is currently set to use a numerical Jacobian.
bool setAdvancedBoolOption |
( |
const char * |
option, |
|
|
const bool |
value | |
|
) |
| | |
Set the value of an advanced option specified by an boolean value.
bool setAdvancedIntOption |
( |
const char * |
option, |
|
|
const int |
value | |
|
) |
| | |
Set the value of an advanced option specified by an integer value.
bool setAdvancedRealOption |
( |
const char * |
option, |
|
|
const Real |
value | |
|
) |
| | |
Set the value of an advanced option specified by a real value.
bool setAdvancedStrOption |
( |
const char * |
option, |
|
|
const char * |
value | |
|
) |
| | |
Set the value of an advanced option specified by a string.
void setConvergenceTolerance |
( |
const Real |
tolerance |
) |
|
Sets the absolute tolerance used determine if the problem has converged.
void setDiagnosticsLevel |
( |
const int |
level |
) |
|
Set the level of debugging info displayed.
Set which numerical gradient algorithm is used.
void setLimitedMemoryHistory |
( |
const int |
history |
) |
|
Set the maximum number of previous hessians used in a limitied memory hessian approximation.
void setMaxIterations |
( |
const int |
iter |
) |
|
Set the maximum number of iterations used for each step.
void useNumericalGradient |
( |
const bool |
flag |
) |
|
Enable numerical gradients.
void useNumericalJacobian |
( |
const bool |
flag |
) |
|
Enable numerical Jacobian.
Friends And Related Function Documentation
friend class OptimizerRep [friend] |
The documentation for this class was generated from the following file: