Interface for multiple discrete distribution objects. More...

#include <Bpp/Numeric/Prob/MultipleDiscreteDistribution.h>

Inheritance diagram for bpp::MultipleDiscreteDistribution:

Collaboration diagram for bpp::MultipleDiscreteDistribution:

Public Member Functions
	MultipleDiscreteDistribution ()

virtual	~MultipleDiscreteDistribution ()

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

virtual size_t	getNumberOfCategories () const =0

virtual Vdouble	getValueCategory (Vdouble &Vvalue) const =0

virtual double	getProbability (Vdouble &category) const =0

virtual Vdouble	rand () const =0
	Draw a random vector from this distribution. More...

virtual Vdouble	randC () const =0
	Draw a random vector from the continuous version of this distribution, if it exists. More...

virtual size_t	getNumberOfIndependentParameters () const =0
	Get the number of independent parameters. More...

virtual void	aliasParameters (const std::string &p1, const std::string &p2)=0
	Set two parameters as 'aliased'. More...

virtual void	aliasParameters (std::map< std::string, std::string > &unparsedParams, bool verbose)=0
	alias the parameters following the links described in a map, and update the object accordingly. Cycles in aliasing are detected and forbidden. More...

virtual void	unaliasParameters (const std::string &p1, const std::string &p2)=0
	Detach two parameters previously set as 'aliased'. More...

virtual const ParameterList &	getIndependentParameters () const =0
	Get the minimal list of parameters to set the model. More...

virtual std::vector< std::string >	getAlias (const std::string &name) const =0

virtual std::map< std::string, std::string >	getAliases () const =0

virtual bool	hasParameter (const std::string &name) const =0
	Tell if there is a parameter with specified name. More...

virtual const ParameterList &	getParameters () const =0
	Get all parameters available. More...

virtual const Parameter &	parameter (const std::string &name) const =0
	Get the parameter with specified name. More...

virtual double	getParameterValue (const std::string &name) const =0
	Get the value for parameter of name 'name'. More...

virtual void	setAllParametersValues (const ParameterList &parameters)=0
	Set the parameters values to be equals to those of parameters. More...

virtual void	setParameterValue (const std::string &name, double value)=0
	Set the value of parameter with name name to be equal to value. More...

virtual void	setParametersValues (const ParameterList &parameters)=0
	Update the parameters from parameters. More...

virtual bool	matchParametersValues (const ParameterList &parameters)=0
	Update the parameters from parameters. More...

virtual void	removeConstraint (const std::string &name)=0
	Remove the constraint associated with one parameter, if any. More...

virtual void	setConstraint (const std::string &name, std::shared_ptr< ConstraintInterface > constraint)=0
	Set/Change the constraint associated with one parameter. More...

virtual size_t	getNumberOfParameters () const =0
	Get the number of parameters. More...

virtual void	setNamespace (const std::string &prefix)=0
	Set the namespace for the parameter names. More...

virtual std::string	getNamespace () const =0

virtual std::string	getParameterNameWithoutNamespace (const std::string &name) const =0
	Resolves a parameter name according to the current namespace. More...

Protected Member Functions
virtual ParameterList &	getParameters_ ()=0
	Get all parameters available. More...

Detailed Description

Interface for multiple discrete distribution objects.

A multiple discrete distribution usually contains a vector of finite set of categories and a probability associated to each. The size of the vector is the dimension of the distribution.

Each category (or class) is defined by two bounds, and sometimes by a mean or a median value.

A multiple discrete distribution may contain one or several parameters. The probabilities associated to each class usually depends on the parameter values. In some cases, the number and/or bounds of the classes may also depend on the parameters values, depending on the kind of discretization used.

Definition at line 33 of file MultipleDiscreteDistribution.h.

Constructor & Destructor Documentation

◆ MultipleDiscreteDistribution()

bpp::MultipleDiscreteDistribution::MultipleDiscreteDistribution ( )

inline

Definition at line 37 of file MultipleDiscreteDistribution.h.

◆ ~MultipleDiscreteDistribution()

virtual bpp::MultipleDiscreteDistribution::~MultipleDiscreteDistribution ( )

inlinevirtual

Definition at line 39 of file MultipleDiscreteDistribution.h.

References clone(), getNumberOfCategories(), getProbability(), getValueCategory(), rand(), and randC().

Member Function Documentation

◆ aliasParameters() [1/2]

virtual void bpp::ParameterAliasable::aliasParameters	(	const std::string &	p1,
		const std::string &	p2
	)

pure virtualinherited

Set two parameters as 'aliased'.

The values of the two parameters will be synchronized, so that setting the value of one parameter will automatically set the value of the other one accordingly.

Parameters

p1	Original parameter.
p2	Aliased parameter.

Exceptions

ParameterNotFoundException	if p1 or p2 do not correspond to existing parameters.
Exception	when trying to perform non-valid association.

Implemented in bpp::AbstractParameterAliasable.

Referenced by bpp::ParameterAliasable::~ParameterAliasable().

◆ aliasParameters() [2/2]

virtual void bpp::ParameterAliasable::aliasParameters	(	std::map< std::string, std::string > &	unparsedParams,
		bool	verbose
	)

pure virtualinherited

alias the parameters following the links described in a map, and update the object accordingly. Cycles in aliasing are detected and forbidden.

Parameters

unparsedParams	the map of the links : <A,B> matches for A->B aliasing.
verbose	verbosity

Implemented in bpp::AbstractParameterAliasable.

◆ clone()

MultipleDiscreteDistribution* bpp::MultipleDiscreteDistribution::clone ( ) const

pure virtual

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::DirichletDiscreteDistribution.

Referenced by ~MultipleDiscreteDistribution().

◆ getAlias()

virtual std::vector<std::string> bpp::ParameterAliasable::getAlias ( const std::string & name ) const

pure virtualinherited

Returns: The list of names of the parameters that are aliased with a given parameter. Depending on the implementation, the function may be recursive or not...

Parameters

name	The name of the parameter to look for.

Implemented in bpp::AbstractParameterAliasable.

Referenced by bpp::ParametrizableCollection< N >::addObject(), bpp::BppOParametrizableFormat::write(), and bpp::ParameterAliasable::~ParameterAliasable().

◆ getAliases()

virtual std::map<std::string, std::string> bpp::ParameterAliasable::getAliases ( ) const

pure virtualinherited

Returns: the map of the aliases.

Implemented in bpp::AbstractParameterAliasable.

Referenced by bpp::ParameterAliasable::~ParameterAliasable().

◆ getIndependentParameters()

virtual const ParameterList& bpp::ParameterAliasable::getIndependentParameters ( ) const

pure virtualinherited

Get the minimal list of parameters to set the model.

If no parameters are aliased, this is the same a getParameters().

Returns: A minimal set of parameters.

Implemented in bpp::AbstractParameterAliasable.

Referenced by bpp::BppODiscreteDistributionFormat::initialize_(), bpp::BppOParametrizableFormat::write(), bpp::BppODiscreteDistributionFormat::writeDiscreteDistribution(), and bpp::ParameterAliasable::~ParameterAliasable().

◆ getNamespace()

virtual std::string bpp::Parametrizable::getNamespace ( ) const

pure virtualinherited

Returns: The current namespace used. This is an empty string if no namespace is currently defined.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ getNumberOfCategories()

virtual size_t bpp::MultipleDiscreteDistribution::getNumberOfCategories ( ) const

pure virtual

Returns: The number of categories

Implemented in bpp::DirichletDiscreteDistribution.

Referenced by ~MultipleDiscreteDistribution().

◆ getNumberOfIndependentParameters()

virtual size_t bpp::ParameterAliasable::getNumberOfIndependentParameters ( ) const

pure virtualinherited

Get the number of independent parameters.

Returns: The number of independent parameters. If no parameters are aliased, this is equivalent to the getNumberOfParameters() method.

Implemented in bpp::AbstractParameterAliasable.

Referenced by bpp::ParameterAliasable::~ParameterAliasable().

◆ getNumberOfParameters()

virtual size_t bpp::Parametrizable::getNumberOfParameters ( ) const

pure virtualinherited

Get the number of parameters.

See also: getNumberOfIndependentParameters If some parameters are aliased.

Returns: The number of parameters.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, bpp::AbstractParametrizable, and bpp::DirectionFunction.

Referenced by bpp::BppODiscreteDistributionFormat::writeDiscreteDistribution(), and bpp::Parametrizable::~Parametrizable().

◆ getParameterNameWithoutNamespace()

virtual std::string bpp::Parametrizable::getParameterNameWithoutNamespace ( const std::string & name ) const

pure virtualinherited

Resolves a parameter name according to the current namespace.

Returns: The parameter name without the namespace prefix, if any.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), bpp::BppOParametrizableFormat::write(), and bpp::Parametrizable::~Parametrizable().

◆ getParameters()

virtual const ParameterList& bpp::Parametrizable::getParameters ( ) const

pure virtualinherited

Get all parameters available.

See also: getIndependentParameters if some parameters are aliased.

Returns: A list with all parameters available.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, bpp::DirectionFunction, and bpp::AbstractParametrizable.

Referenced by bpp::ParameterAliasableAdapter::getIndependentParameters(), bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), bpp::BppOParametrizableFormat::write(), and bpp::Parametrizable::~Parametrizable().

◆ getParameters_()

virtual ParameterList& bpp::Parametrizable::getParameters_ ( )

protectedpure virtualinherited

Get all parameters available.

See also: getIndependentParameters if some parameters are aliased.

Returns: A list with all parameters available.

Implemented in bpp::FunctionWrapper, bpp::AbstractParametrizable, and bpp::DirectionFunction.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ getParameterValue()

virtual double bpp::Parametrizable::getParameterValue ( const std::string & name ) const

pure virtualinherited

Get the value for parameter of name 'name'.

Parameters

name	The name of the parameter.

Returns: the value of parameter name.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), and bpp::Parametrizable::~Parametrizable().

◆ getProbability()

virtual double bpp::MultipleDiscreteDistribution::getProbability ( Vdouble & category ) const

pure virtual

Parameters

category The vector of values associated to the class.

Returns: The probability associated to a given class.

Implemented in bpp::DirichletDiscreteDistribution.

Referenced by ~MultipleDiscreteDistribution().

◆ getValueCategory()

virtual Vdouble bpp::MultipleDiscreteDistribution::getValueCategory ( Vdouble & Vvalue ) const

pure virtual

Parameters

Vvalue The vector of values to check.

Returns: The vector of categories of the classes the value is in. Throws a ConstraintException if the value is off the domain of the MultipleDiscreteDistribution.

Implemented in bpp::DirichletDiscreteDistribution.

Referenced by ~MultipleDiscreteDistribution().

◆ hasParameter()

virtual bool bpp::Parametrizable::hasParameter ( const std::string & name ) const

pure virtualinherited

Tell if there is a parameter with specified name.

Parameters

name	The name of the parameter to look for.

Returns: y/n.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ matchParametersValues()

virtual bool bpp::Parametrizable::matchParametersValues ( const ParameterList & parameters )

pure virtualinherited

Update the parameters from parameters.

Only common parameters with parameters will be updated.

Parameters

parameters A list of parameters.

Returns: True if at least one parameter value has been changed.

Exceptions

ConstraintException If a value in parameters does not match the constraint in the corresponding parameter in the list.

Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::BppODiscreteDistributionFormat::initialize_(), bpp::TestFunction::setParameters(), and bpp::Parametrizable::~Parametrizable().

◆ parameter()

virtual const Parameter& bpp::Parametrizable::parameter ( const std::string & name ) const

pure virtualinherited

Get the parameter with specified name.

Parameters

name	The name of the parameter to look for.

Returns: The parameter with given name.

Exceptions

ParameterNotFoundException if no parameter with this name is found.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::TestFunction::getValue(), and bpp::Parametrizable::~Parametrizable().

◆ rand()

virtual Vdouble bpp::MultipleDiscreteDistribution::rand ( ) const

pure virtual

Draw a random vector from this distribution.

This vector will be one of the class values, drawn according to the class probabilities.

Returns: A random number according to this distribution.

Implemented in bpp::DirichletDiscreteDistribution.

Referenced by ~MultipleDiscreteDistribution().

◆ randC()

virtual Vdouble bpp::MultipleDiscreteDistribution::randC ( ) const

pure virtual

Draw a random vector from the continuous version of this distribution, if it exists.

Uses the continuous version of this distribution to draw a random vector.

Returns: A random vector according to this distribution.

Exceptions

Exception If there is no continuous version of this distribution.

Implemented in bpp::DirichletDiscreteDistribution.

Referenced by ~MultipleDiscreteDistribution().

◆ removeConstraint()

virtual void bpp::Parametrizable::removeConstraint ( const std::string & name )

pure virtualinherited

Remove the constraint associated with one parameter, if any.

Parameters

name	The name of the parameter to look for.

Exceptions

ParameterNotFoundException if no parameter with this name is found.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ setAllParametersValues()

virtual void bpp::Parametrizable::setAllParametersValues ( const ParameterList & parameters )

pure virtualinherited

Set the parameters values to be equals to those of parameters.

The list must contain exactly the same parameters (ie same names) than the parameters available.

Parameters

parameters A list with all parameters.

Exceptions

ParameterNotFoundException	If a some parameter in the list is not in params.
ConstraintException	If a value in parameters does not match the constraint in the corresponding parameter in the list.

Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ setConstraint()

virtual void bpp::Parametrizable::setConstraint	(	const std::string &	name,
		std::shared_ptr< ConstraintInterface >	constraint
	)

pure virtualinherited

Set/Change the constraint associated with one parameter.

Parameters

name	The name of the parameter to look for.
constraint	A pointer to the constraint (may be null)

Exceptions

ParameterNotFoundException if no parameter with this name is found.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ setNamespace()

virtual void bpp::Parametrizable::setNamespace ( const std::string & prefix )

pure virtualinherited

Set the namespace for the parameter names.

Parameters

prefix The 'namespace', that is a prefix to add to all parameter names. If parameter names are already prefixed, the new prefix will be used instead.

Implemented in bpp::FunctionWrapper, bpp::ParametrizableAdapter, bpp::LogsumHmmLikelihood, bpp::RescaledHmmLikelihood, bpp::LowMemoryRescaledHmmLikelihood, bpp::AbstractParameterAliasable, bpp::MixtureOfDiscreteDistributions, bpp::AbstractParametrizable, and bpp::InvariantMixedDiscreteDistribution.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ setParametersValues()

virtual void bpp::Parametrizable::setParametersValues ( const ParameterList & parameters )

pure virtualinherited

Update the parameters from parameters.

parameters must be a subset of all parameters available.

Parameters

parameters A list containing all parameters to update.

Exceptions

ParameterNotFoundException	If a some parameter in params is not in the list.
ConstraintException	If a value in parameters does not match the constraint in the corresponding parameter in the list.

Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ setParameterValue()

virtual void bpp::Parametrizable::setParameterValue	(	const std::string &	name,
		double	value
	)

pure virtualinherited

Set the value of parameter with name name to be equal to value.

Parameters

name	the name of the parameter to set.
value	The value of the parameter.

Exceptions

ParameterNotFoundException	If no parameter in the list has the name name.
ConstraintException	If value does not match the constraint associated to parameter name.

Implemented in bpp::InfinityFunctionWrapper, bpp::FunctionWrapper, bpp::AbstractNumericalDerivative, bpp::ParametrizableAdapter, and bpp::AbstractParametrizable.

Referenced by bpp::Parametrizable::~Parametrizable().

◆ unaliasParameters()

virtual void bpp::ParameterAliasable::unaliasParameters	(	const std::string &	p1,
		const std::string &	p2
	)

pure virtualinherited

Detach two parameters previously set as 'aliased'.

The values of the two parameters will now be independent.

Parameters

p1	Original parameter.
p2	Aliased parameter.

Exceptions

ParameterNotFoundException	if p1 or p2 do not correspond to existing parameters.
Exception	when trying to perform non-valid dissociation.

Implemented in bpp::AbstractParameterAliasable.

Referenced by bpp::ParameterAliasable::~ParameterAliasable().

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

Bpp/Numeric/Prob/MultipleDiscreteDistribution.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MultipleDiscreteDistribution()

◆ ~MultipleDiscreteDistribution()

Member Function Documentation

◆ aliasParameters() [1/2]

◆ aliasParameters() [2/2]

◆ clone()

◆ getAlias()

◆ getAliases()

◆ getIndependentParameters()

◆ getNamespace()

◆ getNumberOfCategories()

◆ getNumberOfIndependentParameters()

◆ getNumberOfParameters()

◆ getParameterNameWithoutNamespace()

◆ getParameters()

◆ getParameters_()

◆ getParameterValue()

◆ getProbability()

◆ getValueCategory()

◆ hasParameter()

◆ matchParametersValues()

◆ parameter()

◆ rand()

◆ randC()

◆ removeConstraint()

◆ setAllParametersValues()

◆ setConstraint()

◆ setNamespace()

◆ setParametersValues()

◆ setParameterValue()

◆ unaliasParameters()