This class is designed to facilitate the manipulation of parameters. More...

#include <Bpp/Numeric/Parameter.h>

Inheritance diagram for bpp::Parameter:

Collaboration diagram for bpp::Parameter:

Public Member Functions
	Parameter ()
	Default contructor. Creates a parameter with no name, no constraint, and a value of 0. More...

	Parameter (const std::string &name, double value, std::shared_ptr< Constraint > constraint=0, double precision=0)
	Build a new parameter. More...

	Parameter (const std::string &name, double value, std::shared_ptr< Constraint > constraint, bool precision)=delete

	Parameter (const Parameter &param)
	Copy constructor. More...

Parameter &	operator= (const Parameter &param)
	Assignment operator. More...

virtual	~Parameter ()

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

virtual void	setName (const std::string &name)
	Set the name of this parameter. More...

virtual void	setValue (double value)
	Set the value of this parameter. More...

void	setPrecision (double precision)
	Set the precision of this parameter. More...

virtual const std::string &	getName () const
	Get the name of this parameter. More...

virtual double	getValue () const
	Get the value of this parameter. More...

virtual double	getPrecision () const
	Get the precision of this parameter. More...

virtual const std::shared_ptr< Constraint >	getConstraint () const
	Return the constraint associated to this parameter if there is one. More...

virtual std::shared_ptr< Constraint >	getConstraint ()
	Return the constraint associated to this parameter if there is one. More...

virtual bool	hasConstraint () const
	Tells if this parameter has a constraint. More...

virtual std::shared_ptr< Constraint >	removeConstraint ()
	Remove the constraint associated to this parameter. More...

virtual void	setConstraint (std::shared_ptr< Constraint > constraint)
	Set a constraint to this parameter. More...

virtual void	addParameterListener (ParameterListener *listener, bool attachListener=true)
	Add a new listener to this parameter. More...

virtual void	removeParameterListener (const std::string &listenerId)
	Remove all listeners with a given id from this parameter. More...

virtual bool	hasParameterListener (const std::string &listenerId)
	Tell is there is a listener with a given id from this parameter. More...

Static Public Attributes
static const std::shared_ptr< IntervalConstraint >	R_PLUS

static const std::shared_ptr< IntervalConstraint >	R_PLUS_STAR

static const std::shared_ptr< IntervalConstraint >	R_MINUS

static const std::shared_ptr< IntervalConstraint >	R_MINUS_STAR

static const std::shared_ptr< IntervalConstraint >	PROP_CONSTRAINT_IN

static const std::shared_ptr< IntervalConstraint >	PROP_CONSTRAINT_EX

Protected Member Functions
void	fireParameterNameChanged (ParameterEvent &event)

void	fireParameterValueChanged (ParameterEvent &event)

void	fireParameterConstraintChanged (ParameterEvent &event)

Protected Attributes
std::string	name_

double	value_

double	precision_

std::shared_ptr< Constraint >	constraint_

std::vector< ParameterListener * >	listeners_

std::vector< bool >	listenerAttach_

Detailed Description

This class is designed to facilitate the manipulation of parameters.

A parameter object contains a value stored as a double. It also contains a name and optionaly a constraint. Constraint objects allows to apply restriction on the value of the parameter, for instance positive number, or a particular interval and so on.

See also: ParameterList, Parametrizable, Constraint.

Definition at line 133 of file Parameter.h.

Constructor & Destructor Documentation

◆ Parameter() [1/4]

bpp::Parameter::Parameter ( )

inline

Default contructor. Creates a parameter with no name, no constraint, and a value of 0.

Definition at line 150 of file Parameter.h.

Referenced by clone().

◆ Parameter() [2/4]

Parameter::Parameter	(	const std::string &	name,
		double	value,
		std::shared_ptr< Constraint >	constraint = `0`,
		double	precision = `0`
	)

Build a new parameter.

Parameters

name	The parameter name.
value	The parameter value.
constraint	An optional pointer toward a constraint Object. The constraint will be copied and attached to this instance.
precision	An optional parameter precision (default 0)

Exceptions

ConstraintException If the parameter value does not match the contraint.

Constructors:

Definition at line 59 of file Parameter.cpp.

References setPrecision(), and setValue().

◆ Parameter() [3/4]

bpp::Parameter::Parameter	(	const std::string &	name,
		double	value,
		std::shared_ptr< Constraint >	constraint,
		bool	precision
	)

delete

◆ Parameter() [4/4]

Parameter::Parameter ( const Parameter & param )

Copy constructor.

Definition at line 66 of file Parameter.cpp.

References listenerAttach_, and listeners_.

◆ ~Parameter()

Parameter::~Parameter ( )

virtual

Destructor:

Definition at line 99 of file Parameter.cpp.

References listenerAttach_, and listeners_.

Member Function Documentation

◆ addParameterListener()

virtual void bpp::Parameter::addParameterListener	(	ParameterListener *	listener,
		bool	attachListener = `true`
	)

inlinevirtual

Add a new listener to this parameter.

Parameters

listener	The listener to add.
attachListener	Tell if the parameter will own this listener. If so, deep copies will be made when cloning the parameter, and the listener will be destroyed upon destruction of the parameter or upon removal. Alternatively, only superficial copies will be made, and the listener will persist if the parameter is destroyed.

Definition at line 278 of file Parameter.h.

References listenerAttach_, and listeners_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters().

◆ clone()

Parameter* bpp::Parameter::clone ( ) const

inlinevirtual

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

Returns: A pointer toward the copy object.

Implements bpp::Clonable.

Reimplemented in bpp::TransformedParameter, bpp::PlaceboTransformedParameter, bpp::IntervalTransformedParameter, and bpp::RTransformedParameter.

Definition at line 177 of file Parameter.h.

References Parameter().

Referenced by bpp::ParameterList::addParameter(), bpp::AbstractParameterAliasable::aliasParameters(), bpp::ParameterList::getCommonParametersWith(), and bpp::ParameterList::setParameter().

◆ fireParameterConstraintChanged()

void bpp::Parameter::fireParameterConstraintChanged ( ParameterEvent & event )

inlineprotected

Definition at line 316 of file Parameter.h.

References listeners_.

◆ fireParameterNameChanged()

void bpp::Parameter::fireParameterNameChanged ( ParameterEvent & event )

inlineprotected

Definition at line 300 of file Parameter.h.

References listeners_.

Referenced by setName().

◆ fireParameterValueChanged()

void bpp::Parameter::fireParameterValueChanged ( ParameterEvent & event )

inlineprotected

Definition at line 308 of file Parameter.h.

References listeners_.

Referenced by setValue().

◆ getConstraint() [1/2]

virtual std::shared_ptr<Constraint> bpp::Parameter::getConstraint ( )

inlinevirtual

Return the constraint associated to this parameter if there is one.

Returns: A shared pointer toward the constraint, or NULL if there is no constraint.

Definition at line 242 of file Parameter.h.

References constraint_.

◆ getConstraint() [2/2]

virtual const std::shared_ptr<Constraint> bpp::Parameter::getConstraint ( ) const

inlinevirtual

Return the constraint associated to this parameter if there is one.

Returns: A shared pointer toward the constraint, or NULL if there is no constraint.

Definition at line 233 of file Parameter.h.

References constraint_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::ReparametrizationFunctionWrapper::init_(), bpp::ParameterList::matchParametersValues(), bpp::AliasParameterListener::parameterConstraintChanged(), bpp::ParameterList::setParametersValues(), and bpp::ParameterList::testParametersValues().

◆ getName()

virtual const std::string& bpp::Parameter::getName ( ) const

inlinevirtual

Get the name of this parameter.

Returns: The parameter name.

Definition at line 211 of file Parameter.h.

References name_.

Referenced by bpp::ParameterList::addParameter(), bpp::AbstractParameterAliasable::addParameter_(), bpp::AbstractParameterAliasable::deleteParameter_(), bpp::ParameterList::getCommonParametersWith(), bpp::ParametersStopCondition::getCurrentTolerance(), bpp::NumCalcApplicationTools::getDefaultValue(), bpp::ParameterList::getParameter(), bpp::ParameterList::getParameterValue(), bpp::ParameterList::hasParameter(), bpp::ReparametrizationFunctionWrapper::init_(), bpp::ParametersStopCondition::isToleranceReached(), bpp::AliasParameterListener::parameterConstraintChanged(), bpp::AliasParameterListener::parameterValueChanged(), and bpp::FullHmmTransitionMatrix::setTransitionProbabilities().

◆ getPrecision()

virtual double bpp::Parameter::getPrecision ( ) const

inlinevirtual

Get the precision of this parameter.

Returns: The precision value.

Definition at line 225 of file Parameter.h.

References precision_.

◆ getValue()

virtual double bpp::Parameter::getValue ( ) const

inlinevirtual

Get the value of this parameter.

Returns: The parameter value.

Definition at line 218 of file Parameter.h.

References value_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::ParametersStopCondition::getCurrentTolerance(), bpp::NumCalcApplicationTools::getDefaultValue(), bpp::RTransformedParameter::getFirstOrderDerivative(), bpp::IntervalTransformedParameter::getFirstOrderDerivative(), bpp::RTransformedParameter::getOriginalValue(), bpp::IntervalTransformedParameter::getOriginalValue(), bpp::PlaceboTransformedParameter::getOriginalValue(), bpp::AbstractParametrizable::getParameterValue(), bpp::ParameterList::getParameterValue(), bpp::RTransformedParameter::getSecondOrderDerivative(), bpp::IntervalTransformedParameter::getSecondOrderDerivative(), bpp::TestFunction::getValue(), bpp::ReparametrizationFunctionWrapper::init_(), bpp::ParametersStopCondition::isToleranceReached(), bpp::ParameterList::matchParametersValues(), bpp::ParameterList::setAllParametersValues(), bpp::ParameterList::setParametersValues(), and bpp::ParameterList::testParametersValues().

◆ hasConstraint()

virtual bool bpp::Parameter::hasConstraint ( ) const

inlinevirtual

Tells if this parameter has a constraint.

Returns: True if this parameter has a contraint.

Definition at line 249 of file Parameter.h.

References constraint_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::ParameterList::matchParametersValues(), bpp::ParameterList::setParametersValues(), and bpp::ParameterList::testParametersValues().

◆ hasParameterListener()

bool Parameter::hasParameterListener ( const std::string & listenerId )

virtual

Tell is there is a listener with a given id from this parameter.

Parameters

listenerId The id of listener to remove.

Returns: True if at list one listener with the given id was found.

Definition at line 165 of file Parameter.cpp.

References listeners_.

◆ operator=()

Parameter & Parameter::operator= ( const Parameter & param )

Assignment operator.

Definition at line 81 of file Parameter.cpp.

References constraint_, listenerAttach_, listeners_, name_, precision_, and value_.

Referenced by bpp::AutoParameter::operator=().

◆ removeConstraint()

std::shared_ptr< Constraint > Parameter::removeConstraint ( )

virtual

Remove the constraint associated to this parameter.

Warning! The contraint objet is not deleted.

Returns: A pointer toward the formerly used contraint.

Definition at line 140 of file Parameter.cpp.

References constraint_.

Referenced by bpp::SimpleDiscreteDistribution::restrictToConstraint().

◆ removeParameterListener()

void Parameter::removeParameterListener ( const std::string & listenerId )

virtual

Remove all listeners with a given id from this parameter.

Parameters

listenerId The id of listener to remove.

Definition at line 149 of file Parameter.cpp.

References listenerAttach_, and listeners_.

Referenced by bpp::AbstractParameterAliasable::unaliasParameters().

◆ setConstraint()

void Parameter::setConstraint ( std::shared_ptr< Constraint > constraint )

virtual

Set a constraint to this parameter.

Parameters

constraint a pointer to the constraint (may be null)

Constraint:

Definition at line 131 of file Parameter.cpp.

References constraint_, and value_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::AliasParameterListener::parameterConstraintChanged(), bpp::ConstantDistribution::restrictToConstraint(), bpp::SimpleDiscreteDistribution::restrictToConstraint(), and bpp::TruncatedExponentialDiscreteDistribution::restrictToConstraint().

◆ setName()

virtual void bpp::Parameter::setName ( const std::string & name )

inlinevirtual

Set the name of this parameter.

Parameters

name	the new parameter name.

Definition at line 185 of file Parameter.h.

References fireParameterNameChanged(), and name_.

Referenced by bpp::ParametrizableCollection< N >::addObject(), and bpp::FullHmmTransitionMatrix::setTransitionProbabilities().

◆ setPrecision()

void Parameter::setPrecision ( double precision )

Set the precision of this parameter.

Parameters

precision the new parameter precision.

Precision:

Definition at line 124 of file Parameter.cpp.

References precision_.

Referenced by Parameter().

◆ setValue()

void Parameter::setValue ( double value )

virtual

Set the value of this parameter.

Parameters

value the new parameter value.

Value:

Reimplemented in bpp::AutoParameter.

Definition at line 110 of file Parameter.cpp.

References constraint_, fireParameterValueChanged(), precision_, and value_.

Referenced by bpp::BrentOneDimension::doInit(), bpp::GoldenSectionSearch::doInit(), bpp::BrentOneDimension::doStep(), bpp::GoldenSectionSearch::doStep(), bpp::NewtonBacktrackOneDimension::doStep(), bpp::ReparametrizationFunctionWrapper::fireParameterChanged(), bpp::ParameterList::matchParametersValues(), Parameter(), bpp::AliasParameterListener::parameterValueChanged(), bpp::ParameterList::setAllParametersValues(), bpp::RTransformedParameter::setOriginalValue(), bpp::IntervalTransformedParameter::setOriginalValue(), bpp::PlaceboTransformedParameter::setOriginalValue(), bpp::ParameterList::setParametersValues(), bpp::ParameterList::setParameterValue(), and bpp::AutoParameter::setValue().

Member Data Documentation

◆ constraint_

std::shared_ptr<Constraint> bpp::Parameter::constraint_

protected

Definition at line 140 of file Parameter.h.

Referenced by getConstraint(), hasConstraint(), operator=(), removeConstraint(), setConstraint(), bpp::AutoParameter::setValue(), and setValue().

◆ listenerAttach_

std::vector<bool> bpp::Parameter::listenerAttach_

protected

Definition at line 142 of file Parameter.h.

Referenced by addParameterListener(), operator=(), Parameter(), removeParameterListener(), and ~Parameter().

◆ listeners_

std::vector<ParameterListener*> bpp::Parameter::listeners_

protected

Definition at line 141 of file Parameter.h.

Referenced by addParameterListener(), fireParameterConstraintChanged(), fireParameterNameChanged(), fireParameterValueChanged(), hasParameterListener(), operator=(), Parameter(), removeParameterListener(), and ~Parameter().

◆ name_

std::string bpp::Parameter::name_

protected

Definition at line 137 of file Parameter.h.

Referenced by getName(), operator=(), setName(), and bpp::AutoParameter::setValue().

◆ precision_

double bpp::Parameter::precision_

protected

Definition at line 139 of file Parameter.h.

Referenced by getPrecision(), operator=(), setPrecision(), and setValue().

◆ PROP_CONSTRAINT_EX

const std::shared_ptr< IntervalConstraint > Parameter::PROP_CONSTRAINT_EX

static

Definition at line 330 of file Parameter.h.

Referenced by bpp::AutoCorrelationTransitionMatrix::AutoCorrelationTransitionMatrix(), and bpp::Simplex::Simplex().

◆ PROP_CONSTRAINT_IN

const std::shared_ptr< IntervalConstraint > Parameter::PROP_CONSTRAINT_IN

static

Definition at line 329 of file Parameter.h.

Referenced by bpp::InvariantMixedDiscreteDistribution::InvariantMixedDiscreteDistribution(), bpp::MixtureOfDiscreteDistributions::MixtureOfDiscreteDistributions(), bpp::SimpleDiscreteDistribution::SimpleDiscreteDistribution(), and bpp::Simplex::Simplex().

◆ R_MINUS

const std::shared_ptr< IntervalConstraint > Parameter::R_MINUS

static

Definition at line 327 of file Parameter.h.

◆ R_MINUS_STAR

const std::shared_ptr< IntervalConstraint > Parameter::R_MINUS_STAR

static

Definition at line 328 of file Parameter.h.

◆ R_PLUS

const std::shared_ptr< IntervalConstraint > Parameter::R_PLUS

static

Definition at line 325 of file Parameter.h.

Referenced by bpp::ExponentialDiscreteDistribution::ExponentialDiscreteDistribution(), and bpp::TruncatedExponentialDiscreteDistribution::TruncatedExponentialDiscreteDistribution().

◆ R_PLUS_STAR

const std::shared_ptr< IntervalConstraint > Parameter::R_PLUS_STAR

static

Definition at line 326 of file Parameter.h.

Referenced by bpp::GaussianDiscreteDistribution::GaussianDiscreteDistribution().

◆ value_

double bpp::Parameter::value_

protected

Definition at line 138 of file Parameter.h.

Referenced by getValue(), operator=(), setConstraint(), and setValue().

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

Bpp/Numeric/Parameter.h
Bpp/Numeric/Parameter.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Parameter() [1/4]

◆ Parameter() [2/4]

◆ Parameter() [3/4]

◆ Parameter() [4/4]

◆ ~Parameter()

Member Function Documentation

◆ addParameterListener()

◆ clone()

◆ fireParameterConstraintChanged()

◆ fireParameterNameChanged()

◆ fireParameterValueChanged()

◆ getConstraint() [1/2]

◆ getConstraint() [2/2]

◆ getName()

◆ getPrecision()

◆ getValue()

◆ hasConstraint()

◆ hasParameterListener()

◆ operator=()

◆ removeConstraint()

◆ removeParameterListener()

◆ setConstraint()

◆ setName()

◆ setPrecision()

◆ setValue()

Member Data Documentation

◆ constraint_

◆ listenerAttach_

◆ listeners_

◆ name_

◆ precision_

◆ PROP_CONSTRAINT_EX

◆ PROP_CONSTRAINT_IN

◆ R_MINUS

◆ R_MINUS_STAR

◆ R_PLUS

◆ R_PLUS_STAR

◆ value_