Model taken from a SubModel of a Mixture of SubstitutionModels. More...

#include <Bpp/Phyl/Model/FromMixtureSubstitutionModel.h>

Inheritance diagram for bpp::FromMixtureSubstitutionModel:

Collaboration diagram for bpp::FromMixtureSubstitutionModel:

Public Member Functions
	FromMixtureSubstitutionModel (const MixedTransitionModelInterface &mixedModel, const std::string &subModelName, const std::string &mixtDesc)

	FromMixtureSubstitutionModel (const MixedTransitionModelInterface &mixedModel, size_t subModelNumber, const std::string &mixtDesc)

	FromMixtureSubstitutionModel (const FromMixtureSubstitutionModel &fmsm)

FromMixtureSubstitutionModel &	operator= (const FromMixtureSubstitutionModel &fmsm)

virtual	~FromMixtureSubstitutionModel ()

FromMixtureSubstitutionModel *	clone () const override

const SubstitutionModelInterface &	substitutionModel () const override

bool	isScalable () const
	returns if model is scalable More...

void	setScalable (bool scalable)
	sets if model is scalable, ie scale can be changed. Default : true, set to false to avoid normalization for example. More...

void	normalize ()
	Normalize the generator. More...

void	setDiagonal ()
	set the diagonal of the generator such that sum on each line equals 0. More...

double	getScale () const
	Get the scalar product of diagonal elements of the generator and the frequencies vector. If the generator is normalized, then scale=1. Otherwise each element must be multiplied by 1/scale. More...

void	setScale (double scale)
	Multiplies the current generator by the given scale. More...

const FrequencySetInterface &	frequencySet () const override

const BranchModelInterface &	model () const override

bool	hasIndependentParameter (const std::string &name) const

const ParameterList &	getIndependentParameters () const

size_t	getNumberOfIndependentParameters () const

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

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

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

ParameterList	getAliasedParameters (const ParameterList &pl) const

ParameterList	getFromParameters (const ParameterList &pl) const

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

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

std::string	getFrom (const std::string &name) const

bool	hasParameter (const std::string &name) const override

const ParameterList &	getParameters () const override

const Parameter &	parameter (const std::string &name) const override

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

double	getParameterValue (const std::string &name) const override

void	setAllParametersValues (const ParameterList &parameters) override

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

void	setParametersValues (const ParameterList &parameters) override

bool	matchParametersValues (const ParameterList &parameters) override

void	removeConstraint (const std::string &name) override

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

size_t	getNumberOfParameters () const override

std::string	getNamespace () const override

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

virtual const Eigen::VectorXd &	Lik_t (const Eigen::VectorXd &values, double t) const =0

const Eigen::VectorXd &	Lik_t (const Eigen::VectorXd &values, double t) const override

virtual const Eigen::VectorXd &	dLik_dt (const Eigen::VectorXd &values, double t) const =0

const Eigen::VectorXd &	dLik_dt (const Eigen::VectorXd &values, double t) const override

virtual const Eigen::VectorXd &	d2Lik_dt2 (const Eigen::VectorXd &values, double t) const =0

const Eigen::VectorXd &	d2Lik_dt2 (const Eigen::VectorXd &values, double t) const override

virtual const TransitionModelInterface &	transitionModel () const =0

const TransitionModelInterface &	transitionModel () const


void	fireParameterChanged (const ParameterList &parameters) override
	Tells the model that a parameter value has changed. More...

virtual void	setNamespace (const std::string &name) override

virtual void	addRateParameter () override

std::string	getName () const override
	Get the name of the model. More...


double	Qij (size_t i, size_t j) const
	Methods to supersede SubstitutionModel methods. More...

const Matrix< double > &	generator () const

const Matrix< double > &	exchangeabilityMatrix () const

double	Sij (size_t i, size_t j) const

void	enableEigenDecomposition (bool yn)
	Set if eigenValues and Vectors must be computed. More...

bool	enableEigenDecomposition ()
	Tell if eigenValues and Vectors must be computed. More...

bool	isDiagonalizable () const

bool	isNonSingular () const

const Vdouble &	getEigenValues () const

const Vdouble &	getIEigenValues () const

const Matrix< double > &	getRowLeftEigenVectors () const

const Matrix< double > &	getColumnRightEigenVectors () const


double	freq (size_t i) const override
	Methods to supersede TransitionModel methods. More...

double	Pij_t (size_t i, size_t j, double t) const override

double	dPij_dt (size_t i, size_t j, double t) const override

double	d2Pij_dt2 (size_t i, size_t j, double t) const override

const Vdouble &	getFrequencies () const override

const Matrix< double > &	getPij_t (double t) const override

const Matrix< double > &	getdPij_dt (double t) const override

const Matrix< double > &	getd2Pij_dt2 (double t) const override

double	getInitValue (size_t i, int state) const override

double	getRate () const override
	Get the rate. More...

void	setRate (double rate) override
	Set the rate of the model (must be positive). More...

void	setFreqFromData (const SequenceDataInterface &data, double pseudoCount=0) override
	Set equilibrium frequencies equal to the frequencies estimated from the data. More...

void	setFreq (std::map< int, double > &frequencies) override
	Set equilibrium frequencies. More...

bool	computeFrequencies () const override

void	computeFrequencies (bool yn) override
	Set if equilibrium frequencies should be computed from the generator. More...


const std::vector< int > &	getAlphabetStates () const override

const StateMapInterface &	stateMap () const override

std::shared_ptr< const StateMapInterface >	getStateMap () const override

int	getAlphabetStateAsInt (size_t i) const override

std::string	getAlphabetStateAsChar (size_t i) const override

std::vector< size_t >	getModelStates (int code) const override
	Get the state in the model corresponding to a particular state in the alphabet. More...

std::vector< size_t >	getModelStates (const std::string &code) const override
	Get the state in the model corresponding to a particular state in the alphabet. More...

const Alphabet &	alphabet () const override

std::shared_ptr< const Alphabet >	getAlphabet () const override

size_t	getNumberOfStates () const override
	Get the number of states. More...

Protected Member Functions
SubstitutionModelInterface &	substitutionModel_ () override

Vdouble &	getFrequencies_ () override

BranchModelInterface &	model_ ()

virtual TransitionModelInterface &	transitionModel_ ()=0

TransitionModelInterface &	transitionModel_ ()

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

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

void	addParameter_ (Parameter *parameter)

void	addParameters_ (const ParameterList &parameters)

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

void	shareParameters_ (const ParameterList &parameters)

void	includeParameters_ (const ParameterList &parameters)

void	deleteParameter_ (size_t index)

void	deleteParameter_ (std::string &name)

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

Private Attributes
std::unique_ptr< SubstitutionModelInterface >	subModel_
	The subModel taken from the AbstractTotallyWrappedSubstitutionModel. More...

std::string	mixtName_
	The name of the mixture model (for io purpose). More...

ParameterList	independentParameters_

std::map< std::string, std::shared_ptr< AliasParameterListener > >	aliasListenersRegister_

ParameterList	parameters_

std::string	prefix_

Eigen::VectorXd	lik_

Detailed Description

Model taken from a SubModel of a Mixture of SubstitutionModels.

It has the same parameters as the SubModel.

Definition at line 21 of file FromMixtureSubstitutionModel.h.

Constructor & Destructor Documentation

◆ FromMixtureSubstitutionModel() [1/3]

FromMixtureSubstitutionModel::FromMixtureSubstitutionModel	(	const MixedTransitionModelInterface &	mixedModel,
		const std::string &	subModelName,
		const std::string &	mixtDesc
	)

Definition at line 12 of file FromMixtureSubstitutionModel.cpp.

References bpp::AbstractParameterAliasable::addParameters_(), bpp::AbstractParameterAliasable::getNamespace(), bpp::MixedTransitionModelInterface::model(), and subModel_.

Referenced by clone().

◆ FromMixtureSubstitutionModel() [2/3]

FromMixtureSubstitutionModel::FromMixtureSubstitutionModel	(	const MixedTransitionModelInterface &	mixedModel,
		size_t	subModelNumber,
		const std::string &	mixtDesc
	)

Definition at line 47 of file FromMixtureSubstitutionModel.cpp.

References bpp::AbstractParameterAliasable::addParameters_(), bpp::AbstractParameterAliasable::getNamespace(), bpp::MixedTransitionModelInterface::getNumberOfModels(), bpp::MixedTransitionModelInterface::nModel(), subModel_, bpp::TextTools::toString(), and toString().

◆ FromMixtureSubstitutionModel() [3/3]

FromMixtureSubstitutionModel::FromMixtureSubstitutionModel ( const FromMixtureSubstitutionModel & fmsm )

Definition at line 81 of file FromMixtureSubstitutionModel.cpp.

◆ ~FromMixtureSubstitutionModel()

virtual bpp::FromMixtureSubstitutionModel::~FromMixtureSubstitutionModel ( )

inlinevirtual

Definition at line 51 of file FromMixtureSubstitutionModel.h.

Member Function Documentation

◆ addRateParameter()

virtual void bpp::FromMixtureSubstitutionModel::addRateParameter ( )

inlineoverridevirtual

Implements bpp::BranchModelInterface.

Definition at line 91 of file FromMixtureSubstitutionModel.h.

References bpp::AbstractParameterAliasable::addParameter_(), bpp::BranchModelInterface::addRateParameter(), bpp::AbstractParameterAliasable::getNamespace(), bpp::AbstractTotallyWrappedTransitionModel::getRate(), bpp::AbstractWrappedTransitionModel::model(), bpp::AbstractWrappedTransitionModel::model_(), and bpp::Parameter::R_PLUS_STAR.

◆ alphabet()

const Alphabet & bpp::AbstractWrappedModel::alphabet ( ) const

inlineoverridevirtualinherited

Returns: A reference to the alphabet associated to this model.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 53 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::alphabet(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::alphabet(), and bpp::OneChangeRegisterTransitionModel::OneChangeRegisterTransitionModel().

◆ clone()

FromMixtureSubstitutionModel * bpp::FromMixtureSubstitutionModel::clone ( ) const

inlineoverridevirtual

Implements bpp::SubstitutionModelInterface.

Definition at line 53 of file FromMixtureSubstitutionModel.h.

References FromMixtureSubstitutionModel().

◆ computeFrequencies() [1/2]

bool bpp::AbstractTotallyWrappedTransitionModel::computeFrequencies ( ) const

inlineoverridevirtualinherited

Returns: Says if equilibrium frequencies should be computed

Implements bpp::TransitionModelInterface.

Definition at line 161 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::computeFrequencies(), and bpp::WrappedTransitionModelInterface::transitionModel().

Referenced by bpp::DFP07::DFP07(), and bpp::YN98::YN98().

◆ computeFrequencies() [2/2]

void bpp::AbstractTotallyWrappedTransitionModel::computeFrequencies ( bool yn )

inlineoverridevirtualinherited

Set if equilibrium frequencies should be computed from the generator.

Implements bpp::TransitionModelInterface.

Definition at line 170 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::computeFrequencies(), and bpp::AbstractWrappedTransitionModel::transitionModel_().

◆ d2Lik_dt2() [1/2]

virtual const Eigen::VectorXd & bpp::BranchModelInterface::d2Lik_dt2	(	const Eigen::VectorXd &	values,
		double	t
	)		const

pure virtualinherited

Implemented in bpp::MultinomialFromTransitionModel, bpp::TransitionFromTransitionModel, bpp::TransitionModelInterface, and bpp::AbstractLkTransitionModel.

◆ d2Lik_dt2() [2/2]

const Eigen::VectorXd & bpp::AbstractLkTransitionModel::d2Lik_dt2	(	const Eigen::VectorXd &	values,
		double	t
	)		const

inlineoverridevirtualinherited

Implements bpp::TransitionModelInterface.

Definition at line 64 of file AbstractSubstitutionModel.h.

References bpp::TransitionModelInterface::getd2Pij_dt2(), and bpp::AbstractLkTransitionModel::lik_.

◆ d2Pij_dt2()

double bpp::AbstractTotallyWrappedTransitionModel::d2Pij_dt2	(	size_t	i,
		size_t	j,
		double	t
	)		const

inlineoverridevirtualinherited

Returns: The second order derivative of the probability of change from state i to state j with respect to time t, at time t.

See also: getd2Pij_dt2(), getStates()

Implements bpp::TransitionModelInterface.

Definition at line 123 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::d2Pij_dt2(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ dLik_dt() [1/2]

virtual const Eigen::VectorXd & bpp::BranchModelInterface::dLik_dt	(	const Eigen::VectorXd &	values,
		double	t
	)		const

pure virtualinherited

Implemented in bpp::MultinomialFromTransitionModel, bpp::TransitionFromTransitionModel, bpp::TransitionModelInterface, and bpp::AbstractLkTransitionModel.

◆ dLik_dt() [2/2]

const Eigen::VectorXd & bpp::AbstractLkTransitionModel::dLik_dt	(	const Eigen::VectorXd &	values,
		double	t
	)		const

inlineoverridevirtualinherited

Implements bpp::TransitionModelInterface.

Definition at line 47 of file AbstractSubstitutionModel.h.

References bpp::TransitionModelInterface::getdPij_dt(), and bpp::AbstractLkTransitionModel::lik_.

◆ dPij_dt()

double bpp::AbstractTotallyWrappedTransitionModel::dPij_dt	(	size_t	i,
		size_t	j,
		double	t
	)		const

inlineoverridevirtualinherited

Returns: The first order derivative of the probability of change from state i to state j with respect to time t, at time t.

See also: getdPij_dt(), getStates()

Implements bpp::TransitionModelInterface.

Definition at line 122 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::dPij_dt(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ enableEigenDecomposition() [1/2]

bool bpp::AbstractTotallyWrappedSubstitutionModel::enableEigenDecomposition ( )

inlinevirtualinherited

Tell if eigenValues and Vectors must be computed.

Implements bpp::SubstitutionModelInterface.

Definition at line 239 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::enableEigenDecomposition(), and bpp::AbstractWrappedSubstitutionModel::substitutionModel_().

◆ enableEigenDecomposition() [2/2]

void bpp::AbstractTotallyWrappedSubstitutionModel::enableEigenDecomposition ( bool yn )

inlinevirtualinherited

Set if eigenValues and Vectors must be computed.

Implements bpp::SubstitutionModelInterface.

Definition at line 237 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::enableEigenDecomposition(), and bpp::AbstractWrappedSubstitutionModel::substitutionModel_().

◆ exchangeabilityMatrix()

const Matrix< double > & bpp::AbstractTotallyWrappedSubstitutionModel::exchangeabilityMatrix ( ) const

inlinevirtualinherited

Returns: The matrix of exchangeability terms. It is recommended that exchangeability matrix be normalized so that the normalized generator be obtained directly by the dot product $S . \pi$ .

Implements bpp::SubstitutionModelInterface.

Definition at line 233 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::exchangeabilityMatrix(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ fireParameterChanged()

void bpp::FromMixtureSubstitutionModel::fireParameterChanged ( const ParameterList & parameters )

inlineoverridevirtual

Tells the model that a parameter value has changed.

@ brief Methods to supersede AbstractSubstitutionModel methods.

This updates the matrices consequently.

Reimplemented from bpp::AbstractParameterAliasable.

Definition at line 80 of file FromMixtureSubstitutionModel.h.

References bpp::ParameterAliasable::matchParametersValues(), and bpp::AbstractWrappedTransitionModel::model_().

◆ freq()

double bpp::AbstractTotallyWrappedTransitionModel::freq ( size_t i ) const

inlineoverridevirtualinherited

Methods to supersede TransitionModel methods.

Implements bpp::TransitionModelInterface.

Definition at line 119 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::freq(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ frequencySet()

const FrequencySetInterface & bpp::AbstractWrappedTransitionModel::frequencySet ( ) const

inlineoverridevirtualinherited

Returns: Get the FrequencySet of equilibrium of this model.

Exceptions

Exception if no FrequenceSet is associated to this model.

Reimplemented from bpp::AbstractWrappedModel.

Reimplemented in bpp::YN98, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, and bpp::RegisterRatesSubstitutionModel.

Definition at line 92 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::frequencySet(), and bpp::WrappedTransitionModelInterface::transitionModel().

Referenced by bpp::RegisterRatesSubstitutionModel::frequencySet().

◆ generator()

const Matrix< double > & bpp::AbstractTotallyWrappedSubstitutionModel::generator ( ) const

inlinevirtualinherited

Returns: The normalized Markov generator matrix, i.e. all normalized rates of changes from state i to state j. The generator is normalized so that (i) $\forall i; \sum_j Q_{i,j} = 0$ , meaning that $ $\forall i; Q_{i,i} = -\sum_{j \neq i}Q_{i,j}$ , and (ii) $\sum_i Q_{i,i} \times \pi_i = -1$ . This means that, under normalization, the mean rate of replacement at equilibrium is 1 and that time are measured in units of expected number of changes per site. Additionally, the rate_ attribute provides the possibility to increase or decrease this mean rate.

See Kosiol and Goldman (2005), Molecular Biology And Evolution 22(2) 193-9.

See also: Qij()

Implements bpp::SubstitutionModelInterface.

Definition at line 231 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::generator(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ getAlphabet()

std::shared_ptr< const Alphabet > bpp::AbstractWrappedModel::getAlphabet ( ) const

inlineoverridevirtualinherited

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

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 55 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getAlphabet(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabet(), and bpp::OneChangeRegisterTransitionModel::OneChangeRegisterTransitionModel().

◆ getAlphabetStateAsChar()

std::string bpp::AbstractWrappedModel::getAlphabetStateAsChar ( size_t index ) const

inlineoverridevirtualinherited

Parameters

index The model state.

Returns: The corresponding alphabet state as character code.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 46 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getAlphabetStateAsChar(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabetStateAsChar().

◆ getAlphabetStateAsInt()

int bpp::AbstractWrappedModel::getAlphabetStateAsInt ( size_t index ) const

inlineoverridevirtualinherited

Parameters

index The model state.

Returns: The corresponding alphabet state as character code.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 44 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getAlphabetStateAsInt(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabetStateAsInt().

◆ getAlphabetStates()

const std::vector< int > & bpp::AbstractWrappedModel::getAlphabetStates ( ) const

inlineoverridevirtualinherited

@ brief Methods to supersede TransitionModel methods.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 38 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getAlphabetStates(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabetStates().

◆ getColumnRightEigenVectors()

const Matrix< double > & bpp::AbstractTotallyWrappedSubstitutionModel::getColumnRightEigenVectors ( ) const

inlinevirtualinherited

Returns: A matrix with right eigen vectors. Each column in the matrix stands for an eigen vector.

Implements bpp::SubstitutionModelInterface.

Definition at line 251 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::getColumnRightEigenVectors(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ getd2Pij_dt2()

const Matrix< double > & bpp::AbstractTotallyWrappedTransitionModel::getd2Pij_dt2 ( double t ) const

inlineoverridevirtualinherited

Returns: All second order derivatives of the probability of change from state i to state j with respect to time t, at time t.

See also: d2Pij_dt2()

Implements bpp::TransitionModelInterface.

Definition at line 131 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::getd2Pij_dt2(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ getdPij_dt()

const Matrix< double > & bpp::AbstractTotallyWrappedTransitionModel::getdPij_dt ( double t ) const

inlineoverridevirtualinherited

Returns: Get all first order derivatives of the probability of change from state i to state j with respect to time t, at time t.

See also: dPij_dt()

Implements bpp::TransitionModelInterface.

Definition at line 129 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::getdPij_dt(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ getEigenValues()

const Vdouble & bpp::AbstractTotallyWrappedSubstitutionModel::getEigenValues ( ) const

inlinevirtualinherited

Returns: A vector with all real parts of the eigen values of the generator of this model;

Implements bpp::SubstitutionModelInterface.

Definition at line 245 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::getEigenValues(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ getFrequencies()

const Vdouble & bpp::AbstractTotallyWrappedTransitionModel::getFrequencies ( ) const

inlineoverridevirtualinherited

Returns: A vector of all equilibrium frequencies.

See also: freq()

Implements bpp::TransitionModelInterface.

Definition at line 125 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::getFrequencies(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ getFrequencies_()

Vdouble & bpp::AbstractTotallyWrappedTransitionModel::getFrequencies_ ( )

inlineoverrideprotectedvirtualinherited

Implements bpp::TransitionModelInterface.

Definition at line 180 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::getFrequencies_(), and bpp::AbstractWrappedTransitionModel::transitionModel_().

◆ getIEigenValues()

const Vdouble & bpp::AbstractTotallyWrappedSubstitutionModel::getIEigenValues ( ) const

inlinevirtualinherited

Returns: A vector with all imaginary parts of the eigen values of the generator of this model;

Implements bpp::SubstitutionModelInterface.

Definition at line 247 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::getIEigenValues(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ getInitValue()

double bpp::AbstractTotallyWrappedTransitionModel::getInitValue	(	size_t	i,
		int	state
	)		const

inlineoverridevirtualinherited

This method is used to initialize likelihoods in recursions. It typically sends 1 if i = state, 0 otherwise, where i is one of the possible states of the alphabet allowed in the model and state is the observed state in the considered sequence/site.

Parameters

i	the index of the state in the model.
state	An observed state in the sequence/site.

Returns: 1 or 0 depending if the two states are compatible.

Exceptions

IndexOutOfBoundsException	if array position is out of range.
BadIntException	if states are not allowed in the associated alphabet.

See also: getStates();

Implements bpp::BranchModelInterface.

Definition at line 133 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getInitValue(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ getModelStates() [1/2]

std::vector< size_t > bpp::AbstractWrappedModel::getModelStates ( const std::string & code ) const

inlineoverridevirtualinherited

Get the state in the model corresponding to a particular state in the alphabet.

Parameters

code	The alphabet state to check.

Returns: A vector of indices of model states.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 50 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getModelStates(), and bpp::WrappedModelInterface::model().

◆ getModelStates() [2/2]

std::vector< size_t > bpp::AbstractWrappedModel::getModelStates ( int code ) const

inlineoverridevirtualinherited

Get the state in the model corresponding to a particular state in the alphabet.

Parameters

code	The alphabet state to check.

Returns: A vector of indices of model states.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 48 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getModelStates(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::getModelStates().

◆ getName()

std::string bpp::FromMixtureSubstitutionModel::getName ( ) const

inlineoverridevirtual

Get the name of the model.

Returns: The name of this model.

Reimplemented from bpp::AbstractWrappedModel.

Definition at line 100 of file FromMixtureSubstitutionModel.h.

References bpp::BranchModelInterface::getName(), mixtName_, and bpp::AbstractWrappedTransitionModel::model().

◆ getNumberOfStates()

size_t bpp::AbstractWrappedModel::getNumberOfStates ( ) const

inlineoverridevirtualinherited

Get the number of states.

For most models, this equals the size of the alphabet.

See also: getAlphabetChars for the list of supported states.

Returns: The number of different states in the model.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 57 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getNumberOfStates(), and bpp::WrappedModelInterface::model().

◆ getPij_t()

const Matrix< double > & bpp::AbstractTotallyWrappedTransitionModel::getPij_t ( double t ) const

inlineoverridevirtualinherited

Returns: All probabilities of change from state i to state j during time t.

See also: Pij_t()

Implements bpp::TransitionModelInterface.

Definition at line 127 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::getPij_t(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ getRate()

double bpp::AbstractTotallyWrappedTransitionModel::getRate ( ) const

inlineoverridevirtualinherited

Get the rate.

Implements bpp::BranchModelInterface.

Definition at line 138 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getRate(), and bpp::WrappedTransitionModelInterface::transitionModel().

Referenced by bpp::AbstractBiblioTransitionModel::addRateParameter(), and addRateParameter().

◆ getRowLeftEigenVectors()

const Matrix< double > & bpp::AbstractTotallyWrappedSubstitutionModel::getRowLeftEigenVectors ( ) const

inlinevirtualinherited

Returns: A matrix with left eigen vectors. Each row in the matrix stands for an eigen vector.

Implements bpp::SubstitutionModelInterface.

Definition at line 249 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::getRowLeftEigenVectors(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ getScale()

double bpp::AbstractTotallyWrappedSubstitutionModel::getScale ( ) const

inlinevirtualinherited

Get the scalar product of diagonal elements of the generator and the frequencies vector. If the generator is normalized, then scale=1. Otherwise each element must be multiplied by 1/scale.

Returns: Minus the scalar product of diagonal elements and the frequencies vector.

Implements bpp::SubstitutionModelInterface.

Definition at line 277 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::getScale(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ getStateMap()

std::shared_ptr< const StateMapInterface > bpp::AbstractWrappedModel::getStateMap ( ) const

inlineoverridevirtualinherited

Returns: A shared_ptr to the mapping of model states with alphabet states.

Implements bpp::BranchModelInterface.

Reimplemented in bpp::RegisterRatesSubstitutionModel.

Definition at line 42 of file AbstractWrappedModel.h.

References bpp::BranchModelInterface::getStateMap(), and bpp::WrappedModelInterface::model().

Referenced by bpp::RegisterRatesSubstitutionModel::getStateMap().

◆ isDiagonalizable()

bool bpp::AbstractTotallyWrappedSubstitutionModel::isDiagonalizable ( ) const

inlinevirtualinherited

Returns: True if the model is diagonalizable in R.

Implements bpp::SubstitutionModelInterface.

Definition at line 241 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::isDiagonalizable(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ isNonSingular()

bool bpp::AbstractTotallyWrappedSubstitutionModel::isNonSingular ( ) const

inlinevirtualinherited

Returns: True is the model is non-singular.

Implements bpp::SubstitutionModelInterface.

Definition at line 243 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::isNonSingular(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ isScalable()

bool bpp::AbstractTotallyWrappedSubstitutionModel::isScalable ( ) const

inlinevirtualinherited

returns if model is scalable

Implements bpp::SubstitutionModelInterface.

Definition at line 257 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::isScalable(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ Lik_t() [1/2]

virtual const Eigen::VectorXd & bpp::BranchModelInterface::Lik_t	(	const Eigen::VectorXd &	values,
		double	t
	)		const

pure virtualinherited

This method is used to compute likelihoods in recursions. It computes the probability of a vector given a start state.

Parameters

values	An vector of states on the site.
t	time

Exceptions

IndexOutOfBoundsException	if array position is out of range.
BadIntException	if states are not allowed in the associated alphabet.

Implemented in bpp::MultinomialFromTransitionModel, bpp::TransitionFromTransitionModel, bpp::TransitionModelInterface, and bpp::AbstractLkTransitionModel.

◆ Lik_t() [2/2]

const Eigen::VectorXd & bpp::AbstractLkTransitionModel::Lik_t	(	const Eigen::VectorXd &	values,
		double	t
	)		const

inlineoverridevirtualinherited

This method is used to compute likelihoods in recursions. It computes the probability of a vector given a start state.

Parameters

values	An vector of states on the site.
t	the branch length

Implements bpp::TransitionModelInterface.

Definition at line 30 of file AbstractSubstitutionModel.h.

References bpp::TransitionModelInterface::getPij_t(), and bpp::AbstractLkTransitionModel::lik_.

◆ model()

const BranchModelInterface & bpp::AbstractWrappedTransitionModel::model ( ) const

inlineoverridevirtualinherited

Implements bpp::WrappedModelInterface.

Definition at line 97 of file AbstractWrappedModel.h.

References bpp::WrappedTransitionModelInterface::transitionModel().

Referenced by bpp::AbstractBiblioTransitionModel::addRateParameter(), addRateParameter(), bpp::InMixedSubstitutionModel::getInitValue(), getName(), bpp::RegisterRatesSubstitutionModel::getRate(), bpp::AbstractBiblioSubstitutionModel::operator=(), bpp::AbstractBiblioTransitionModel::operator=(), bpp::RegisterRatesSubstitutionModel::RegisterRatesSubstitutionModel(), bpp::AbstractBiblioTransitionModel::setFreq(), bpp::AbstractBiblioTransitionModel::setNamespace(), and bpp::BppOSubstitutionModelFormat::write().

◆ model_()

BranchModelInterface & bpp::AbstractWrappedTransitionModel::model_ ( )

inlineprotectedinherited

Definition at line 84 of file AbstractWrappedModel.h.

References bpp::AbstractWrappedTransitionModel::transitionModel_().

Referenced by bpp::AbstractBiblioTransitionModel::addRateParameter(), addRateParameter(), bpp::AbstractBiblioTransitionModel::fireParameterChanged(), fireParameterChanged(), bpp::RegisterRatesSubstitutionModel::RegisterRatesSubstitutionModel(), bpp::AbstractBiblioTransitionModel::setNamespace(), setNamespace(), bpp::RegisterRatesSubstitutionModel::setRate(), and bpp::AbstractBiblioTransitionModel::updateMatrices_().

◆ normalize()

void bpp::AbstractTotallyWrappedSubstitutionModel::normalize ( )

inlinevirtualinherited

Normalize the generator.

Implements bpp::SubstitutionModelInterface.

Definition at line 267 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::normalize(), and bpp::AbstractWrappedSubstitutionModel::substitutionModel_().

◆ operator=()

FromMixtureSubstitutionModel & FromMixtureSubstitutionModel::operator= ( const FromMixtureSubstitutionModel & fmsm )

Definition at line 95 of file FromMixtureSubstitutionModel.cpp.

References mixtName_, bpp::AbstractParameterAliasable::operator=(), and subModel_.

◆ Pij_t()

double bpp::AbstractTotallyWrappedTransitionModel::Pij_t	(	size_t	i,
		size_t	j,
		double	t
	)		const

inlineoverridevirtualinherited

Returns: The probability of change from state i to state j during time t.

See also: getPij_t(), getStates()

Implements bpp::TransitionModelInterface.

Definition at line 121 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::Pij_t(), and bpp::WrappedTransitionModelInterface::transitionModel().

◆ Qij()

double bpp::AbstractTotallyWrappedSubstitutionModel::Qij	(	size_t	i,
		size_t	j
	)		const

inlinevirtualinherited

Methods to supersede SubstitutionModel methods.

Implements bpp::SubstitutionModelInterface.

Definition at line 229 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::Qij(), and bpp::WrappedSubstitutionModelInterface::substitutionModel().

◆ setDiagonal()

void bpp::AbstractTotallyWrappedSubstitutionModel::setDiagonal ( )

inlinevirtualinherited

set the diagonal of the generator such that sum on each line equals 0.

Implements bpp::SubstitutionModelInterface.

Definition at line 272 of file AbstractWrappedModel.h.

References bpp::SubstitutionModelInterface::setDiagonal(), and bpp::AbstractWrappedSubstitutionModel::substitutionModel_().

◆ setFreq()

void bpp::AbstractTotallyWrappedTransitionModel::setFreq ( std::map< int, double > & frequencies )

inlineoverridevirtualinherited

Set equilibrium frequencies.

Parameters

frequencies The map of the frequencies to use.

Implements bpp::TransitionModelInterface.

Reimplemented in bpp::KCM, bpp::MG94, and bpp::YN98.

Definition at line 156 of file AbstractWrappedModel.h.

References bpp::TransitionModelInterface::setFreq(), and bpp::AbstractWrappedTransitionModel::transitionModel_().

Referenced by bpp::AbstractBiblioTransitionModel::setFreq().

◆ setFreqFromData()

void bpp::AbstractTotallyWrappedTransitionModel::setFreqFromData	(	const SequenceDataInterface &	data,
		double	pseudoCount = `0`
	)

inlineoverridevirtualinherited

Set equilibrium frequencies equal to the frequencies estimated from the data.

Parameters

data	The sequences to use.
pseudoCount	A quantity $\psi$ to add to adjust the observed values in order to prevent issues due to missing states on small data set. The corrected frequencies shall be computed as $\pi_i = \frac{n_i+\psi}{\sum_j (f_j+\psi)}$