bpp-core  2.2.0
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
bpp::GoldenSectionSearch Class Reference

Golden Section Search optimization algorithm for one parameter. More...

#include <Bpp/Numeric/Function/GoldenSectionSearch.h>

+ Inheritance diagram for bpp::GoldenSectionSearch:
+ Collaboration diagram for bpp::GoldenSectionSearch:

Classes

class  GSSStopCondition
 

Public Member Functions

 GoldenSectionSearch (Function *function)
 
virtual ~GoldenSectionSearch ()
 
GoldenSectionSearchclone () const
 Create a copy of this object and send a pointer to it. More...
 
void doInit (const ParameterList &params) throw (Exception)
 This function is called by the init() method and contains all calculations. More...
 
double doStep () throw (Exception)
 This function is called by the step() method and contains all calculations. More...
 
bool isInitialIntervalSet () const
 
void updateParameters (bool yn)
 Tell if we shall update all parameters after one optimization step. More...
 
bool updateParameters () const
 Tell if we shall update all parameters after one optimization step. More...
 
void setOptimizationProgressCharacter (const std::string &c)
 Set the character to be displayed during optimization. More...
 
const std::string & getOptimizationProgressCharacter () const
 
The Optimizer interface.
double getFunctionValue () const throw (NullPointerException)
 Initialize optimizer. More...
 
Specific method
void setInitialInterval (double inf, double sup)
 Set intial search interval. More...
 
The Optimizer interface.
void init (const ParameterList &params) throw (Exception)
 Basic implementation. More...
 
double step () throw (Exception)
 Basic implementation. More...
 
double optimize () throw (Exception)
 Basic implementation. More...
 
bool isInitialized () const
 
const ParameterListgetParameters () const
 
double getParameterValue (const std::string &name) const
 
void setFunction (Function *function)
 Set the function to optimize. More...
 
const FunctiongetFunction () const
 Get the current function being optimized. More...
 
FunctiongetFunction ()
 Get the current function being optimized. More...
 
bool hasFunction () const
 Tell if a funciton is associatied to this optimizer. More...
 
void setMessageHandler (OutputStream *mh)
 Set the message handler for this optimizer. More...
 
OutputStreamgetMessageHandler () const
 
void setProfiler (OutputStream *profiler)
 Set the profiler for this optimizer. More...
 
OutputStreamgetProfiler () const
 
unsigned int getNumberOfEvaluations () const
 Get the number of function evaluations performed since the call of the init function. More...
 
void setStopCondition (const OptimizationStopCondition &stopCondition)
 Set the stop condition of the optimization algorithm. More...
 
OptimizationStopConditiongetStopCondition ()
 Get the stop condition of the optimization algorithm. More...
 
const OptimizationStopConditiongetStopCondition () const
 Get the stop condition of the optimization algorithm. More...
 
OptimizationStopConditiongetDefaultStopCondition ()
 Get the default stop condition of the optimization algorithm. More...
 
const OptimizationStopConditiongetDefaultStopCondition () const
 Get the default stop condition of the optimization algorithm. More...
 
bool isToleranceReached () const
 Tell if the tolerance level is reached. More...
 
bool isMaximumNumberOfEvaluationsReached () const
 Tell if the maximum number of function evaluations is reached. More...
 
void setMaximumNumberOfEvaluations (unsigned int max)
 Set the maximum number of function evaluation to perform during optimization. More...
 
void setVerbose (unsigned int v)
 Set the verbose level. More...
 
unsigned int getVerbose () const
 Get the verbose level. More...
 
void setConstraintPolicy (const std::string &constraintPolicy)
 Set the constraint policy for this optimizer. More...
 
std::string getConstraintPolicy () const
 Get the constraint policy for this optimizer. More...
 
void addOptimizationListener (OptimizationListener *listener)
 Register a listener to this class. More...
 

Protected Member Functions

ParameterListgetParameters_ ()
 
ParametergetParameter_ (size_t i)
 
FunctiongetFunction_ ()
 
void setDefaultStopCondition_ (OptimizationStopCondition *osc)
 
Inner utilitary functions
void autoParameter ()
 Build a list of AutoParameter instead of Parameter. More...
 
void ignoreConstraints ()
 Remove the constraints of all the arguments. More...
 
void profile (double v)
 Print to the profile if there is one. More...
 
void profile (unsigned int v)
 Print to the profile if there is one. More...
 
void profile (const std::string &s)
 Print to the profile if there is one. More...
 
void profileln (double v)
 Print to the profile if there is one and end line. More...
 
void profileln (unsigned int v)
 Print to the profile if there is one and end line. More...
 
void profileln (const std::string &s)
 Print to the profile if there is one and end line. More...
 
void printPoint (const ParameterList &params, double value)
 Print parameters and corresponding function evaluation to profiler. More...
 
void printMessage (const std::string &message)
 Give a message to print to the message handler. More...
 
void fireOptimizationInitializationPerformed (const OptimizationEvent &event)
 Notify all listeners that optimizer initialization was performed. More...
 
void fireOptimizationStepPerformed (const OptimizationEvent &event)
 Notify all listeners that an optimization step was performed. More...
 
bool listenerModifiesParameters () const
 

Protected Attributes

unsigned int nbEvalMax_
 The maximum number of function evaluations allowed. More...
 
unsigned int nbEval_
 The current number of function evaluations achieved. More...
 
double currentValue_
 The current value of the function. More...
 
bool tolIsReached_
 Tell if the tolerance level has been reached. More...
 

Private Attributes

double f1
 
double f2
 
double x0
 
double x1
 
double x2
 
double x3
 
double xinf_
 
double xsup_
 
bool isInitialIntervalSet_
 

Friends

class GSSStopCondition
 

Detailed Description

Golden Section Search optimization algorithm for one parameter.

A description of the algorithm can be found in:

NUMERICAL RECIPES IN C: THE ART OF SCIENTIFIC COMPUTING
(ISBN 0-521-43108-5)

or there: http://en.wikipedia.org/wiki/Golden_section_search.

Definition at line 59 of file GoldenSectionSearch.h.

Constructor & Destructor Documentation

virtual bpp::GoldenSectionSearch::~GoldenSectionSearch ( )
inlinevirtual

Definition at line 88 of file GoldenSectionSearch.h.

Member Function Documentation

void bpp::AbstractOptimizer::addOptimizationListener ( OptimizationListener listener)
inlinevirtualinherited

Register a listener to this class.

All registered listeners will be informed when an optimization event occur. See the documentation of the class to know what kind of events are supported.

Parameters
listenerA listener to be registered with.

Implements bpp::Optimizer.

Definition at line 227 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::listeners_.

GoldenSectionSearch* bpp::GoldenSectionSearch::clone ( ) const
inlinevirtual

Create a copy of this object and send a pointer to it.

Returns
A pointer toward the copy object.

Implements bpp::Optimizer.

Definition at line 90 of file GoldenSectionSearch.h.

References GoldenSectionSearch().

void GoldenSectionSearch::doInit ( const ParameterList params)
throw (Exception
)
virtual

This function is called by the init() method and contains all calculations.

Parameters
paramsThe parameters to use for initialization.

Implements bpp::AbstractOptimizer.

Definition at line 79 of file GoldenSectionSearch.cpp.

References bpp::Bracket::a, bpp::NumTools::abs(), bpp::Bracket::b, bpp::OneDimensionOptimizationTools::bracketMinimum(), bpp::Bracket::c, bpp::BracketPoint::f, bpp::NumConstants::GOLDEN_RATIO_C(), bpp::TextTools::toString(), and bpp::BracketPoint::x.

void AbstractOptimizer::fireOptimizationInitializationPerformed ( const OptimizationEvent event)
protectedinherited

Notify all listeners that optimizer initialization was performed.

This method should be called by the init method.

Parameters
eventAn OptimizationEvent object.

Definition at line 313 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::listeners_.

void AbstractOptimizer::fireOptimizationStepPerformed ( const OptimizationEvent event)
protectedinherited

Notify all listeners that an optimization step was performed.

This method should be called by the step method.

Parameters
eventAn OptimizationEvent object.

Definition at line 323 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::listeners_.

Referenced by bpp::AbstractOptimizer::step().

std::string bpp::AbstractOptimizer::getConstraintPolicy ( ) const
inlinevirtualinherited

Get the constraint policy for this optimizer.

Returns
The constraint policy.

Implements bpp::Optimizer.

Definition at line 226 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::constraintPolicy_.

const OptimizationStopCondition* bpp::AbstractOptimizer::getDefaultStopCondition ( ) const
inlinevirtualinherited

Get the default stop condition of the optimization algorithm.

Returns
The default stop condition used while optimizing.

Implements bpp::Optimizer.

Definition at line 219 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::defaultStopCondition_.

Function* bpp::AbstractOptimizer::getFunction ( )
inlinevirtualinherited

Get the current function being optimized.

Returns
A const pointer toward the function being optimized.

Implements bpp::Optimizer.

Reimplemented in bpp::BfgsMultiDimensions, bpp::ConjugateGradientMultiDimensions, and bpp::NewtonOneDimension.

Definition at line 198 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::function_.

double GoldenSectionSearch::getFunctionValue ( ) const
throw (NullPointerException
)
virtual

Initialize optimizer.

The golden section search needs 2 initial guesses, so you must call the setInitialInterval() method first. This function actually performs:

  • Parameter list actualisation;
  • Initial bracketting;
  • Function evaluation count reseting.

Reimplemented from bpp::AbstractOptimizer.

Definition at line 165 of file GoldenSectionSearch.cpp.

References bpp::AbstractOptimizer::currentValue_, and bpp::AbstractOptimizer::hasFunction().

OutputStream* bpp::AbstractOptimizer::getMessageHandler ( ) const
inlinevirtualinherited
Returns
The stream used for handling messages, if any.

Implements bpp::Optimizer.

Definition at line 207 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::messageHandler_.

Referenced by bpp::PowellMultiDimensions::doStep().

unsigned int bpp::AbstractOptimizer::getNumberOfEvaluations ( ) const
inlinevirtualinherited

Get the number of function evaluations performed since the call of the init function.

Returns
The number of function evaluations.

Implements bpp::Optimizer.

Definition at line 211 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::nbEval_.

Referenced by bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::OneDimensionOptimizationTools::lineMinimization(), and bpp::OneDimensionOptimizationTools::lineSearch().

const std::string& bpp::AbstractOptimizer::getOptimizationProgressCharacter ( ) const
inlineinherited
Returns
The character to be displayed during optimization.

Definition at line 265 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::stepChar_.

Parameter& bpp::AbstractOptimizer::getParameter_ ( size_t  i)
inlineprotectedinherited
double bpp::AbstractOptimizer::getParameterValue ( const std::string &  name) const
inlinevirtualinherited
Returns
The value associated with a given parameter name.

Implements bpp::Optimizer.

Definition at line 191 of file AbstractOptimizer.h.

References bpp::ParameterList::getParameterValue(), and bpp::AbstractOptimizer::parameters_.

OutputStream* bpp::AbstractOptimizer::getProfiler ( ) const
inlinevirtualinherited
Returns
The stream used for profiling, if any.

Implements bpp::Optimizer.

Definition at line 209 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::profiler_.

const OptimizationStopCondition* bpp::AbstractOptimizer::getStopCondition ( ) const
inlinevirtualinherited

Get the stop condition of the optimization algorithm.

Returns
The stop condition used while optimizing.

Implements bpp::Optimizer.

Definition at line 217 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::stopCondition_.

unsigned int bpp::AbstractOptimizer::getVerbose ( ) const
inlinevirtualinherited
bool bpp::AbstractOptimizer::hasFunction ( ) const
inlinevirtualinherited

Tell if a funciton is associatied to this optimizer.

Returns
True if a function has been associated to this optimizer.

Implements bpp::Optimizer.

Definition at line 199 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::function_.

Referenced by getFunctionValue().

void AbstractOptimizer::ignoreConstraints ( )
protectedinherited

Remove the constraints of all the arguments.

Definition at line 303 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::parameters_, and bpp::ParameterList::size().

Referenced by bpp::AbstractOptimizer::AbstractOptimizer(), and bpp::AbstractOptimizer::operator=().

void AbstractOptimizer::init ( const ParameterList params)
throw (Exception
)
virtualinherited

Basic implementation.

Store all parameters, call the doInit method, print to profiler, initialize timer and notify all listeners.

Implements bpp::Optimizer.

Definition at line 153 of file AbstractOptimizer.cpp.

References bpp::AutoParameter::CONSTRAINTS_AUTO, and bpp::AutoParameter::CONSTRAINTS_IGNORE.

Referenced by bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::OneDimensionOptimizationTools::lineMinimization(), and bpp::OneDimensionOptimizationTools::lineSearch().

bool bpp::GoldenSectionSearch::isInitialIntervalSet ( ) const
inline
Returns
'true' if the initial interval has been correctly set.

Definition at line 136 of file GoldenSectionSearch.h.

References isInitialIntervalSet_.

bool bpp::AbstractOptimizer::isInitialized ( ) const
inlinevirtualinherited
Returns
'true' if this optimizer has been initialized.

Implements bpp::Optimizer.

Definition at line 189 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::isInitialized_.

bool bpp::AbstractOptimizer::isMaximumNumberOfEvaluationsReached ( ) const
inlinevirtualinherited

Tell if the maximum number of function evaluations is reached.

Returns
Whether the maximum number of function evaluations is reached or not.

Implements bpp::Optimizer.

Definition at line 221 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::nbEval_, and bpp::AbstractOptimizer::nbEvalMax_.

bool bpp::AbstractOptimizer::isToleranceReached ( ) const
inlinevirtualinherited

Tell if the tolerance level is reached.

Returns
Whether the tolerance is reached or not.
See Also
OptimizationStopCondition

Implements bpp::Optimizer.

Definition at line 220 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::tolIsReached_.

bool AbstractOptimizer::listenerModifiesParameters ( ) const
protectedinherited

Definition at line 333 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::listeners_.

Referenced by bpp::AbstractOptimizer::step().

void AbstractOptimizer::printMessage ( const std::string &  message)
protectedinherited

Give a message to print to the message handler.

Parameters
messageThe message to print.

Definition at line 284 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::messageHandler_.

Referenced by bpp::NewtonOneDimension::doStep(), and bpp::BfgsMultiDimensions::doStep().

void AbstractOptimizer::printPoint ( const ParameterList params,
double  value 
)
protectedinherited

Print parameters and corresponding function evaluation to profiler.

Parameters
paramsThe parameters to print.
valueThe function evaluation.

Definition at line 265 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::nbEval_, bpp::AbstractOptimizer::profile(), bpp::AbstractOptimizer::profileln(), bpp::ParameterList::size(), bpp::AbstractOptimizer::startTime_, and bpp::TextTools::toString().

Referenced by bpp::PowellMultiDimensions::doStep(), and bpp::AbstractOptimizer::step().

void AbstractOptimizer::profile ( double  v)
protectedinherited

Print to the profile if there is one.

Parameters
vThe double value to print.

Definition at line 224 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

Referenced by bpp::AbstractOptimizer::printPoint().

void AbstractOptimizer::profile ( unsigned int  v)
protectedinherited

Print to the profile if there is one.

Parameters
vThe unsigned int value to print.

Definition at line 238 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

void AbstractOptimizer::profile ( const std::string &  s)
protectedinherited

Print to the profile if there is one.

Parameters
sThe string to print to the profile.

Definition at line 251 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

void AbstractOptimizer::profileln ( double  v)
protectedinherited

Print to the profile if there is one and end line.

Parameters
vThe double value to print.

Definition at line 231 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

Referenced by bpp::AbstractOptimizer::printPoint().

void AbstractOptimizer::profileln ( unsigned int  v)
protectedinherited

Print to the profile if there is one and end line.

Parameters
vThe unsigned int value to print.

Definition at line 244 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

void AbstractOptimizer::profileln ( const std::string &  s)
protectedinherited

Print to the profile if there is one and end line.

Parameters
sThe string to print to the profile.

Definition at line 258 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

void bpp::AbstractOptimizer::setConstraintPolicy ( const std::string &  constraintPolicy)
inlinevirtualinherited

Set the constraint policy for this optimizer.

Parameters
constraintPolicyThe constraint policy.

Implements bpp::Optimizer.

Definition at line 225 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::constraintPolicy_.

Referenced by bpp::OneDimensionOptimizationTools::lineMinimization(), and bpp::OneDimensionOptimizationTools::lineSearch().

void bpp::AbstractOptimizer::setFunction ( Function function)
inlinevirtualinherited
void GoldenSectionSearch::setInitialInterval ( double  inf,
double  sup 
)

Set intial search interval.

Parameters
infMinimum value.
supMaximum value.

Definition at line 118 of file GoldenSectionSearch.cpp.

References isInitialIntervalSet_, xinf_, and xsup_.

void bpp::AbstractOptimizer::setMaximumNumberOfEvaluations ( unsigned int  max)
inlinevirtualinherited

Set the maximum number of function evaluation to perform during optimization.

Parameters
maxThe maximum number of evaluations to perform.

Implements bpp::Optimizer.

Definition at line 222 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::nbEvalMax_.

Referenced by bpp::BrentOneDimension::BrentOneDimension(), and bpp::NewtonBacktrackOneDimension::NewtonBacktrackOneDimension().

void bpp::AbstractOptimizer::setMessageHandler ( OutputStream mh)
inlinevirtualinherited

Set the message handler for this optimizer.

The message handler keeps all messages that the optimizer may send. The default handler is set to standard output, but you can pass any ostream object (cerr, ofstream, etc.).

A NULL pointer disables message output.

Parameters
mhThe message handler to use.

Implements bpp::Optimizer.

Definition at line 206 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::messageHandler_.

Referenced by bpp::OneDimensionOptimizationTools::lineMinimization(), and bpp::OneDimensionOptimizationTools::lineSearch().

void bpp::AbstractOptimizer::setOptimizationProgressCharacter ( const std::string &  c)
inlineinherited
void bpp::AbstractOptimizer::setProfiler ( OutputStream profiler)
inlinevirtualinherited

Set the profiler for this optimizer.

The profiler keeps all the intermediate values taken by the parameters. The default profiler is set to standard output, but you can pass any ostream object (cerr, ofstream, etc.).

A NULL pointer disables message output.

Parameters
profilerThe profiler to use.

Implements bpp::Optimizer.

Definition at line 208 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::profiler_.

Referenced by bpp::OneDimensionOptimizationTools::lineMinimization(), and bpp::OneDimensionOptimizationTools::lineSearch().

void bpp::AbstractOptimizer::setVerbose ( unsigned int  v)
inlinevirtualinherited

Set the verbose level.

0 = off 1 = on 2 = more verbose 3 = even more, etc.

In most cases, only the 0 and 1 levels are implemented.

Parameters
vverbose level.

Implements bpp::Optimizer.

Definition at line 223 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::verbose_.

Referenced by bpp::OneDimensionOptimizationTools::lineMinimization(), and bpp::OneDimensionOptimizationTools::lineSearch().

void bpp::AbstractOptimizer::updateParameters ( bool  yn)
inlineinherited

Tell if we shall update all parameters after one optimization step.

This is required only for functions that have non-independent parameters, which means that setting one parameter value may modify one or several other parameters. Depending on the optimizer, this may have no effect.

Parameters
yntrue/false

Definition at line 243 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::updateParameters_.

bool bpp::AbstractOptimizer::updateParameters ( ) const
inlineinherited

Tell if we shall update all parameters after one optimization step.

This is required only for functions that have non-independent parameters, which means that setting one parameter value may modify one or several other parameters. Depending on the optimizer, this may have no effect.

Returns
yn true/false

Definition at line 254 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::updateParameters_.

Friends And Related Function Documentation

friend class GSSStopCondition
friend

Definition at line 78 of file GoldenSectionSearch.h.

Referenced by GoldenSectionSearch().

Member Data Documentation

double bpp::GoldenSectionSearch::f1
private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep().

double bpp::GoldenSectionSearch::f2
private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep().

bool bpp::GoldenSectionSearch::isInitialIntervalSet_
private

Definition at line 83 of file GoldenSectionSearch.h.

Referenced by doStep(), isInitialIntervalSet(), and setInitialInterval().

double bpp::GoldenSectionSearch::x0
private
double bpp::GoldenSectionSearch::x1
private
double bpp::GoldenSectionSearch::x2
private
double bpp::GoldenSectionSearch::x3
private
double bpp::GoldenSectionSearch::xinf_
private

Definition at line 82 of file GoldenSectionSearch.h.

Referenced by setInitialInterval().

double bpp::GoldenSectionSearch::xsup_
private

Definition at line 82 of file GoldenSectionSearch.h.

Referenced by setInitialInterval().


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