Partial implementation of the Optimizer interface. More...

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

Inheritance diagram for bpp::AbstractOptimizer:

Collaboration diagram for bpp::AbstractOptimizer:

Public Member Functions
	AbstractOptimizer (Function *function=0)
	AbstractOptimizer (const AbstractOptimizer &opt)
AbstractOptimizer &	operator= (const AbstractOptimizer &opt)
virtual	~AbstractOptimizer ()
void	updateParameters (bool yn)
	Tell if we shall update all parameters after one optimization step.
bool	updateParameters () const
	Tell if we shall update all parameters after one optimization step.
void	setOptimizationProgressCharacter (const std::string &c)
	Set the character to be displayed during optimization.
const std::string &	getOptimizationProgressCharacter () const
Optimizer *	clone () const =0
	Create a copy of this object and send a pointer to it.
The Optimizer interface.
void	init (const ParameterList &params) throw (Exception)
	Basic implementation.
double	step () throw (Exception)
	Basic implementation.
double	optimize () throw (Exception)
	Basic implementation.
bool	isInitialized () const
const ParameterList &	getParameters () const
double	getParameterValue (const std::string &name) const
void	setFunction (Function *function)
	Set the function to optimize.
const Function *	getFunction () const
	Get the current function being optimized.
Function *	getFunction ()
	Get the current function being optimized.
bool	hasFunction () const
	Tell if a funciton is associatied to this optimizer.
double	getFunctionValue () const throw (NullPointerException)
	Get the current function value.
void	setMessageHandler (OutputStream *mh)
	Set the message handler for this optimizer.
OutputStream *	getMessageHandler () const
void	setProfiler (OutputStream *profiler)
	Set the profiler for this optimizer.
OutputStream *	getProfiler () const
unsigned int	getNumberOfEvaluations () const
	Get the number of function evaluations performed since the call of the init function.
void	setStopCondition (const OptimizationStopCondition &stopCondition)
	Set the stop condition of the optimization algorithm.
OptimizationStopCondition *	getStopCondition ()
	Get the stop condition of the optimization algorithm.
const OptimizationStopCondition *	getStopCondition () const
	Get the stop condition of the optimization algorithm.
OptimizationStopCondition *	getDefaultStopCondition ()
	Get the default stop condition of the optimization algorithm.
const OptimizationStopCondition *	getDefaultStopCondition () const
	Get the default stop condition of the optimization algorithm.
bool	isToleranceReached () const
	Tell if the tolerance level is reached.
bool	isMaximumNumberOfEvaluationsReached () const
	Tell if the maximum number of function evaluations is reached.
void	setMaximumNumberOfEvaluations (unsigned int max)
	Set the maximum number of function evaluation to perform during optimization.
void	setVerbose (unsigned int v)
	Set the verbose level.
unsigned int	getVerbose () const
	Get the verbose level.
void	setConstraintPolicy (const std::string &constraintPolicy)
	Set the constraint policy for this optimizer.
std::string	getConstraintPolicy () const
	Get the constraint policy for this optimizer.
void	addOptimizationListener (OptimizationListener *listener)
	Register a listener to this class.
Protected Member Functions
virtual void	doInit (const ParameterList &params)=0 throw (Exception)
	This function is called by the init() method and contains all calculations.
virtual double	doStep ()=0 throw (Exception)
	This function is called by the step() method and contains all calculations.
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.
void	ignoreConstraints ()
	Remove the constraints of all the arguments.
void	profile (double v)
	Print to the profile if there is one.
void	profile (unsigned int v)
	Print to the profile if there is one.
void	profile (const std::string &s)
	Print to the profile if there is one.
void	profileln (double v)
	Print to the profile if there is one and end line.
void	profileln (unsigned int v)
	Print to the profile if there is one and end line.
void	profileln (const std::string &s)
	Print to the profile if there is one and end line.
void	printPoint (const ParameterList &params, double value)
	Print parameters and corresponding function evaluation to profiler.
void	printMessage (const std::string &message)
	Give a message to print to the message handler.
void	fireOptimizationInitializationPerformed (const OptimizationEvent &event)
	Notify all listeners that optimizer initialization was performed.
void	fireOptimizationStepPerformed (const OptimizationEvent &event)
	Notify all listeners that an optimization step was performed.
bool	listenerModifiesParameters () const
Protected Attributes
unsigned int	nbEvalMax_
	The maximum number of function evaluations allowed.
unsigned int	nbEval_
	The current number of function evaluations achieved.
double	currentValue_
	The current value of the function.
bool	tolIsReached_
	Tell if the tolerance level has been reached.
Private Attributes
Function *	function_
	The function to optimize.
ParameterList	parameters_
	The parameters that will be optimized.
OutputStream *	messageHandler_
	The message handler.
OutputStream *	profiler_
	The profiler.
std::string	constraintPolicy_
	The constraint policy.
OptimizationStopCondition *	stopCondition_
	The stoping condition to use while optimizing.
OptimizationStopCondition *	defaultStopCondition_
	The default stoping condition to use while optimizing.
unsigned int	verbose_
	State of the verbose mode: > 0 = enabled.
bool	isInitialized_
	Check if the optimizer have been feeded with initial parameters values.
time_t	startTime_
std::vector < OptimizationListener * >	listeners_
bool	updateParameters_
std::string	stepChar_

Detailed Description

Partial implementation of the Optimizer interface.

This implementation is designed for unconstrained or simple-bounded optimization. You should not use it with global contraints. It also enables the gestion of listeners by maintaining a vector of pointers toward the listener. Important note: this list of listener is not duplicated in cas of copy of the Optimizer, as listeners are expected to be bounded ot a particular instance.:if expand("%") == ""|browse confirm w|else|confirm w|endif

Definition at line 59 of file AbstractOptimizer.h.

Constructor & Destructor Documentation

AbstractOptimizer::AbstractOptimizer ( Function * function = 0 )

Definition at line 54 of file AbstractOptimizer.cpp.

AbstractOptimizer::AbstractOptimizer ( const AbstractOptimizer & opt )

Definition at line 70 of file AbstractOptimizer.cpp.

References autoParameter(), bpp::OptimizationStopCondition::clone(), constraintPolicy_, bpp::AutoParameter::CONSTRAINTS_AUTO, bpp::AutoParameter::CONSTRAINTS_IGNORE, defaultStopCondition_, ignoreConstraints(), isInitialized_, bpp::OptimizationStopCondition::setOptimizer(), and stopCondition_.

virtual bpp::AbstractOptimizer::~AbstractOptimizer ( ) [inline, virtual]

Definition at line 158 of file AbstractOptimizer.h.

References defaultStopCondition_, and stopCondition_.

Member Function Documentation

void bpp::AbstractOptimizer::addOptimizationListener ( OptimizationListener * listener ) [inline, virtual]

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.

void AbstractOptimizer::printPoint	(	const ParameterList &	params,
		double	value
	)		`[protected]`

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation