Partial implementation of the OptimizationStopCondition interface. More...

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

Inheritance diagram for bpp::AbstractOptimizationStopCondition:

Collaboration diagram for bpp::AbstractOptimizationStopCondition:

Public Member Functions
	AbstractOptimizationStopCondition (const Optimizer *optimizer)

	AbstractOptimizationStopCondition (const Optimizer *optimizer, double tolerance)

	AbstractOptimizationStopCondition (const Optimizer *optimizer, int burnin)

	AbstractOptimizationStopCondition (const Optimizer *optimizer, double tolerance, int burnin)

	AbstractOptimizationStopCondition (const AbstractOptimizationStopCondition &aosc)

AbstractOptimizationStopCondition &	operator= (const AbstractOptimizationStopCondition &aosc)

virtual	~AbstractOptimizationStopCondition ()

const Optimizer *	getOptimizer () const

void	setOptimizer (const Optimizer *optimizer)
	Set the optimizer attached to this instance. More...

void	setTolerance (double tolerance)
	Set the tolerance parameter. More...

double	getTolerance () const
	Get the tolerance parameter. More...

void	init ()
	Initialize the condition. More...

virtual void	resetCounter ()

virtual void	setBurnin (int burnin)

virtual int	getBurnin () const

OptimizationStopCondition *	clone () const =0
	Create a copy of this object and send a pointer to it. More...

virtual bool	isToleranceReached () const =0
	Tell if the we reached the desired tolerance with a given new set of estimates. More...

virtual double	getCurrentTolerance () const =0
	Get the current tolerance. More...

Protected Attributes
const Optimizer *	optimizer_

double	tolerance_

double	callCount_
	Count the number of times the isToleranceReached() function has been called. More...

int	burnin_

Detailed Description

Partial implementation of the OptimizationStopCondition interface.

This class provides:

A pointer toward the Optimizer this objet deals with,
A tolerance value,
A counter of the number of calls toward the isToleranceReached() function,
A burnin function, that prohibe the optimization to stop prematurely.

Definition at line 141 of file OptimizationStopCondition.h.

Constructor & Destructor Documentation

◆ AbstractOptimizationStopCondition() [1/5]

bpp::AbstractOptimizationStopCondition::AbstractOptimizationStopCondition ( const Optimizer * optimizer )

inline

Definition at line 157 of file OptimizationStopCondition.h.

◆ AbstractOptimizationStopCondition() [2/5]

bpp::AbstractOptimizationStopCondition::AbstractOptimizationStopCondition	(	const Optimizer *	optimizer,
		double	tolerance
	)

inline

Definition at line 163 of file OptimizationStopCondition.h.

◆ AbstractOptimizationStopCondition() [3/5]

bpp::AbstractOptimizationStopCondition::AbstractOptimizationStopCondition	(	const Optimizer *	optimizer,
		int	burnin
	)

inline

Definition at line 169 of file OptimizationStopCondition.h.

◆ AbstractOptimizationStopCondition() [4/5]

bpp::AbstractOptimizationStopCondition::AbstractOptimizationStopCondition	(	const Optimizer *	optimizer,
		double	tolerance,
		int	burnin
	)

inline

Definition at line 175 of file OptimizationStopCondition.h.

◆ AbstractOptimizationStopCondition() [5/5]

bpp::AbstractOptimizationStopCondition::AbstractOptimizationStopCondition ( const AbstractOptimizationStopCondition & aosc )

inline

Definition at line 181 of file OptimizationStopCondition.h.

◆ ~AbstractOptimizationStopCondition()

virtual bpp::AbstractOptimizationStopCondition::~AbstractOptimizationStopCondition ( )

inlinevirtual

Definition at line 196 of file OptimizationStopCondition.h.

Member Function Documentation

◆ clone()

OptimizationStopCondition* bpp::OptimizationStopCondition::clone ( ) const

pure virtualinherited

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

Returns: A pointer toward the copy object.

Implements bpp::Clonable.

Implemented in bpp::PowellMultiDimensions::PMDStopCondition, bpp::FunctionStopCondition, bpp::ParametersStopCondition, bpp::NewtonBacktrackOneDimension::NBODStopCondition, bpp::GoldenSectionSearch::GSSStopCondition, bpp::DownhillSimplexMethod::DSMStopCondition, and bpp::BrentOneDimension::BODStopCondition.

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

◆ getBurnin()

virtual int bpp::AbstractOptimizationStopCondition::getBurnin ( ) const

inlinevirtual

Definition at line 206 of file OptimizationStopCondition.h.

◆ getCurrentTolerance()

virtual double bpp::OptimizationStopCondition::getCurrentTolerance ( ) const

pure virtualinherited

Get the current tolerance.

This is computed from the last check performed. Initially, it is equal to the tolerance parameter.

Returns: The current tolerance achieved.

Implemented in bpp::PowellMultiDimensions::PMDStopCondition, bpp::FunctionStopCondition, bpp::ParametersStopCondition, bpp::NewtonBacktrackOneDimension::NBODStopCondition, bpp::GoldenSectionSearch::GSSStopCondition, bpp::DownhillSimplexMethod::DSMStopCondition, and bpp::BrentOneDimension::BODStopCondition.

◆ getOptimizer()

const Optimizer* bpp::AbstractOptimizationStopCondition::getOptimizer ( ) const

inlinevirtual

Returns: The optimizer to which this instance belongs to.

Implements bpp::OptimizationStopCondition.

Definition at line 199 of file OptimizationStopCondition.h.

◆ getTolerance()

double bpp::AbstractOptimizationStopCondition::getTolerance ( ) const

inlinevirtual

Get the tolerance parameter.

Returns: The tolerance parameter.

Implements bpp::OptimizationStopCondition.

Definition at line 202 of file OptimizationStopCondition.h.

Referenced by bpp::GoldenSectionSearch::GSSStopCondition::isToleranceReached().

◆ init()

void bpp::AbstractOptimizationStopCondition::init ( )

inlinevirtual

Initialize the condition.

Implements bpp::OptimizationStopCondition.

Reimplemented in bpp::FunctionStopCondition, and bpp::ParametersStopCondition.

Definition at line 203 of file OptimizationStopCondition.h.

Referenced by bpp::ParametersStopCondition::init(), and bpp::FunctionStopCondition::init().

◆ isToleranceReached()

virtual bool bpp::OptimizationStopCondition::isToleranceReached ( ) const

pure virtualinherited

Tell if the we reached the desired tolerance with a given new set of estimates.

The new parameter list is compared to the last estimates, and the lastParameterEstimates list is actulaized with the newParameters list.

Returns: True if the tolerance level is reached.

Implemented in bpp::PowellMultiDimensions::PMDStopCondition, bpp::FunctionStopCondition, bpp::ParametersStopCondition, bpp::NewtonBacktrackOneDimension::NBODStopCondition, bpp::GoldenSectionSearch::GSSStopCondition, bpp::DownhillSimplexMethod::DSMStopCondition, and bpp::BrentOneDimension::BODStopCondition.

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

◆ operator=()

AbstractOptimizationStopCondition& bpp::AbstractOptimizationStopCondition::operator= ( const AbstractOptimizationStopCondition & aosc )

inline

Definition at line 187 of file OptimizationStopCondition.h.

References burnin_, callCount_, optimizer_, and tolerance_.

◆ resetCounter()

virtual void bpp::AbstractOptimizationStopCondition::resetCounter ( )

inlinevirtual

Definition at line 204 of file OptimizationStopCondition.h.

◆ setBurnin()

virtual void bpp::AbstractOptimizationStopCondition::setBurnin ( int burnin )

inlinevirtual

Definition at line 205 of file OptimizationStopCondition.h.

◆ setOptimizer()

void bpp::AbstractOptimizationStopCondition::setOptimizer ( const Optimizer * optimizer )

inlinevirtual

Set the optimizer attached to this instance.

Parameters

optimizer The optimizer to which this instance belongs to.

Implements bpp::OptimizationStopCondition.

Definition at line 200 of file OptimizationStopCondition.h.

◆ setTolerance()

void bpp::AbstractOptimizationStopCondition::setTolerance ( double tolerance )

inlinevirtual

Set the tolerance parameter.

Parameters

tolerance The tolerance parameter.

Implements bpp::OptimizationStopCondition.

Definition at line 201 of file OptimizationStopCondition.h.

Member Data Documentation

◆ burnin_

int bpp::AbstractOptimizationStopCondition::burnin_

protected

Definition at line 154 of file OptimizationStopCondition.h.

Referenced by bpp::BrentOneDimension::BODStopCondition::BODStopCondition(), bpp::ParametersStopCondition::getCurrentTolerance(), bpp::FunctionStopCondition::getCurrentTolerance(), bpp::BrentOneDimension::BODStopCondition::isToleranceReached(), bpp::GoldenSectionSearch::GSSStopCondition::isToleranceReached(), bpp::ParametersStopCondition::isToleranceReached(), bpp::FunctionStopCondition::isToleranceReached(), bpp::PowellMultiDimensions::PMDStopCondition::isToleranceReached(), and operator=().

◆ callCount_

double bpp::AbstractOptimizationStopCondition::callCount_

mutableprotected

Count the number of times the isToleranceReached() function has been called.

Definition at line 152 of file OptimizationStopCondition.h.

Referenced by bpp::ParametersStopCondition::getCurrentTolerance(), bpp::FunctionStopCondition::getCurrentTolerance(), bpp::BrentOneDimension::BODStopCondition::isToleranceReached(), bpp::GoldenSectionSearch::GSSStopCondition::isToleranceReached(), bpp::ParametersStopCondition::isToleranceReached(), bpp::FunctionStopCondition::isToleranceReached(), bpp::PowellMultiDimensions::PMDStopCondition::isToleranceReached(), and operator=().

◆ optimizer_

const Optimizer* bpp::AbstractOptimizationStopCondition::optimizer_

protected

Definition at line 145 of file OptimizationStopCondition.h.

Referenced by bpp::ParametersStopCondition::init(), bpp::FunctionStopCondition::init(), bpp::BrentOneDimension::BODStopCondition::isToleranceReached(), bpp::ParametersStopCondition::isToleranceReached(), bpp::FunctionStopCondition::isToleranceReached(), and operator=().

◆ tolerance_

double bpp::AbstractOptimizationStopCondition::tolerance_

protected

Definition at line 146 of file OptimizationStopCondition.h.

Referenced by bpp::BrentOneDimension::BODStopCondition::BODStopCondition(), bpp::ParametersStopCondition::getCurrentTolerance(), bpp::FunctionStopCondition::getCurrentTolerance(), bpp::DownhillSimplexMethod::DSMStopCondition::isToleranceReached(), bpp::GoldenSectionSearch::GSSStopCondition::isToleranceReached(), bpp::ParametersStopCondition::isToleranceReached(), bpp::FunctionStopCondition::isToleranceReached(), bpp::PowellMultiDimensions::PMDStopCondition::isToleranceReached(), and operator=().

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

Bpp/Numeric/Function/OptimizationStopCondition.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractOptimizationStopCondition() [1/5]

◆ AbstractOptimizationStopCondition() [2/5]

◆ AbstractOptimizationStopCondition() [3/5]

◆ AbstractOptimizationStopCondition() [4/5]

◆ AbstractOptimizationStopCondition() [5/5]

◆ ~AbstractOptimizationStopCondition()

Member Function Documentation

◆ clone()

◆ getBurnin()

◆ getCurrentTolerance()

◆ getOptimizer()

◆ getTolerance()

◆ init()

◆ isToleranceReached()

◆ operator=()

◆ resetCounter()

◆ setBurnin()

◆ setOptimizer()

◆ setTolerance()

Member Data Documentation

◆ burnin_

◆ callCount_

◆ optimizer_

◆ tolerance_