#include <opt.h>
Inheritance diagram for sc::Optimize:
Public Member Functions | |
Optimize (StateIn &) | |
Restore the state of a Function object. | |
Optimize (const Ref< KeyVal > &) | |
The KeyVal constructor reads the following information:. | |
void | save_data_state (StateOut &) |
Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. | |
virtual int | optimize () |
Do the optimization. | |
void | set_checkpoint () |
Set up for checkpointing. | |
void | set_checkpoint_file (const char *) |
void | set_function (const Ref< Function > &) |
Set the function to be optimized. | |
void | set_max_iterations (int) |
Set the iteration limit. | |
virtual void | init () |
Initialize the optimizer. | |
virtual int | update ()=0 |
Take a step. | |
virtual void | apply_transform (const Ref< NonlinearTransform > &) |
Ref< Function > | function () const |
Returns information about the Function being optimized. | |
Ref< SCMatrixKit > | matrixkit () const |
RefSCDimension | dimension () const |
Protected Attributes | |
int | max_iterations_ |
int | n_iterations_ |
int | ckpt_ |
int | print_timings_ |
double | max_stepsize_ |
char * | ckpt_file |
Ref< Function > | function_ |
Ref< Convergence > | conv_ |
The KeyVal constructor reads the following information:.
checkpoint
checkpoint_file
max_iterations
max_stepsize
function
convergence
void sc::Optimize::save_data_state | ( | StateOut & | ) | [virtual] |
Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
This must be implemented by the derived class if the class has data.
Reimplemented from sc::SavableState.
Reimplemented in sc::EFCOpt, sc::LineOpt, and sc::QNewtonOpt.
virtual int sc::Optimize::optimize | ( | ) | [virtual] |
Do the optimization.
Returns nonzero if the optimization is complete.
virtual int sc::Optimize::update | ( | ) | [pure virtual] |
Take a step.
Returns 1 if the optimization has converged, otherwise 0.
Implemented in sc::EFCOpt, sc::MCSearch, and sc::QNewtonOpt.