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

GoldenSectionSearch *	clone () 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 ParameterList &	getParameters () const

double	getParameterValue (const std::string &name) const

void	setFunction (Function *function)
	Set the function to optimize. More...

const Function *	getFunction () const
	Get the current function being optimized. More...

Function *	getFunction ()
	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...

OutputStream *	getMessageHandler () const

void	setProfiler (OutputStream *profiler)
	Set the profiler for this optimizer. More...

OutputStream *	getProfiler () 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...

OptimizationStopCondition *	getStopCondition ()
	Get the stop condition of the optimization algorithm. More...

const OptimizationStopCondition *	getStopCondition () const
	Get the stop condition of the optimization algorithm. More...

OptimizationStopCondition *	getDefaultStopCondition ()
	Get the default stop condition of the optimization algorithm. More...

const OptimizationStopCondition *	getDefaultStopCondition () 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
ParameterList &	getParameters_ ()

Parameter &	getParameter_ (size_t i)

Function *	getFunction_ ()

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

◆ GoldenSectionSearch()

GoldenSectionSearch::GoldenSectionSearch ( Function * function )

Definition at line 68 of file GoldenSectionSearch.cpp.

References bpp::AbstractOptimizer::getDefaultStopCondition(), GSSStopCondition, bpp::AbstractOptimizer::nbEvalMax_, bpp::AbstractOptimizer::setDefaultStopCondition_(), and bpp::AbstractOptimizer::setStopCondition().

Referenced by clone().

◆ ~GoldenSectionSearch()

virtual bpp::GoldenSectionSearch::~GoldenSectionSearch ( )

inlinevirtual

Definition at line 88 of file GoldenSectionSearch.h.

Member Function Documentation

◆ addOptimizationListener()

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

listener A listener to be registered with.

Implements bpp::Optimizer.

Definition at line 227 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::listeners_.

◆ autoParameter()

void AbstractOptimizer::autoParameter ( )

protectedinherited

Build a list of AutoParameter instead of Parameter.

Definition at line 291 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::messageHandler_, bpp::AbstractOptimizer::parameters_, bpp::AutoParameter::setMessageHandler(), bpp::ParameterList::setParameter(), and bpp::ParameterList::size().

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

◆ clone()

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().

◆ doInit()

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

virtual

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

Parameters

params The 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.

◆ doStep()

double GoldenSectionSearch::doStep	(		)
throw	(	Exception
	)

virtual

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

Returns: The value of the function after the optimization step.

Implements bpp::AbstractOptimizer.

Definition at line 133 of file GoldenSectionSearch.cpp.

References bpp::Function::f(), f1, f2, bpp::AbstractOptimizer::getFunction(), bpp::AbstractOptimizer::getParameter_(), bpp::AbstractOptimizer::getParameters(), bpp::AbstractOptimizer::getStopCondition(), bpp::NumConstants::GOLDEN_RATIO_C(), bpp::NumConstants::GOLDEN_RATIO_R(), isInitialIntervalSet_, bpp::OptimizationStopCondition::isToleranceReached(), bpp::AbstractOptimizer::nbEval_, bpp::Parameter::setValue(), bpp::AbstractOptimizer::tolIsReached_, x0, x1, x2, and x3.

◆ fireOptimizationInitializationPerformed()

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

event An OptimizationEvent object.

Definition at line 313 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::listeners_.

◆ fireOptimizationStepPerformed()

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

event An OptimizationEvent object.

Definition at line 323 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::listeners_.

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

◆ getConstraintPolicy()

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_.

◆ getDefaultStopCondition() [1/2]

OptimizationStopCondition* bpp::AbstractOptimizer::getDefaultStopCondition ( )

inlinevirtualinherited

Get the default stop condition of the optimization algorithm.

Returns: The default stop condition used while optimizing.

Implements bpp::Optimizer.

Definition at line 218 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::defaultStopCondition_.

Referenced by bpp::BfgsMultiDimensions::BfgsMultiDimensions(), bpp::BrentOneDimension::BrentOneDimension(), bpp::ConjugateGradientMultiDimensions::ConjugateGradientMultiDimensions(), bpp::DownhillSimplexMethod::DownhillSimplexMethod(), GoldenSectionSearch(), bpp::MetaOptimizer::MetaOptimizer(), bpp::NewtonBacktrackOneDimension::NewtonBacktrackOneDimension(), bpp::NewtonOneDimension::NewtonOneDimension(), bpp::PowellMultiDimensions::PowellMultiDimensions(), bpp::SimpleMultiDimensions::SimpleMultiDimensions(), and bpp::SimpleNewtonMultiDimensions::SimpleNewtonMultiDimensions().

◆ getDefaultStopCondition() [2/2]

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_.

◆ getFunction() [1/2]

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

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 197 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::function_.

Referenced by bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::PowellMultiDimensions::doStep(), bpp::NewtonBacktrackOneDimension::doStep(), doStep(), bpp::BrentOneDimension::doStep(), bpp::DownhillSimplexMethod::doStep(), bpp::MetaOptimizer::doStep(), bpp::NewtonOneDimension::getFunction(), bpp::ConjugateGradientMultiDimensions::getFunction(), bpp::BfgsMultiDimensions::getFunction(), bpp::PowellMultiDimensions::optimize(), bpp::BrentOneDimension::optimize(), bpp::DownhillSimplexMethod::optimize(), and bpp::DownhillSimplexMethod::tryExtrapolation().

◆ getFunction() [2/2]

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_.

◆ getFunction_()

Function* bpp::AbstractOptimizer::getFunction_ ( )

inlineprotectedinherited

Definition at line 380 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::function_.

Referenced by bpp::NewtonOneDimension::getFunction_(), bpp::ConjugateGradientMultiDimensions::getFunction_(), bpp::BfgsMultiDimensions::getFunction_(), and bpp::NewtonBacktrackOneDimension::getFunction_().

◆ getFunctionValue()

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().

◆ getMessageHandler()

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().

◆ getNumberOfEvaluations()

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().

◆ getOptimizationProgressCharacter()

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_.

◆ getParameter_()

Parameter& bpp::AbstractOptimizer::getParameter_ ( size_t i )

inlineprotectedinherited

Definition at line 379 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::parameters_.

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

◆ getParameters()

const ParameterList& bpp::AbstractOptimizer::getParameters ( ) const

inlinevirtualinherited

Returns: The parameters with their current values.

Implements bpp::Optimizer.

Definition at line 190 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::parameters_.

Referenced by bpp::NewtonOneDimension::doStep(), bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::ConjugateGradientMultiDimensions::doStep(), bpp::BfgsMultiDimensions::doStep(), bpp::PowellMultiDimensions::doStep(), bpp::NewtonBacktrackOneDimension::doStep(), doStep(), bpp::BrentOneDimension::doStep(), bpp::MetaOptimizer::doStep(), bpp::ConjugateGradientMultiDimensions::getGradient(), bpp::BfgsMultiDimensions::getGradient(), bpp::DownhillSimplexMethod::getPSum(), bpp::PowellMultiDimensions::optimize(), bpp::BrentOneDimension::optimize(), bpp::BfgsMultiDimensions::setDirection(), and bpp::DownhillSimplexMethod::tryExtrapolation().

◆ getParameters_()

ParameterList& bpp::AbstractOptimizer::getParameters_ ( )

inlineprotectedinherited

Definition at line 378 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::parameters_.

Referenced by bpp::NewtonOneDimension::doStep(), bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::ConjugateGradientMultiDimensions::doStep(), bpp::BfgsMultiDimensions::doStep(), bpp::PowellMultiDimensions::doStep(), bpp::DownhillSimplexMethod::doStep(), and bpp::MetaOptimizer::doStep().

◆ getParameterValue()

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_.

◆ getProfiler()

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_.

◆ getStopCondition() [1/2]

OptimizationStopCondition* bpp::AbstractOptimizer::getStopCondition ( )

inlinevirtualinherited

Get the stop condition of the optimization algorithm.

Returns: The stop condition used while optimizing.

Implements bpp::Optimizer.

Definition at line 216 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::stopCondition_.

Referenced by bpp::SimpleMultiDimensions::doStep(), bpp::ConjugateGradientMultiDimensions::doStep(), bpp::PowellMultiDimensions::doStep(), doStep(), bpp::BrentOneDimension::doStep(), bpp::MetaOptimizer::doStep(), bpp::OneDimensionOptimizationTools::lineMinimization(), bpp::OneDimensionOptimizationTools::lineSearch(), bpp::MetaOptimizer::MetaOptimizer(), and bpp::SimpleMultiDimensions::setFunction().

◆ getStopCondition() [2/2]

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_.

◆ getVerbose()

unsigned int bpp::AbstractOptimizer::getVerbose ( ) const

inlinevirtualinherited

Get the verbose level.

Returns: verbose level.

Implements bpp::Optimizer.

Definition at line 224 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::verbose_.

Referenced by bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::ConjugateGradientMultiDimensions::doStep(), bpp::BfgsMultiDimensions::doStep(), bpp::PowellMultiDimensions::doStep(), and bpp::MetaOptimizer::doStep().

◆ hasFunction()

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().

◆ ignoreConstraints()

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=().

◆ init()

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().

◆ isInitialIntervalSet()

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_.

◆ isInitialized()

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_.

◆ isMaximumNumberOfEvaluationsReached()

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_.

◆ isToleranceReached()

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_.

◆ listenerModifiesParameters()

bool AbstractOptimizer::listenerModifiesParameters ( ) const

protectedinherited

Definition at line 333 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::listeners_.

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

◆ optimize()

double AbstractOptimizer::optimize	(		)
throw	(	Exception
	)

virtualinherited

Basic implementation.

Call the step method untill tolerance is reached.

Implements bpp::Optimizer.

Reimplemented in bpp::DownhillSimplexMethod, bpp::BrentOneDimension, and bpp::PowellMultiDimensions.

Definition at line 208 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::currentValue_, bpp::ApplicationTools::displayUnlimitedGauge(), bpp::AbstractOptimizer::isInitialized_, bpp::AbstractOptimizer::nbEval_, bpp::AbstractOptimizer::nbEvalMax_, bpp::AbstractOptimizer::step(), bpp::AbstractOptimizer::tolIsReached_, and bpp::AbstractOptimizer::verbose_.

Referenced by bpp::SimpleNewtonMultiDimensions::doStep(), bpp::OneDimensionOptimizationTools::lineSearch(), bpp::PowellMultiDimensions::optimize(), bpp::BrentOneDimension::optimize(), and bpp::DownhillSimplexMethod::optimize().

◆ printMessage()

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

protectedinherited

Give a message to print to the message handler.

Parameters

message The message to print.

Definition at line 284 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::messageHandler_.

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

◆ printPoint()

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

protectedinherited

Print parameters and corresponding function evaluation to profiler.

Parameters

params	The parameters to print.
value	The 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().

◆ profile() [1/3]

void AbstractOptimizer::profile ( double v )

protectedinherited

Print to the profile if there is one.

Parameters

v	The double value to print.

Definition at line 224 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

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

◆ profile() [2/3]

void AbstractOptimizer::profile ( unsigned int v )

protectedinherited

Print to the profile if there is one.

Parameters

v	The unsigned int value to print.

Definition at line 238 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

◆ profile() [3/3]

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

protectedinherited

Print to the profile if there is one.

Parameters

s	The string to print to the profile.

Definition at line 251 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

◆ profileln() [1/3]

void AbstractOptimizer::profileln ( double v )

protectedinherited

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

Parameters

v	The double value to print.

Definition at line 231 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

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

◆ profileln() [2/3]

void AbstractOptimizer::profileln ( unsigned int v )

protectedinherited

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

Parameters

v	The unsigned int value to print.

Definition at line 244 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

◆ profileln() [3/3]

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

protectedinherited

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

Parameters

s	The string to print to the profile.

Definition at line 258 of file AbstractOptimizer.cpp.

References bpp::AbstractOptimizer::profiler_.

◆ setConstraintPolicy()

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

inlinevirtualinherited

Set the constraint policy for this optimizer.

Parameters

constraintPolicy The 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().

◆ setDefaultStopCondition_()

void bpp::AbstractOptimizer::setDefaultStopCondition_ ( OptimizationStopCondition * osc )

inlineprotectedinherited

Definition at line 381 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::defaultStopCondition_.

Referenced by bpp::BfgsMultiDimensions::BfgsMultiDimensions(), bpp::BrentOneDimension::BrentOneDimension(), bpp::ConjugateGradientMultiDimensions::ConjugateGradientMultiDimensions(), bpp::DownhillSimplexMethod::DownhillSimplexMethod(), GoldenSectionSearch(), bpp::MetaOptimizer::MetaOptimizer(), bpp::NewtonBacktrackOneDimension::NewtonBacktrackOneDimension(), bpp::NewtonOneDimension::NewtonOneDimension(), bpp::PowellMultiDimensions::PowellMultiDimensions(), bpp::SimpleMultiDimensions::SimpleMultiDimensions(), and bpp::SimpleNewtonMultiDimensions::SimpleNewtonMultiDimensions().

◆ setFunction()

void bpp::AbstractOptimizer::setFunction ( Function * function )

inlinevirtualinherited

Set the function to optimize.

Parameters

function The function to optimize.

Implements bpp::Optimizer.

Reimplemented in bpp::MetaOptimizer, bpp::SimpleMultiDimensions, and bpp::SimpleNewtonMultiDimensions.

Definition at line 192 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::function_, bpp::OptimizationStopCondition::init(), and bpp::AbstractOptimizer::stopCondition_.

Referenced by bpp::SimpleNewtonMultiDimensions::setFunction(), bpp::SimpleMultiDimensions::setFunction(), and bpp::MetaOptimizer::setFunction().

◆ setInitialInterval()

void GoldenSectionSearch::setInitialInterval	(	double	inf,
		double	sup
	)

Set intial search interval.

Parameters

inf	Minimum value.
sup	Maximum value.

Definition at line 118 of file GoldenSectionSearch.cpp.

References isInitialIntervalSet_, xinf_, and xsup_.

◆ setMaximumNumberOfEvaluations()

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

inlinevirtualinherited

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

Parameters

max	The 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().

◆ setMessageHandler()

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

mh	The 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().

◆ setOptimizationProgressCharacter()

void bpp::AbstractOptimizer::setOptimizationProgressCharacter ( const std::string & c )

inlineinherited

Set the character to be displayed during optimization.

Parameters

c	A character.

Definition at line 261 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::stepChar_.

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

◆ setProfiler()

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

profiler The 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().

◆ setStopCondition()

void bpp::AbstractOptimizer::setStopCondition ( const OptimizationStopCondition & stopCondition )

inlinevirtualinherited

Set the stop condition of the optimization algorithm.

Parameters

stopCondition The stop condition to use while optimizing.

See also: OptimizationStopCondition.

Implements bpp::Optimizer.

Definition at line 212 of file AbstractOptimizer.h.

References bpp::OptimizationStopCondition::clone(), and bpp::AbstractOptimizer::stopCondition_.

Referenced by bpp::BfgsMultiDimensions::BfgsMultiDimensions(), bpp::BrentOneDimension::BrentOneDimension(), bpp::ConjugateGradientMultiDimensions::ConjugateGradientMultiDimensions(), bpp::DownhillSimplexMethod::DownhillSimplexMethod(), GoldenSectionSearch(), bpp::MetaOptimizer::MetaOptimizer(), bpp::NewtonBacktrackOneDimension::NewtonBacktrackOneDimension(), bpp::NewtonOneDimension::NewtonOneDimension(), bpp::PowellMultiDimensions::PowellMultiDimensions(), bpp::SimpleMultiDimensions::SimpleMultiDimensions(), and bpp::SimpleNewtonMultiDimensions::SimpleNewtonMultiDimensions().

◆ setVerbose()

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

v	verbose 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().

◆ step()

double AbstractOptimizer::step	(		)
throw	(	Exception
	)

virtualinherited

Basic implementation.

Check if the optimizer is initialized, check if parameters need update because of listeners, call the doStep method, print the current point to the profiler, notify all listeners and return the current value of the function.

Implements bpp::Optimizer.

Definition at line 188 of file AbstractOptimizer.cpp.

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

◆ updateParameters() [1/2]

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

yn	true/false

Definition at line 243 of file AbstractOptimizer.h.

References bpp::AbstractOptimizer::updateParameters_.

◆ updateParameters() [2/2]

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

◆ GSSStopCondition

friend class GSSStopCondition

friend

Definition at line 78 of file GoldenSectionSearch.h.

Referenced by GoldenSectionSearch().

Member Data Documentation

◆ currentValue_

double bpp::AbstractOptimizer::currentValue_

protectedinherited

The current value of the function.

Definition at line 141 of file AbstractOptimizer.h.

Referenced by bpp::NewtonOneDimension::doStep(), bpp::BfgsMultiDimensions::doStep(), getFunctionValue(), bpp::AbstractOptimizer::getFunctionValue(), bpp::BrentOneDimension::optimize(), bpp::AbstractOptimizer::optimize(), and bpp::AbstractOptimizer::step().

◆ f1

double bpp::GoldenSectionSearch::f1

private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep().

◆ f2

double bpp::GoldenSectionSearch::f2

private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep().

◆ isInitialIntervalSet_

bool bpp::GoldenSectionSearch::isInitialIntervalSet_

private

Definition at line 83 of file GoldenSectionSearch.h.

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

◆ nbEval_

unsigned int bpp::AbstractOptimizer::nbEval_

protectedinherited

The current number of function evaluations achieved.

Definition at line 136 of file AbstractOptimizer.h.

Referenced by bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::ConjugateGradientMultiDimensions::doStep(), bpp::BfgsMultiDimensions::doStep(), bpp::PowellMultiDimensions::doStep(), doStep(), bpp::DownhillSimplexMethod::doStep(), bpp::MetaOptimizer::doStep(), bpp::AbstractOptimizer::getNumberOfEvaluations(), bpp::AbstractOptimizer::isMaximumNumberOfEvaluationsReached(), bpp::AbstractOptimizer::operator=(), bpp::AbstractOptimizer::optimize(), bpp::AbstractOptimizer::printPoint(), and bpp::DownhillSimplexMethod::tryExtrapolation().

◆ nbEvalMax_

unsigned int bpp::AbstractOptimizer::nbEvalMax_

protectedinherited

The maximum number of function evaluations allowed.

Definition at line 131 of file AbstractOptimizer.h.

Referenced by bpp::DownhillSimplexMethod::DownhillSimplexMethod(), GoldenSectionSearch(), bpp::AbstractOptimizer::isMaximumNumberOfEvaluationsReached(), bpp::NewtonOneDimension::NewtonOneDimension(), bpp::AbstractOptimizer::operator=(), bpp::AbstractOptimizer::optimize(), and bpp::AbstractOptimizer::setMaximumNumberOfEvaluations().

◆ tolIsReached_

bool bpp::AbstractOptimizer::tolIsReached_

protectedinherited

Tell if the tolerance level has been reached.

This field is initilaised by the init() method, maintained by the step() method and used in the optimize() method.

Definition at line 149 of file AbstractOptimizer.h.

Referenced by bpp::NewtonOneDimension::doStep(), bpp::SimpleNewtonMultiDimensions::doStep(), bpp::SimpleMultiDimensions::doStep(), bpp::ConjugateGradientMultiDimensions::doStep(), bpp::BfgsMultiDimensions::doStep(), bpp::NewtonBacktrackOneDimension::doStep(), doStep(), bpp::MetaOptimizer::doStep(), bpp::AbstractOptimizer::isToleranceReached(), bpp::AbstractOptimizer::operator=(), bpp::AbstractOptimizer::optimize(), and bpp::AbstractOptimizer::step().

◆ x0

double bpp::GoldenSectionSearch::x0

private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep(), and bpp::GoldenSectionSearch::GSSStopCondition::getCurrentTolerance().

◆ x1

double bpp::GoldenSectionSearch::x1

private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep(), and bpp::GoldenSectionSearch::GSSStopCondition::getCurrentTolerance().

◆ x2

double bpp::GoldenSectionSearch::x2

private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep(), and bpp::GoldenSectionSearch::GSSStopCondition::getCurrentTolerance().

◆ x3

double bpp::GoldenSectionSearch::x3

private

Definition at line 81 of file GoldenSectionSearch.h.

Referenced by doStep(), and bpp::GoldenSectionSearch::GSSStopCondition::getCurrentTolerance().

◆ xinf_

double bpp::GoldenSectionSearch::xinf_

private

Definition at line 82 of file GoldenSectionSearch.h.

Referenced by setInitialInterval().

◆ xsup_

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:

Bpp/Numeric/Function/GoldenSectionSearch.h
Bpp/Numeric/Function/GoldenSectionSearch.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GoldenSectionSearch()

◆ ~GoldenSectionSearch()

Member Function Documentation

◆ addOptimizationListener()

◆ autoParameter()

◆ clone()

◆ doInit()

◆ doStep()

◆ fireOptimizationInitializationPerformed()

◆ fireOptimizationStepPerformed()

◆ getConstraintPolicy()

◆ getDefaultStopCondition() [1/2]

◆ getDefaultStopCondition() [2/2]

◆ getFunction() [1/2]

◆ getFunction() [2/2]

◆ getFunction_()

◆ getFunctionValue()

◆ getMessageHandler()

◆ getNumberOfEvaluations()

◆ getOptimizationProgressCharacter()

◆ getParameter_()

◆ getParameters()

◆ getParameters_()

◆ getParameterValue()

◆ getProfiler()

◆ getStopCondition() [1/2]

◆ getStopCondition() [2/2]

◆ getVerbose()

◆ hasFunction()

◆ ignoreConstraints()

◆ init()

◆ isInitialIntervalSet()

◆ isInitialized()

◆ isMaximumNumberOfEvaluationsReached()

◆ isToleranceReached()

◆ listenerModifiesParameters()

◆ optimize()

◆ printMessage()

◆ printPoint()

◆ profile() [1/3]

◆ profile() [2/3]

◆ profile() [3/3]

◆ profileln() [1/3]

◆ profileln() [2/3]

◆ profileln() [3/3]

◆ setConstraintPolicy()

◆ setDefaultStopCondition_()

◆ setFunction()

◆ setInitialInterval()

◆ setMaximumNumberOfEvaluations()

◆ setMessageHandler()

◆ setOptimizationProgressCharacter()

◆ setProfiler()

◆ setStopCondition()

◆ setVerbose()

◆ step()

◆ updateParameters() [1/2]

◆ updateParameters() [2/2]

Friends And Related Function Documentation

◆ GSSStopCondition

Member Data Documentation

◆ currentValue_

◆ f1

◆ f2

◆ isInitialIntervalSet_

◆ nbEval_

◆ nbEvalMax_

◆ tolIsReached_

◆ x0

◆ x1

◆ x2

◆ x3