#include <LineSearch.h>
Inheritance diagram for mirtk::LineSearch:
Collaboration diagram for mirtk::LineSearch:
Public Member Functions | |
| virtual void | Initialize () |
| Initialize optimization. | |
| virtual ParameterList | Parameter () const |
| Get parameters as key/value as string map. | |
| virtual double | Run ()=0 |
| virtual bool | Set (const char *, const char *) |
| Set parameter value from string. | |
| virtual LineSearchStrategy | Strategy () const =0 |
| Line search strategy implemented by this line search. | |
| virtual | ~LineSearch () |
| Destructor. | |
 Public Member Functions inherited from mirtk::LocalOptimizer | |
| void | AddStoppingCriterion (StoppingCriterion *) |
| Add stopping criterion and take over ownership of the object. | |
| void | ClearStoppingCriteria () |
| Delete all stopping criteria. | |
| int | NumberOfStoppingCriteria () const |
| Get number of stopping criteria. | |
| virtual enum OptimizationMethod | OptimizationMethod () const =0 |
| Optimization method implemented by this optimizer. | |
| void | RemoveStoppingCriterion (StoppingCriterion *) |
| Remove stopping criterion and revoke ownership of the object. | |
| class StoppingCriterion * | StoppingCriterion (int) |
| Get the n-th stopping criterion. | |
| const class StoppingCriterion * | StoppingCriterion (int) const |
| Get the n-th stopping criterion. | |
| virtual | ~LocalOptimizer () |
| Destructor. | |
| Public Member Functions inherited from mirtk::Observable | |
| void | AddObserver (Observer &) |
| Add observer. | |
| void | Broadcast (Event, const void *=NULL) |
| Broadcast event to observers. | |
| void | ClearObservers () |
| Delete all observers. | |
| void | DeleteObserver (Observer &) |
| Delete observer. | |
| void | NotifyObservers (Event, const void *=NULL) |
| Notify all observers about given event if this object has changed. | |
| int | NumberOfObservers () const |
| Number of current observers. | |
| virtual | ~Observable () |
| Destructor. | |
| Public Member Functions inherited from mirtk::Object | |
| virtual const char * | NameOfClass () const =0 |
| Get name of class, which this object is an instance of. | |
| bool | Parameter (const ParameterList &) |
| Set parameters from name/value pairs. | |
| virtual | ~Object () |
| Destructor. | |
Static Public Member Functions | |
| static LineSearch * | New (LineSearchStrategy &, ObjectiveFunction *=NULL) |
| Instantiate line search implementing specified strategy. | |
| Static Public Member Functions inherited from mirtk::LocalOptimizer | |
| static FactoryType & | Factory () |
| Get global optimizer factory instance. | |
| static LocalOptimizer * | New (enum OptimizationMethod, ObjectiveFunction *=NULL) |
| Construct optimizer. | |
| Static Public Member Functions inherited from mirtk::Object | |
| static const char * | NameOfType () |
| Get name of this class type. | |
Protected Member Functions | |
| LineSearch (ObjectiveFunction *=NULL) | |
| Constructor. | |
| LineSearch (const LineSearch &) | |
| Copy constructor. | |
| LineSearch & | operator= (const LineSearch &) |
| Assignment operator. | |
| Protected Member Functions inherited from mirtk::LocalOptimizer | |
| virtual bool | Converged (int iter, double value, const double *delta) |
| bool | IsImprovement (double prev, double value) const |
| LocalOptimizer (ObjectiveFunction *=NULL) | |
| Constructor. | |
| LocalOptimizer (const LocalOptimizer &) | |
| Copy constructor. | |
| LocalOptimizer & | operator= (const LocalOptimizer &) |
| Assignment operator. | |
| Protected Member Functions inherited from mirtk::Observable | |
| Observable () | |
| Default constructor. | |
| Observable (const Observable &) | |
| Copy constructor. | |
| Observable & | operator= (const Observable &) |
| Assignment operator. | |
| Protected Member Functions inherited from mirtk::Object | |
| template<typename... Args> | |
| void | Throw (ErrorType err, const char *func, Args... args) const |
Additional Inherited Members | |
| Public Types inherited from mirtk::LocalOptimizer | |
| typedef ObjectFactory< enum OptimizationMethod, LocalOptimizer > | FactoryType |
| Type of optimizer factory. | |
| Static Protected Member Functions inherited from mirtk::Object | |
| template<typename... Args> | |
| static void | ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args) |
Detailed Description
Finds optimal step length along given search direction
Definition at line 47 of file LineSearch.h.
Member Function Documentation
§ Run()
|
inlinepure virtual |
Make optimal step along search direction
- Returns
- New value of objective function or previous if no step successful
Implements mirtk::LocalOptimizer.
Implemented in mirtk::BrentLineSearch, mirtk::AdaptiveLineSearch, and mirtk::MaxStepLineSearch.
Definition at line 182 of file LineSearch.h.
The documentation for this class was generated from the following file: