bpp::PowellMultiDimensions::PMDStopCondition Class Reference

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

Inheritance diagram for bpp::PowellMultiDimensions::PMDStopCondition:

Collaboration diagram for bpp::PowellMultiDimensions::PMDStopCondition:

List of all members.

Public Member Functions
	PMDStopCondition (PowellMultiDimensions *pmd)
virtual	~PMDStopCondition ()
PMDStopCondition *	clone () const
	Create a copy of this object and send a pointer to it.
bool	isToleranceReached () const
	Tell if the we reached the desired tolerance with a given new set of estimates.
double	getCurrentTolerance () const
	Get the current tolerance.
const Optimizer *	getOptimizer () const
void	setOptimizer (const Optimizer *optimizer)
	Set the optimizer attached to this instance.
void	setTolerance (double tolerance)
	Set the tolerance parameter.
double	getTolerance () const
	Get the tolerance parameter.
void	init ()
	Initialize the condition.
virtual void	resetCounter ()
virtual void	setBurnin (int burnin)
virtual int	getBurnin () const
Protected Attributes
const Optimizer *	optimizer_
double	tolerance_
double	callCount_
	Count the number of times the isToleranceReached() function has been called.
int	burnin_

---

Detailed Description

Definition at line 63 of file PowellMultiDimensions.h.

---

Constructor & Destructor Documentation

bpp::PowellMultiDimensions::PMDStopCondition::PMDStopCondition

(

PowellMultiDimensions *

pmd

)

[inline]

Definition at line 67 of file PowellMultiDimensions.h.

Referenced by clone().

virtual bpp::PowellMultiDimensions::PMDStopCondition::~PMDStopCondition

(

)

[inline, virtual]

Definition at line 69 of file PowellMultiDimensions.h.

---

Member Function Documentation

PMDStopCondition* bpp::PowellMultiDimensions::PMDStopCondition::clone

(

)

const [inline, virtual]

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

Returns:

A pointer toward the copy object.

Implements bpp::OptimizationStopCondition.

Definition at line 71 of file PowellMultiDimensions.h.

References PMDStopCondition().

virtual int bpp::AbstractOptimizationStopCondition::getBurnin

(

)

const [inline, virtual, inherited]

Definition at line 211 of file OptimizationStopCondition.h.

double PowellMultiDimensions::PMDStopCondition::getCurrentTolerance

(

)

const [virtual]

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.

Implements bpp::OptimizationStopCondition.

Definition at line 55 of file PowellMultiDimensions.cpp.

References bpp::NumTools::abs(), bpp::PowellMultiDimensions::fp_, and bpp::PowellMultiDimensions::fret_.

Referenced by isToleranceReached().

const Optimizer* bpp::AbstractOptimizationStopCondition::getOptimizer

(

)

const [inline, virtual, inherited]

Returns:

The optimizer to which this instance belongs to.

Implements bpp::OptimizationStopCondition.

Definition at line 204 of file OptimizationStopCondition.h.

double bpp::AbstractOptimizationStopCondition::getTolerance

(

)

const [inline, virtual, inherited]

Get the tolerance parameter.

Returns:

The tolerance parameter.

Implements bpp::OptimizationStopCondition.

Definition at line 207 of file OptimizationStopCondition.h.

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

void bpp::AbstractOptimizationStopCondition::init

(

)

[inline, virtual, inherited]

Initialize the condition.

Implements bpp::OptimizationStopCondition.

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

Definition at line 208 of file OptimizationStopCondition.h.

bool PowellMultiDimensions::PMDStopCondition::isToleranceReached

(

)

const [virtual]

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.

Implements bpp::OptimizationStopCondition.

Definition at line 49 of file PowellMultiDimensions.cpp.

References bpp::AbstractOptimizationStopCondition::burnin_, bpp::AbstractOptimizationStopCondition::callCount_, getCurrentTolerance(), and bpp::AbstractOptimizationStopCondition::tolerance_.

virtual void bpp::AbstractOptimizationStopCondition::resetCounter

(

)

[inline, virtual, inherited]

Definition at line 209 of file OptimizationStopCondition.h.

virtual void bpp::AbstractOptimizationStopCondition::setBurnin

(

int

burnin

)

[inline, virtual, inherited]

Definition at line 210 of file OptimizationStopCondition.h.

void bpp::AbstractOptimizationStopCondition::setOptimizer

(

const Optimizer *

optimizer

)

[inline, virtual, inherited]

Set the optimizer attached to this instance.

Parameters:

optimizer

The optimizer to which this instance belongs to.

Implements bpp::OptimizationStopCondition.

Definition at line 205 of file OptimizationStopCondition.h.

void bpp::AbstractOptimizationStopCondition::setTolerance

(

double

tolerance

)

[inline, virtual, inherited]

Set the tolerance parameter.

Parameters:

tolerance

The tolerance parameter.

Implements bpp::OptimizationStopCondition.

Definition at line 206 of file OptimizationStopCondition.h.

---

Member Data Documentation

int bpp::AbstractOptimizationStopCondition::burnin_ [protected, inherited]

Definition at line 159 of file OptimizationStopCondition.h.

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

double bpp::AbstractOptimizationStopCondition::callCount_ [mutable, protected, inherited]

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

Definition at line 157 of file OptimizationStopCondition.h.

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

const Optimizer* bpp::AbstractOptimizationStopCondition::optimizer_ [protected, inherited]

Definition at line 150 of file OptimizationStopCondition.h.

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

double bpp::AbstractOptimizationStopCondition::tolerance_ [protected, inherited]

Definition at line 151 of file OptimizationStopCondition.h.

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

---

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

• Bpp/Numeric/Function/PowellMultiDimensions.h
• Bpp/Numeric/Function/PowellMultiDimensions.cpp