Describe the auto-correlation probabilities inside hidden states of a Hidden Markov Model. More...

#include <Bpp/Numeric/Hmm/AutoCorrelationTransitionMatrix.h>

Inheritance diagram for bpp::AutoCorrelationTransitionMatrix:

Collaboration diagram for bpp::AutoCorrelationTransitionMatrix:

Public Member Functions
	AutoCorrelationTransitionMatrix (std::shared_ptr< const HmmStateAlphabet > alph, const std::string &prefix="")

	AutoCorrelationTransitionMatrix (const AutoCorrelationTransitionMatrix &hptm)

AutoCorrelationTransitionMatrix &	operator= (const AutoCorrelationTransitionMatrix &hptm)

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

double	Pij (size_t i, size_t j) const override
	Get the transition probability between two states. More...

const Matrix< double > &	getPij () const override
	Get all transition probabilities as a matrix. More...

const std::vector< double > &	getEquilibriumFrequencies () const override

void	fireParameterChanged (const ParameterList &parameters) override
	Notify the class when one or several parameters have changed. More...

std::shared_ptr< const HmmStateAlphabet >	getHmmStateAlphabet () const

const HmmStateAlphabet &	hmmStateAlphabet () const

void	setHmmStateAlphabet (std::shared_ptr< const HmmStateAlphabet > stateAlphabet)
	Set the new hidden state alphabet. More...

size_t	getNumberOfStates () const

std::vector< size_t >	sample (size_t size) const
	sampling of a sequence of states. Starting point is sampled from the equilibrium distribution. More...

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

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

const ParameterList &	getParameters () const override
	Get all parameters available. More...

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

const std::shared_ptr< Parameter > &	getParameter (const std::string &name) const

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

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

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

void	setParametersValues (const ParameterList &parameters) override
	Update the parameters from parameters. More...

bool	matchParametersValues (const ParameterList &parameters) override
	Update the parameters from parameters. More...

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

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

size_t	getNumberOfParameters () const override
	Get the number of parameters. More...

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

std::string	getNamespace () const override

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

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

const std::shared_ptr< Parameter > &	getParameter (size_t i) const

std::shared_ptr< Parameter > &	getParameter (size_t i)

virtual void	addParameter_ (Parameter *parameter)

virtual void	addParameters_ (const ParameterList &parameters)

virtual void	shareParameter_ (const std::shared_ptr< Parameter > &parameter)

virtual void	shareParameters_ (const ParameterList &parameters)

virtual void	includeParameters_ (const ParameterList &parameters)

virtual void	deleteParameter_ (size_t index)

virtual void	deleteParameter_ (std::string &name)

virtual void	deleteParameters_ (const std::vector< std::string > &names)

void	resetParameters_ ()

Parameter &	getParameter_ (const std::string &name)

Parameter &	getParameter_ (size_t index)

const Parameter &	getParameter_ (size_t index) const

Parameter &	getParameterWithNamespace_ (const std::string &name)

const Parameter &	getParameterWithNamespace_ (const std::string &name) const

ParameterList &	getParameters_ () override
	Get all parameters available. More...

Protected Attributes
RowMatrix< double >	pij_

RowMatrix< double >	tmpmat_

Vdouble	eqFreq_

bool	upToDate_

Private Attributes
std::vector< double >	vAutocorrel_

Detailed Description

Describe the auto-correlation probabilities inside hidden states of a Hidden Markov Model.

This modelling behaves like a HMM in which, from a given state, all transition probabilities to the other states are equal.

The parameters are the within states transition probabilities, denoted as "lambaN" with N the number of the state (1 is the first).

Definition at line 25 of file AutoCorrelationTransitionMatrix.h.

Constructor & Destructor Documentation

◆ AutoCorrelationTransitionMatrix() [1/2]

AutoCorrelationTransitionMatrix::AutoCorrelationTransitionMatrix	(	std::shared_ptr< const HmmStateAlphabet >	alph,
		const std::string &	prefix = `""`
	)

Definition at line 13 of file AutoCorrelationTransitionMatrix.cpp.

References bpp::AbstractParametrizable::addParameter_(), bpp::AbstractHmmTransitionMatrix::eqFreq_, bpp::AbstractHmmTransitionMatrix::getNumberOfStates(), bpp::Parameter::PROP_CONSTRAINT_EX, bpp::TextTools::toString(), and vAutocorrel_.

Referenced by clone().

◆ AutoCorrelationTransitionMatrix() [2/2]

AutoCorrelationTransitionMatrix::AutoCorrelationTransitionMatrix ( const AutoCorrelationTransitionMatrix & hptm )

Definition at line 34 of file AutoCorrelationTransitionMatrix.cpp.

Member Function Documentation

◆ addParameter_()

virtual void bpp::AbstractParametrizable::addParameter_ ( Parameter * parameter )

inlineprotectedvirtualinherited

Reimplemented in bpp::AbstractParameterAliasable.

Definition at line 111 of file AbstractParametrizable.h.

References bpp::ParameterList::addParameter().

Referenced by bpp::AbstractParameterAliasable::addParameter_(), and AutoCorrelationTransitionMatrix().

◆ addParameters_()

virtual void bpp::AbstractParametrizable::addParameters_ ( const ParameterList & parameters )

inlineprotectedvirtualinherited

Reimplemented in bpp::AbstractParameterAliasable.

Definition at line 117 of file AbstractParametrizable.h.

References bpp::ParameterList::addParameters().

Referenced by bpp::AbstractParameterAliasable::addParameters_(), bpp::FullHmmTransitionMatrix::FullHmmTransitionMatrix(), bpp::LogsumHmmLikelihood::LogsumHmmLikelihood(), bpp::LowMemoryRescaledHmmLikelihood::LowMemoryRescaledHmmLikelihood(), and bpp::RescaledHmmLikelihood::RescaledHmmLikelihood().

◆ clone()

AutoCorrelationTransitionMatrix* bpp::AutoCorrelationTransitionMatrix::clone ( ) const

inlineoverridevirtual

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

Returns: A pointer toward the copy object.

Implements bpp::HmmTransitionMatrix.

Definition at line 39 of file AutoCorrelationTransitionMatrix.h.

References AutoCorrelationTransitionMatrix().

◆ deleteParameter_() [1/2]

virtual void bpp::AbstractParametrizable::deleteParameter_ ( size_t index )

inlineprotectedvirtualinherited

Reimplemented in bpp::AbstractParameterAliasable.

Definition at line 137 of file AbstractParametrizable.h.

References bpp::ParameterList::deleteParameter(), and bpp::ParameterList::size().

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

◆ deleteParameter_() [2/2]

virtual void bpp::AbstractParametrizable::deleteParameter_ ( std::string & name )

inlineprotectedvirtualinherited

Reimplemented in bpp::AbstractParameterAliasable.

Definition at line 144 of file AbstractParametrizable.h.

References bpp::ParameterList::deleteParameter().

◆ deleteParameters_()

virtual void bpp::AbstractParametrizable::deleteParameters_ ( const std::vector< std::string > & names )

inlineprotectedvirtualinherited

Reimplemented in bpp::AbstractParameterAliasable.

Definition at line 149 of file AbstractParametrizable.h.

References bpp::ParameterList::deleteParameters().

◆ fireParameterChanged()

void AutoCorrelationTransitionMatrix::fireParameterChanged ( const ParameterList & parameters )

overridevirtual

Notify the class when one or several parameters have changed.

Parameters

parameters A ParameterList object with parameters that changed.

Reimplemented from bpp::AbstractParametrizable.

Definition at line 73 of file AutoCorrelationTransitionMatrix.cpp.

References bpp::AbstractHmmTransitionMatrix::getNumberOfStates(), bpp::AbstractParametrizable::getParameterValue(), bpp::TextTools::toString(), bpp::AbstractHmmTransitionMatrix::upToDate_, and vAutocorrel_.

Referenced by Pij().

◆ getEquilibriumFrequencies()

const std::vector< double > & AutoCorrelationTransitionMatrix::getEquilibriumFrequencies ( ) const

overridevirtual

Returns: The vector of equilibrium frequencies of the Markov chain described by the matrix.

Implements bpp::HmmTransitionMatrix.

Definition at line 68 of file AutoCorrelationTransitionMatrix.cpp.

References bpp::AbstractHmmTransitionMatrix::eqFreq_.

Referenced by Pij().

◆ getHmmStateAlphabet()

std::shared_ptr<const HmmStateAlphabet> bpp::AbstractHmmTransitionMatrix::getHmmStateAlphabet ( ) const

inlinevirtualinherited

Returns: A pointer toward the hidden alphabet associated to this model.

Implements bpp::HmmTransitionMatrix.

Definition at line 42 of file AbstractHmmTransitionMatrix.h.

References bpp::AbstractHmmTransitionMatrix::alph_.

◆ getNamespace() [1/2]

std::string bpp::AbstractParametrizable::getNamespace ( ) const

inlineoverridevirtualinherited

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

Implements bpp::Parametrizable.

Definition at line 99 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::getParameterNameWithoutNamespace(), and bpp::AbstractParametrizable::prefix_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::MixtureOfDiscreteDistributions::MixtureOfDiscreteDistributions(), bpp::Simplex::setFrequencies(), and bpp::AbstractParameterAliasable::setNamespace().

◆ getNamespace() [2/2]

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().

◆ getNumberOfParameters() [1/2]

size_t bpp::AbstractParametrizable::getNumberOfParameters ( ) const

inlineoverridevirtualinherited

Get the number of parameters.

See also: getNumberOfIndependentParameters If some parameters are aliased.

Returns: The number of parameters.

Implements bpp::Parametrizable.

Definition at line 95 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::setNamespace(), and bpp::ParameterList::size().

Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParameterAliasable::aliasParameters(), bpp::SimpleDiscreteDistribution::fireParameterChanged(), bpp::AbstractParameterAliasable::operator=(), bpp::ConstantDistribution::restrictToConstraint(), and bpp::SimpleDiscreteDistribution::restrictToConstraint().

◆ getNumberOfParameters() [2/2]

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().

◆ getNumberOfStates()

size_t bpp::AbstractHmmTransitionMatrix::getNumberOfStates ( ) const

inlinevirtualinherited

Returns: The number of states in the model.

Implements bpp::HmmTransitionMatrix.

Definition at line 65 of file AbstractHmmTransitionMatrix.h.

References bpp::AbstractHmmTransitionMatrix::sample().

Referenced by AutoCorrelationTransitionMatrix(), fireParameterChanged(), bpp::FullHmmTransitionMatrix::fireParameterChanged(), bpp::FullHmmTransitionMatrix::FullHmmTransitionMatrix(), bpp::FullHmmTransitionMatrix::getEquilibriumFrequencies(), getPij(), and Pij().

◆ getParameter() [1/3]

const std::shared_ptr<Parameter>& bpp::AbstractParametrizable::getParameter ( const std::string & name ) const

inlineinherited

Definition at line 48 of file AbstractParametrizable.h.

References bpp::ParameterList::getParameter().

Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParameterAliasable::operator=(), and bpp::AbstractParameterAliasable::unaliasParameters().

◆ getParameter() [2/3]

const std::shared_ptr<Parameter>& bpp::AbstractParametrizable::getParameter ( size_t i ) const

inlineprotectedinherited

Returns: The shared_ptr parameter at a given position.

Warning: No check is performed on the validity of the index given as input!

Definition at line 211 of file AbstractParametrizable.h.

References bpp::ParameterList::getParameter().

◆ getParameter() [3/3]

std::shared_ptr<Parameter>& bpp::AbstractParametrizable::getParameter ( size_t i )

inlineprotectedinherited

Definition at line 216 of file AbstractParametrizable.h.

References bpp::ParameterList::getParameter().

◆ getParameter_() [1/3]

Parameter& bpp::AbstractParametrizable::getParameter_ ( const std::string & name )

inlineprotectedinherited

Parameters

name	The name of the parameter.

Returns: A reference toward the corresponding parameter.

Exceptions

ParameterNotFoundException If no parameter with that name is found in the list.

Definition at line 164 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::hasParameter(), and bpp::ParameterList::parameter().

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::AbstractParametrizable::getParameterWithNamespace_(), bpp::AbstractParametrizable::removeConstraint(), bpp::ConstantDistribution::restrictToConstraint(), bpp::TruncatedExponentialDiscreteDistribution::restrictToConstraint(), bpp::InvariantMixedDiscreteDistribution::restrictToConstraint(), bpp::SimpleDiscreteDistribution::restrictToConstraint(), bpp::AbstractParametrizable::setConstraint(), and bpp::AbstractParameterAliasable::unaliasParameters().

◆ getParameter_() [2/3]

Parameter& bpp::AbstractParametrizable::getParameter_ ( size_t index )

inlineprotectedinherited

Definition at line 190 of file AbstractParametrizable.h.

References bpp::ParameterList::size().

◆ getParameter_() [3/3]

const Parameter& bpp::AbstractParametrizable::getParameter_ ( size_t index ) const

inlineprotectedinherited

Definition at line 197 of file AbstractParametrizable.h.

References bpp::ParameterList::size().

◆ getParameterNameWithoutNamespace() [1/2]

std::string AbstractParametrizable::getParameterNameWithoutNamespace ( const std::string & name ) const

overridevirtualinherited

Resolves a parameter name according to the current namespace.

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

Implements bpp::Parametrizable.

Definition at line 28 of file AbstractParametrizable.cpp.

References bpp::TextTools::startsWith().

Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParametrizable::getNamespace(), and bpp::AbstractParameterAliasable::operator=().

◆ getParameterNameWithoutNamespace() [2/2]

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() [1/2]

const ParameterList& bpp::AbstractParametrizable::getParameters ( ) const

inlineoverridevirtualinherited

Get all parameters available.

See also: getIndependentParameters if some parameters are aliased.

Returns: A list with all parameters available.

Implements bpp::Parametrizable.

Definition at line 41 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::parameters_.

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::FullHmmTransitionMatrix::FullHmmTransitionMatrix(), bpp::MixtureOfDiscreteDistributions::MixtureOfDiscreteDistributions(), and bpp::ParametrizableCollection< N >::removeObject().

◆ getParameters() [2/2]

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_() [1/2]

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().

◆ getParameters_() [2/2]

ParameterList& bpp::AbstractParametrizable::getParameters_ ( )

inlineoverrideprotectedvirtualinherited

Get all parameters available.

See also: getIndependentParameters if some parameters are aliased.

Returns: A list with all parameters available.

Implements bpp::Parametrizable.

Definition at line 205 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::parameters_.

Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), bpp::AbstractParameterAliasable::aliasParameters(), and bpp::AbstractParameterAliasable::operator=().

◆ getParameterValue() [1/2]

double bpp::AbstractParametrizable::getParameterValue ( const std::string & name ) const

inlineoverridevirtualinherited

Get the value for parameter of name 'name'.

Parameters

name	The name of the parameter.

Returns: the value of parameter name.

Implements bpp::Parametrizable.

Definition at line 53 of file AbstractParametrizable.h.

References bpp::Parameter::getValue(), and bpp::AbstractParametrizable::parameter().

◆ getParameterValue() [2/2]

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().

◆ getParameterWithNamespace_() [1/2]

Parameter& bpp::AbstractParametrizable::getParameterWithNamespace_ ( const std::string & name )

inlineprotectedinherited

Parameters

name	The name of the parameter, including its namespace.

Returns: A reference toward the corresponding parameter.

Exceptions

ParameterNotFoundException If no parameter with that name is found in the list.

Definition at line 176 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::getParameter_().

◆ getParameterWithNamespace_() [2/2]

const Parameter& bpp::AbstractParametrizable::getParameterWithNamespace_ ( const std::string & name ) const

inlineprotectedinherited

Parameters

name	The name of the parameter, including its namespace.

Returns: A reference toward the corresponding parameter.

Exceptions

ParameterNotFoundException If no parameter with that name is found in the list.

Definition at line 185 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::parameter().

◆ getPij()

const Matrix< double > & AutoCorrelationTransitionMatrix::getPij ( ) const

overridevirtual

Get all transition probabilities as a matrix.

Returns: A n*n matrix will all transition probabilities (n being the number of hidden states).

Implements bpp::HmmTransitionMatrix.

Definition at line 50 of file AutoCorrelationTransitionMatrix.cpp.

References bpp::AbstractHmmTransitionMatrix::getNumberOfStates(), bpp::AbstractHmmTransitionMatrix::pij_, bpp::AbstractHmmTransitionMatrix::upToDate_, and vAutocorrel_.

Referenced by Pij().

◆ hasParameter() [1/2]

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().

◆ hasParameter() [2/2]

bool bpp::AbstractParametrizable::hasParameter ( const std::string & name ) const

inlineoverridevirtualinherited

Tell if there is a parameter with specified name.

Parameters

name	The name of the parameter to look for.

Returns: y/n.

Implements bpp::Parametrizable.

Definition at line 39 of file AbstractParametrizable.h.

References bpp::ParameterList::hasParameter().

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::GammaDiscreteDistribution::fireParameterChanged(), bpp::AbstractParametrizable::getParameter_(), and bpp::AbstractParameterAliasable::unaliasParameters().

◆ hmmStateAlphabet()

const HmmStateAlphabet& bpp::AbstractHmmTransitionMatrix::hmmStateAlphabet ( ) const

inlinevirtualinherited

Returns: The hidden alphabet associated to this model.

Implements bpp::HmmTransitionMatrix.

Definition at line 50 of file AbstractHmmTransitionMatrix.h.

References bpp::AbstractHmmTransitionMatrix::alph_, and bpp::AbstractHmmTransitionMatrix::setHmmStateAlphabet().

Referenced by bpp::AbstractHmmTransitionMatrix::sample().

◆ includeParameters_()

virtual void bpp::AbstractParametrizable::includeParameters_ ( const ParameterList & parameters )

inlineprotectedvirtualinherited

Reimplemented in bpp::AbstractParameterAliasable.

Definition at line 132 of file AbstractParametrizable.h.

References bpp::ParameterList::includeParameters().

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

◆ matchParametersValues() [1/2]

bool bpp::AbstractParametrizable::matchParametersValues ( const ParameterList & parameters )

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 76 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::fireParameterChanged(), bpp::ParameterList::matchParametersValues(), and bpp::ParameterList::shareSubList().

Referenced by bpp::AbstractParameterAliasable::aliasParameters(), bpp::Simplex::setFrequencies(), bpp::ReparametrizationFunctionWrapper::setParameters(), and bpp::FullHmmTransitionMatrix::setTransitionProbabilities().

◆ matchParametersValues() [2/2]

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().

◆ operator=()

AutoCorrelationTransitionMatrix & AutoCorrelationTransitionMatrix::operator= ( const AutoCorrelationTransitionMatrix & hptm )

Definition at line 40 of file AutoCorrelationTransitionMatrix.cpp.

References bpp::AbstractHmmTransitionMatrix::operator=(), and vAutocorrel_.

◆ parameter() [1/2]

const Parameter& bpp::AbstractParametrizable::parameter ( const std::string & name ) const

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 43 of file AbstractParametrizable.h.

References bpp::ParameterList::parameter().

Referenced by bpp::AbstractParameterAliasable::getAliasedParameters(), bpp::ReparametrizationDerivableFirstOrderWrapper::getFirstOrderDerivative(), bpp::AbstractParameterAliasable::getFromParameters(), bpp::AbstractParametrizable::getParameterValue(), bpp::AbstractParametrizable::getParameterWithNamespace_(), and bpp::ReparametrizationDerivableSecondOrderWrapper::getSecondOrderDerivative().

◆ parameter() [2/2]

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().

◆ Pij()

double bpp::AutoCorrelationTransitionMatrix::Pij	(	size_t	i,
		size_t	j
	)		const

inlineoverridevirtual

Get the transition probability between two states.

Parameters

i	initial state.
j	final state.

Returns: the transition probability between the two states.

Implements bpp::HmmTransitionMatrix.

Definition at line 48 of file AutoCorrelationTransitionMatrix.h.

References fireParameterChanged(), getEquilibriumFrequencies(), bpp::AbstractHmmTransitionMatrix::getNumberOfStates(), and getPij().

◆ removeConstraint() [1/2]

void bpp::AbstractParametrizable::removeConstraint ( const std::string & name )

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 85 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::getParameter_(), and bpp::Parameter::removeConstraint().

◆ removeConstraint() [2/2]

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().

◆ resetParameters_()

void bpp::AbstractParametrizable::resetParameters_ ( )

inlineprotectedinherited

Definition at line 154 of file AbstractParametrizable.h.

References bpp::ParameterList::reset().

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

◆ sample()

vector< size_t > AbstractHmmTransitionMatrix::sample ( size_t size ) const

inherited

sampling of a sequence of states. Starting point is sampled from the equilibrium distribution.

Parameters

size	the length of the sequence

Returns: a vector of states index sampled from the Transition probabilities

Definition at line 48 of file AbstractHmmTransitionMatrix.cpp.

References bpp::AbstractHmmTransitionMatrix::eqFreq_, bpp::HmmStateAlphabet::getNumberOfStates(), bpp::HmmTransitionMatrix::getPij(), bpp::RowMatrix< Scalar >::getRow(), bpp::RandomTools::giveRandomNumberBetweenZeroAndEntry(), bpp::AbstractHmmTransitionMatrix::hmmStateAlphabet(), and bpp::AbstractHmmTransitionMatrix::pij_.

Referenced by bpp::AbstractHmmTransitionMatrix::getNumberOfStates().

◆ setAllParametersValues() [1/2]

void bpp::AbstractParametrizable::setAllParametersValues ( const ParameterList & parameters )

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 58 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::fireParameterChanged(), and bpp::ParameterList::setAllParametersValues().

◆ setAllParametersValues() [2/2]

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() [1/2]

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

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 90 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::getParameter_(), and bpp::Parameter::setConstraint().

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

◆ setConstraint() [2/2]

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().

◆ setHmmStateAlphabet()

void AbstractHmmTransitionMatrix::setHmmStateAlphabet ( std::shared_ptr< const HmmStateAlphabet > stateAlphabet )

virtualinherited

Set the new hidden state alphabet.

Parameters

stateAlphabet The new state alphabet

Exceptions

UnvalidStateAlphabetException if the new alphabet is uncorrect (for instance is NULL pointer).

Implements bpp::HmmTransitionMatrix.

Definition at line 40 of file AbstractHmmTransitionMatrix.cpp.

References bpp::AbstractHmmTransitionMatrix::alph_.

Referenced by bpp::AbstractHmmTransitionMatrix::hmmStateAlphabet().

◆ setNamespace() [1/2]

void AbstractParametrizable::setNamespace ( const std::string & prefix )

overridevirtualinherited

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.

Implements bpp::Parametrizable.

Reimplemented in bpp::LogsumHmmLikelihood, bpp::RescaledHmmLikelihood, bpp::LowMemoryRescaledHmmLikelihood, bpp::MixtureOfDiscreteDistributions, and bpp::InvariantMixedDiscreteDistribution.

Definition at line 10 of file AbstractParametrizable.cpp.

References bpp::TextTools::startsWith().

Referenced by bpp::AbstractParametrizable::getNumberOfParameters(), bpp::AbstractParameterAliasable::setNamespace(), bpp::LowMemoryRescaledHmmLikelihood::setNamespace(), bpp::LogsumHmmLikelihood::setNamespace(), and bpp::RescaledHmmLikelihood::setNamespace().

◆ setNamespace() [2/2]

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() [1/2]

void bpp::AbstractParametrizable::setParametersValues ( const ParameterList & parameters )

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 70 of file AbstractParametrizable.h.

References bpp::AbstractParametrizable::fireParameterChanged(), and bpp::ParameterList::setParametersValues().

Referenced by bpp::LowMemoryRescaledHmmLikelihood::setParameters(), bpp::LogsumHmmLikelihood::setParameters(), and bpp::RescaledHmmLikelihood::setParameters().

◆ setParametersValues() [2/2]

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() [1/2]

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

inlineoverridevirtualinherited

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.

Implements bpp::Parametrizable.

Definition at line 64 of file AbstractParametrizable.h.

References bpp::ParameterList::createSubList(), bpp::AbstractParametrizable::fireParameterChanged(), and bpp::ParameterList::setParameterValue().

◆ setParameterValue() [2/2]

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().