bpp-phyl  2.2.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
bpp::TS98 Class Reference

Tuffley and Steel's 1998 covarion model. More...

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

+ Inheritance diagram for bpp::TS98:
+ Collaboration diagram for bpp::TS98:

Public Member Functions

 TS98 (ReversibleSubstitutionModel *model, double s1=1., double s2=1., bool normalizeRateChanges=false)
 Build a new TS98 substitution model. More...
 
virtual ~TS98 ()
 
TS98 * clone () const
 
std::string getName () const
 Get the name of the model. More...
 
double getRate () const
 Get the rate. More...
 
void setRate (double rate)
 Set the rate of the model (must be positive). More...
 
void addRateParameter ()
 
const Alphabet * getAlphabet () const
 
size_t getNumberOfStates () const
 Get the number of states. More...
 
const StateMap & getStateMap () const
 
const std::vector< int > & getAlphabetStates () const
 
std::string getAlphabetStateAsChar (size_t index) const
 
int getAlphabetStateAsInt (size_t index) const
 
std::vector< size_t > getModelStates (int code) const
 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
 Get the state in the model corresponding to a particular state in the alphabet. More...
 
const Vdouble & getFrequencies () const
 
const Matrix< double > & getExchangeabilityMatrix () const
 
const Matrix< double > & getGenerator () const
 
const Matrix< double > & getPij_t (double t) const
 
const Matrix< double > & getdPij_dt (double t) const
 
const Matrix< double > & getd2Pij_dt2 (double t) const
 
const Vdouble & getEigenValues () const
 
const Vdouble & getIEigenValues () const
 
bool isDiagonalizable () const
 
bool isNonSingular () const
 
const Matrix< double > & getRowLeftEigenVectors () const
 
const Matrix< double > & getColumnRightEigenVectors () const
 
double freq (size_t i) const
 
double Sij (size_t i, size_t j) const
 
double Qij (size_t i, size_t j) const
 
double Pij_t (size_t i, size_t j, double t) const
 
double dPij_dt (size_t i, size_t j, double t) const
 
double d2Pij_dt2 (size_t i, size_t j, double t) const
 
double getInitValue (size_t i, int state) const throw (IndexOutOfBoundsException, BadIntException)
 
void setFreqFromData (const SequenceContainer &data, double pseudoCount=0)
 Set equilibrium frequencies equal to the frequencies estimated from the data. More...
 
const ReversibleSubstitutionModel * getNestedModel () const
 
size_t getRate (size_t i) const
 Get the rate category corresponding to a particular state in the compound model. 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...
 
void enableEigenDecomposition (bool yn)
 Set if eigenValues and Vectors must be computed. More...
 
bool enableEigenDecomposition ()
 Tell if eigenValues and Vectors must be computed. More...
 
virtual void fireParameterChanged (const ParameterList &parameters)
 Tells the model that a parameter value has changed. More...
 
void setNamespace (const std::string &prefix)
 
virtual void setFreq (std::map< int, double > &frequencies)
 Set equilibrium frequencies. More...
 
virtual const FrequenciesSet * getFrequenciesSet () const
 If the model owns a FrequenciesSet, returns a pointer to it, otherwise return 0. More...
 

Protected Member Functions

void updateRatesModel ()
 Update the rates vector, generator and equilibrium frequencies. More...
 
virtual void updateMatrices ()
 

Protected Attributes

ReversibleSubstitutionModel * model_
 
MarkovModulatedStateMap stateMap_
 
size_t nbStates_
 
size_t nbRates_
 
RowMatrix< double > ratesGenerator_
 
RowMatrix< double > generator_
 The generator matrix $Q$ of the model. More...
 
RowMatrix< double > exchangeability_
 The exchangeability matrix $S$ of the model. More...
 
RowMatrix< double > leftEigenVectors_
 The $U$ matrix made of left eigen vectors (by row). More...
 
RowMatrix< double > rightEigenVectors_
 The $U^-1$ matrix made of right eigen vectors (by column). More...
 
Vdouble eigenValues_
 The vector of real parts of eigen values. More...
 
Vdouble iEigenValues_
 The vector of imaginary parts of the eigen values (zero in case of reversible pmodel). More...
 
bool eigenDecompose_
 Tell if the eigen decomposition should be performed. More...
 
RowMatrix< double > pijt_
 These ones are for bookkeeping: More...
 
RowMatrix< double > dpijt_
 
RowMatrix< double > d2pijt_
 
Vdouble freq_
 The vector of equilibrium frequencies. More...
 
bool normalizeRateChanges_
 
std::string nestedPrefix_
 
Rate generator.

These variables must be initialized in the constructor of the derived class.

RowMatrix< double > rates_
 
RowMatrix< double > ratesExchangeability_
 
Vdouble ratesFreq_
 

Detailed Description

Tuffley and Steel's 1998 covarion model.

This model is a subclass of the so-called Markov-modulated substitution models, with a rate matrix

\[ G = \begin{pmatrix} -s_1 & s_1\\ s_2 & -s_2 \end{pmatrix} \]

and

\[ D_R = \begin{pmatrix} 0 & 0\\ 0 & \dfrac{s_1+s_2}{s_1} \end{pmatrix}. \]

This model was originally designed for nucleotides sequences, but it can be used with other alphabets.

See also
MarkovModulatedSubstitutionModel

Tuffley C. and Steel M. A., Modelling the covarion hypothesis of nucleotide substitution (1998), Math. Biosci., 147:63-91.

Definition at line 77 of file TS98.h.

Constructor & Destructor Documentation

◆ TS98()

bpp::TS98::TS98 ( ReversibleSubstitutionModel *  model,
double  s1 = 1.,
double  s2 = 1.,
bool  normalizeRateChanges = false 
)
inline

Build a new TS98 substitution model.

Parameters
modelThe substitution model to use. May be of any alphabet type.
s1First rate parameter.
s2Second rate parameter.
normalizeRateChangesTell if the rate transition matrix should be normalized.

Definition at line 89 of file TS98.h.

References bpp::MarkovModulatedSubstitutionModel::updateMatrices(), and updateRatesModel().

Referenced by clone().

◆ ~TS98()

virtual bpp::TS98::~TS98 ( )
inlinevirtual

Definition at line 98 of file TS98.h.

Member Function Documentation

◆ addRateParameter()

void bpp::TS98::addRateParameter ( )
inlinevirtual

Implements bpp::SubstitutionModel.

Definition at line 114 of file TS98.h.

◆ clone()

TS98* bpp::TS98::clone ( ) const
inlinevirtual

Implements bpp::MarkovModulatedSubstitutionModel.

Definition at line 105 of file TS98.h.

References TS98().

◆ d2Pij_dt2()

double bpp::MarkovModulatedSubstitutionModel::d2Pij_dt2 ( size_t  i,
size_t  j,
double  t 
) const
inlinevirtualinherited
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::SubstitutionModel.

Definition at line 230 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::getd2Pij_dt2().

◆ dPij_dt()

double bpp::MarkovModulatedSubstitutionModel::dPij_dt ( size_t  i,
size_t  j,
double  t 
) const
inlinevirtualinherited
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::SubstitutionModel.

Definition at line 229 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::getdPij_dt().

◆ enableEigenDecomposition() [1/2]

void bpp::MarkovModulatedSubstitutionModel::enableEigenDecomposition ( bool  yn)
inlinevirtualinherited

Set if eigenValues and Vectors must be computed.

Implements bpp::SubstitutionModel.

Definition at line 271 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::eigenDecompose_.

◆ enableEigenDecomposition() [2/2]

bool bpp::MarkovModulatedSubstitutionModel::enableEigenDecomposition ( )
inlinevirtualinherited

Tell if eigenValues and Vectors must be computed.

Implements bpp::SubstitutionModel.

Definition at line 273 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::eigenDecompose_.

◆ fireParameterChanged()

virtual void bpp::MarkovModulatedSubstitutionModel::fireParameterChanged ( const ParameterList &  parameters)
inlinevirtualinherited

Tells the model that a parameter value has changed.

This updates the matrices consequently.

Reimplemented in bpp::G2001.

Definition at line 280 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::model_, bpp::MarkovModulatedSubstitutionModel::updateMatrices(), and bpp::MarkovModulatedSubstitutionModel::updateRatesModel().

Referenced by bpp::G2001::fireParameterChanged().

◆ freq()

double bpp::MarkovModulatedSubstitutionModel::freq ( size_t  i) const
inlinevirtualinherited
Returns
Equilibrium frequency associated to character i.
See also
getFrequencies(), getStates()

Implements bpp::SubstitutionModel.

Definition at line 224 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::freq_.

◆ getAlphabet()

const Alphabet* bpp::MarkovModulatedSubstitutionModel::getAlphabet ( ) const
inlinevirtualinherited
Returns
Get the alphabet associated to this model.

Implements bpp::SubstitutionModel.

Definition at line 189 of file MarkovModulatedSubstitutionModel.h.

References bpp::SubstitutionModel::getAlphabet(), and bpp::MarkovModulatedSubstitutionModel::model_.

◆ getAlphabetStateAsChar()

std::string bpp::MarkovModulatedSubstitutionModel::getAlphabetStateAsChar ( size_t  index) const
inlinevirtualinherited
Parameters
indexThe model state.
Returns
The corresponding alphabet state as character code.

Implements bpp::SubstitutionModel.

Definition at line 197 of file MarkovModulatedSubstitutionModel.h.

References bpp::AbstractStateMap::getAlphabetStateAsChar(), and bpp::MarkovModulatedSubstitutionModel::stateMap_.

◆ getAlphabetStateAsInt()

int bpp::MarkovModulatedSubstitutionModel::getAlphabetStateAsInt ( size_t  index) const
inlinevirtualinherited
Parameters
indexThe model state.
Returns
The corresponding alphabet state as character code.

Implements bpp::SubstitutionModel.

Definition at line 199 of file MarkovModulatedSubstitutionModel.h.

References bpp::AbstractStateMap::getAlphabetStateAsInt(), and bpp::MarkovModulatedSubstitutionModel::stateMap_.

◆ getAlphabetStates()

const std::vector<int>& bpp::MarkovModulatedSubstitutionModel::getAlphabetStates ( ) const
inlinevirtualinherited
Returns
The alphabet states of each state of the model, as a vector of int codes.
See also
Alphabet

Implements bpp::SubstitutionModel.

Definition at line 195 of file MarkovModulatedSubstitutionModel.h.

References bpp::AbstractStateMap::getAlphabetStates(), and bpp::MarkovModulatedSubstitutionModel::stateMap_.

◆ getColumnRightEigenVectors()

const Matrix<double>& bpp::MarkovModulatedSubstitutionModel::getColumnRightEigenVectors ( ) const
inlinevirtualinherited
Returns
A matrix with right eigen vectors. Each column in the matrix stands for an eigen vector.

Implements bpp::SubstitutionModel.

Definition at line 222 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::rightEigenVectors_.

◆ getd2Pij_dt2()

const Matrix< double > & MarkovModulatedSubstitutionModel::getd2Pij_dt2 ( double  t) const
virtualinherited
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::SubstitutionModel.

Definition at line 195 of file MarkovModulatedSubstitutionModel.cpp.

References bpp::MarkovModulatedSubstitutionModel::d2pijt_, bpp::MarkovModulatedSubstitutionModel::eigenValues_, bpp::MarkovModulatedSubstitutionModel::leftEigenVectors_, and bpp::MarkovModulatedSubstitutionModel::rightEigenVectors_.

Referenced by bpp::MarkovModulatedSubstitutionModel::d2Pij_dt2().

◆ getdPij_dt()

const Matrix< double > & MarkovModulatedSubstitutionModel::getdPij_dt ( double  t) const
virtualinherited
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::SubstitutionModel.

Definition at line 189 of file MarkovModulatedSubstitutionModel.cpp.

References bpp::MarkovModulatedSubstitutionModel::dpijt_, bpp::MarkovModulatedSubstitutionModel::eigenValues_, bpp::MarkovModulatedSubstitutionModel::leftEigenVectors_, and bpp::MarkovModulatedSubstitutionModel::rightEigenVectors_.

Referenced by bpp::MarkovModulatedSubstitutionModel::dPij_dt().

◆ getEigenValues()

const Vdouble& bpp::MarkovModulatedSubstitutionModel::getEigenValues ( ) const
inlinevirtualinherited
Returns
A vector with all real parts of the eigen values of the generator of this model;

Implements bpp::SubstitutionModel.

Definition at line 215 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::eigenValues_.

◆ getExchangeabilityMatrix()

const Matrix<double>& bpp::MarkovModulatedSubstitutionModel::getExchangeabilityMatrix ( ) 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::SubstitutionModel.

Definition at line 207 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::exchangeability_.

◆ getFrequencies()

const Vdouble& bpp::MarkovModulatedSubstitutionModel::getFrequencies ( ) const
inlinevirtualinherited
Returns
A vector of all equilibrium frequencies.
See also
freq()

Implements bpp::SubstitutionModel.

Definition at line 205 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::freq_.

◆ getFrequenciesSet()

virtual const FrequenciesSet* bpp::SubstitutionModel::getFrequenciesSet ( ) const
inlinevirtualinherited

If the model owns a FrequenciesSet, returns a pointer to it, otherwise return 0.

Reimplemented in bpp::JCprot, bpp::AbstractBiblioSubstitutionModel, bpp::UserProteinSubstitutionModel, bpp::WAG01, bpp::DSO78, bpp::JTT92, bpp::LG08, bpp::YNGKP_M1, bpp::YNGKP_M8, bpp::YNGKP_M7, bpp::AbstractCodonPhaseFrequenciesSubstitutionModel, bpp::YNGKP_M3, bpp::YNGKP_M2, and bpp::AbstractCodonFrequenciesSubstitutionModel.

Definition at line 479 of file SubstitutionModel.h.

Referenced by bpp::AbstractBiblioSubstitutionModel::getFrequenciesSet(), and bpp::BppOSubstitutionModelFormat::write().

◆ getGenerator()

const Matrix<double>& bpp::MarkovModulatedSubstitutionModel::getGenerator ( ) 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 $t$ are measured in units of expected number of changes per site. Additionnaly, the rate_ attibute 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::SubstitutionModel.

Definition at line 209 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::generator_.

◆ getIEigenValues()

const Vdouble& bpp::MarkovModulatedSubstitutionModel::getIEigenValues ( ) const
inlinevirtualinherited
Returns
A vector with all imaginary parts of the eigen values of the generator of this model;

Implements bpp::SubstitutionModel.

Definition at line 216 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::iEigenValues_.

◆ getInitValue()

double MarkovModulatedSubstitutionModel::getInitValue ( size_t  i,
int  state 
) const
throw (IndexOutOfBoundsException,
BadIntException
)
virtualinherited

This method is used to initialize likelihoods in reccursions. 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
ithe index of the state in the model.
stateAn observed state in the sequence/site.
Returns
1 or 0 depending if the two states are compatible.
Exceptions
IndexOutOfBoundsExceptionif array position is out of range.
BadIntExceptionif states are not allowed in the associated alphabet.
See also
getStates();

Implements bpp::SubstitutionModel.

Definition at line 203 of file MarkovModulatedSubstitutionModel.cpp.

◆ getModelStates() [1/2]

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

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

Parameters
codeThe alphabet state to check.
Returns
A vector of indices of model states.

Implements bpp::SubstitutionModel.

Definition at line 201 of file MarkovModulatedSubstitutionModel.h.

References bpp::AbstractStateMap::getModelStates(), and bpp::MarkovModulatedSubstitutionModel::stateMap_.

◆ getModelStates() [2/2]

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

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

Parameters
codeThe alphabet state to check.
Returns
A vector of indices of model states.

Implements bpp::SubstitutionModel.

Definition at line 203 of file MarkovModulatedSubstitutionModel.h.

References bpp::AbstractStateMap::getModelStates(), and bpp::MarkovModulatedSubstitutionModel::stateMap_.

◆ getName()

std::string bpp::TS98::getName ( ) const
inlinevirtual

Get the name of the model.

Returns
The name of this model.

Implements bpp::SubstitutionModel.

Definition at line 108 of file TS98.h.

◆ getNestedModel()

const ReversibleSubstitutionModel* bpp::MarkovModulatedSubstitutionModel::getNestedModel ( ) const
inlineinherited

Definition at line 241 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::model_.

Referenced by bpp::BppOSubstitutionModelFormat::write().

◆ getNumberOfStates()

size_t bpp::MarkovModulatedSubstitutionModel::getNumberOfStates ( ) const
inlinevirtualinherited

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

Definition at line 191 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::nbRates_, and bpp::MarkovModulatedSubstitutionModel::nbStates_.

◆ getPij_t()

const Matrix< double > & MarkovModulatedSubstitutionModel::getPij_t ( double  t) const
virtualinherited
Returns
All probabilities of change from state i to state j during time t.
See also
Pij_t()

Implements bpp::SubstitutionModel.

Definition at line 180 of file MarkovModulatedSubstitutionModel.cpp.

References bpp::MarkovModulatedSubstitutionModel::eigenValues_, bpp::MarkovModulatedSubstitutionModel::leftEigenVectors_, bpp::MarkovModulatedSubstitutionModel::nbRates_, bpp::MarkovModulatedSubstitutionModel::nbStates_, bpp::MarkovModulatedSubstitutionModel::pijt_, and bpp::MarkovModulatedSubstitutionModel::rightEigenVectors_.

Referenced by bpp::MarkovModulatedSubstitutionModel::Pij_t().

◆ getRate() [1/2]

double bpp::TS98::getRate ( ) const
inlinevirtual

Get the rate.

Reimplemented from bpp::MarkovModulatedSubstitutionModel.

Definition at line 110 of file TS98.h.

◆ getRate() [2/2]

size_t bpp::MarkovModulatedSubstitutionModel::getRate ( size_t  i) const
inlineinherited

Get the rate category corresponding to a particular state in the compound model.

Parameters
iThe state.
Returns
The corresponding rate category.
See also
getState;

Definition at line 250 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::nbStates_.

◆ getRowLeftEigenVectors()

const Matrix<double>& bpp::MarkovModulatedSubstitutionModel::getRowLeftEigenVectors ( ) const
inlinevirtualinherited
Returns
A matrix with left eigen vectors. Each row in the matrix stands for an eigen vector.

Implements bpp::SubstitutionModel.

Definition at line 221 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::leftEigenVectors_.

◆ getScale()

double bpp::MarkovModulatedSubstitutionModel::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::SubstitutionModel.

Definition at line 259 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::freq_, and bpp::MarkovModulatedSubstitutionModel::generator_.

◆ getStateMap()

const StateMap& bpp::MarkovModulatedSubstitutionModel::getStateMap ( ) const
inlinevirtualinherited
Returns
The mapping of model states with alphabet states.

Implements bpp::SubstitutionModel.

Definition at line 193 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::stateMap_.

◆ isDiagonalizable()

bool bpp::MarkovModulatedSubstitutionModel::isDiagonalizable ( ) const
inlinevirtualinherited
Returns
True if the model is diagonalizable in R.

Implements bpp::SubstitutionModel.

Definition at line 218 of file MarkovModulatedSubstitutionModel.h.

◆ isNonSingular()

bool bpp::MarkovModulatedSubstitutionModel::isNonSingular ( ) const
inlinevirtualinherited
Returns
True is the model is non-singular.

Implements bpp::SubstitutionModel.

Definition at line 219 of file MarkovModulatedSubstitutionModel.h.

◆ Pij_t()

double bpp::MarkovModulatedSubstitutionModel::Pij_t ( size_t  i,
size_t  j,
double  t 
) const
inlinevirtualinherited
Returns
The probability of change from state i to state j during time t.
See also
getPij_t(), getStates()

Implements bpp::SubstitutionModel.

Definition at line 228 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::getPij_t().

◆ Qij()

double bpp::MarkovModulatedSubstitutionModel::Qij ( size_t  i,
size_t  j 
) const
inlinevirtualinherited
Returns
The rate in the generator of change from state i to state j.
See also
getStates();

Implements bpp::SubstitutionModel.

Definition at line 226 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::generator_.

◆ setFreq()

virtual void bpp::SubstitutionModel::setFreq ( std::map< int, double > &  frequencies)
inlinevirtualinherited

Set equilibrium frequencies.

Parameters
frequenciesThe map of the frequencies to use.

Reimplemented in bpp::AbstractSubstitutionModel, bpp::F84, bpp::HKY85, bpp::T92, bpp::MixtureOfSubstitutionModels, bpp::AbstractWordSubstitutionModel, bpp::GTR, bpp::RN95, bpp::TN93, bpp::RN95s, bpp::CodonDistanceFrequenciesSubstitutionModel, bpp::AbstractBiblioSubstitutionModel, bpp::MixtureOfASubstitutionModel, bpp::CodonDistanceFitnessPhaseFrequenciesSubstitutionModel, bpp::BinarySubstitutionModel, bpp::CodonDistancePhaseFrequenciesSubstitutionModel, bpp::SSR, bpp::L95, bpp::CodonRateFrequenciesSubstitutionModel, bpp::AbstractCodonPhaseFrequenciesSubstitutionModel, bpp::AbstractCodonFrequenciesSubstitutionModel, and bpp::AbstractCodonFitnessSubstitutionModel.

Definition at line 473 of file SubstitutionModel.h.

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

◆ setFreqFromData()

void bpp::MarkovModulatedSubstitutionModel::setFreqFromData ( const SequenceContainer &  data,
double  pseudoCount = 0 
)
inlinevirtualinherited

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

Parameters
dataThe sequences to use.
pseudoCountA 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)} \]

Implements bpp::SubstitutionModel.

Definition at line 234 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::model_, bpp::SubstitutionModel::setFreqFromData(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ setNamespace()

void MarkovModulatedSubstitutionModel::setNamespace ( const std::string &  prefix)
inherited

Definition at line 220 of file MarkovModulatedSubstitutionModel.cpp.

References bpp::MarkovModulatedSubstitutionModel::model_, and bpp::MarkovModulatedSubstitutionModel::nestedPrefix_.

Referenced by bpp::G2001::setNamespace().

◆ setRate()

void bpp::TS98::setRate ( double  rate)
inlinevirtual

Set the rate of the model (must be positive).

Parameters
ratemust be positive.

Reimplemented from bpp::MarkovModulatedSubstitutionModel.

Definition at line 112 of file TS98.h.

◆ setScale()

void bpp::MarkovModulatedSubstitutionModel::setScale ( double  scale)
inlinevirtualinherited

Multiplies the current generator by the given scale.

Parameters
scalethe scale by which the generator is multiplied.

Implements bpp::SubstitutionModel.

Definition at line 266 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::model_, bpp::SubstitutionModel::setScale(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ Sij()

double bpp::MarkovModulatedSubstitutionModel::Sij ( size_t  i,
size_t  j 
) const
inlinevirtualinherited
Returns
The exchangeability between state i and state j.

By definition Sij(i,j) = Sij(j,i).

Implements bpp::SubstitutionModel.

Definition at line 225 of file MarkovModulatedSubstitutionModel.h.

References bpp::MarkovModulatedSubstitutionModel::exchangeability_.

◆ updateMatrices()

void MarkovModulatedSubstitutionModel::updateMatrices ( )
protectedvirtualinherited

Definition at line 107 of file MarkovModulatedSubstitutionModel.cpp.

References bpp::MarkovModulatedSubstitutionModel::d2pijt_, bpp::MarkovModulatedSubstitutionModel::dpijt_, bpp::MarkovModulatedSubstitutionModel::eigenValues_, bpp::MarkovModulatedSubstitutionModel::exchangeability_, bpp::MarkovModulatedSubstitutionModel::freq_, bpp::MarkovModulatedSubstitutionModel::generator_, bpp::SubstitutionModel::getColumnRightEigenVectors(), bpp::SubstitutionModel::getEigenValues(), bpp::SubstitutionModel::getExchangeabilityMatrix(), bpp::SubstitutionModel::getFrequencies(), bpp::SubstitutionModel::getGenerator(), bpp::SubstitutionModel::getNumberOfStates(), bpp::MarkovModulatedSubstitutionModel::iEigenValues_, bpp::MarkovModulatedSubstitutionModel::leftEigenVectors_, bpp::MarkovModulatedSubstitutionModel::model_, bpp::MarkovModulatedSubstitutionModel::nbRates_, bpp::MarkovModulatedSubstitutionModel::nbStates_, bpp::MarkovModulatedSubstitutionModel::normalizeRateChanges_, bpp::MarkovModulatedSubstitutionModel::pijt_, bpp::MarkovModulatedSubstitutionModel::rates_, bpp::MarkovModulatedSubstitutionModel::ratesExchangeability_, bpp::MarkovModulatedSubstitutionModel::ratesFreq_, bpp::MarkovModulatedSubstitutionModel::ratesGenerator_, and bpp::MarkovModulatedSubstitutionModel::rightEigenVectors_.

Referenced by bpp::MarkovModulatedSubstitutionModel::fireParameterChanged(), bpp::G2001::G2001(), bpp::MarkovModulatedSubstitutionModel::setFreqFromData(), bpp::MarkovModulatedSubstitutionModel::setScale(), and TS98().

◆ updateRatesModel()

void bpp::TS98::updateRatesModel ( )
inlineprotectedvirtual

Update the rates vector, generator and equilibrium frequencies.

This method must be implemented by the derived class. It is called by the fireParameterChanged() method.

Implements bpp::MarkovModulatedSubstitutionModel.

Definition at line 117 of file TS98.h.

References bpp::MarkovModulatedSubstitutionModel::rates_, bpp::MarkovModulatedSubstitutionModel::ratesExchangeability_, and bpp::MarkovModulatedSubstitutionModel::ratesFreq_.

Referenced by TS98().

Member Data Documentation

◆ d2pijt_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::d2pijt_
mutableprotectedinherited

Definition at line 139 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getd2Pij_dt2(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ dpijt_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::dpijt_
mutableprotectedinherited

Definition at line 138 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getdPij_dt(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ eigenDecompose_

bool bpp::MarkovModulatedSubstitutionModel::eigenDecompose_
protectedinherited

Tell if the eigen decomposition should be performed.

Definition at line 132 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::enableEigenDecomposition(), and bpp::MarkovModulatedSubstitutionModel::operator=().

◆ eigenValues_

Vdouble bpp::MarkovModulatedSubstitutionModel::eigenValues_
protectedinherited

The vector of real parts of eigen values.

Definition at line 121 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getd2Pij_dt2(), bpp::MarkovModulatedSubstitutionModel::getdPij_dt(), bpp::MarkovModulatedSubstitutionModel::getEigenValues(), bpp::MarkovModulatedSubstitutionModel::getPij_t(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ exchangeability_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::exchangeability_
protectedinherited

The exchangeability matrix $S$ of the model.

Definition at line 106 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getExchangeabilityMatrix(), bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::Sij(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ freq_

Vdouble bpp::MarkovModulatedSubstitutionModel::freq_
protectedinherited

The vector of equilibrium frequencies.

Definition at line 144 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::freq(), bpp::MarkovModulatedSubstitutionModel::getFrequencies(), bpp::MarkovModulatedSubstitutionModel::getScale(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ generator_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::generator_
protectedinherited

The generator matrix $Q$ of the model.

Definition at line 101 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getGenerator(), bpp::MarkovModulatedSubstitutionModel::getScale(), bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::Qij(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ iEigenValues_

Vdouble bpp::MarkovModulatedSubstitutionModel::iEigenValues_
protectedinherited

The vector of imaginary parts of the eigen values (zero in case of reversible pmodel).

Definition at line 127 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getIEigenValues(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ leftEigenVectors_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::leftEigenVectors_
protectedinherited

The $U$ matrix made of left eigen vectors (by row).

Definition at line 111 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getd2Pij_dt2(), bpp::MarkovModulatedSubstitutionModel::getdPij_dt(), bpp::MarkovModulatedSubstitutionModel::getPij_t(), bpp::MarkovModulatedSubstitutionModel::getRowLeftEigenVectors(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ model_

ReversibleSubstitutionModel* bpp::MarkovModulatedSubstitutionModel::model_
protectedinherited

Definition at line 81 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::fireParameterChanged(), bpp::MarkovModulatedSubstitutionModel::getAlphabet(), bpp::MarkovModulatedSubstitutionModel::getNestedModel(), bpp::MarkovModulatedSubstitutionModel::getRate(), bpp::MarkovModulatedSubstitutionModel::MarkovModulatedSubstitutionModel(), bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::setFreqFromData(), bpp::MarkovModulatedSubstitutionModel::setNamespace(), bpp::MarkovModulatedSubstitutionModel::setRate(), bpp::MarkovModulatedSubstitutionModel::setScale(), bpp::MarkovModulatedSubstitutionModel::updateMatrices(), and bpp::MarkovModulatedSubstitutionModel::~MarkovModulatedSubstitutionModel().

◆ nbRates_

size_t bpp::MarkovModulatedSubstitutionModel::nbRates_
protectedinherited

Definition at line 84 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::G2001::G2001(), bpp::MarkovModulatedSubstitutionModel::getNumberOfStates(), bpp::MarkovModulatedSubstitutionModel::getPij_t(), bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::updateMatrices(), and bpp::G2001::updateRatesModel().

◆ nbStates_

size_t bpp::MarkovModulatedSubstitutionModel::nbStates_
protectedinherited

Definition at line 83 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getNumberOfStates(), bpp::MarkovModulatedSubstitutionModel::getPij_t(), bpp::MarkovModulatedSubstitutionModel::getRate(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ nestedPrefix_

std::string bpp::MarkovModulatedSubstitutionModel::nestedPrefix_
protectedinherited

Definition at line 148 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::MarkovModulatedSubstitutionModel(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::setNamespace().

◆ normalizeRateChanges_

bool bpp::MarkovModulatedSubstitutionModel::normalizeRateChanges_
protectedinherited

Definition at line 146 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ pijt_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::pijt_
mutableprotectedinherited

These ones are for bookkeeping:

Definition at line 137 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getPij_t(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ rates_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::rates_
protectedinherited

Definition at line 92 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::updateMatrices(), updateRatesModel(), and bpp::G2001::updateRatesModel().

◆ ratesExchangeability_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::ratesExchangeability_
protectedinherited

Definition at line 93 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::updateMatrices(), updateRatesModel(), and bpp::G2001::updateRatesModel().

◆ ratesFreq_

Vdouble bpp::MarkovModulatedSubstitutionModel::ratesFreq_
protectedinherited

Definition at line 94 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::G2001::G2001(), bpp::MarkovModulatedSubstitutionModel::operator=(), bpp::MarkovModulatedSubstitutionModel::updateMatrices(), and updateRatesModel().

◆ ratesGenerator_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::ratesGenerator_
protectedinherited

Definition at line 96 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ rightEigenVectors_

RowMatrix<double> bpp::MarkovModulatedSubstitutionModel::rightEigenVectors_
protectedinherited

The $U^-1$ matrix made of right eigen vectors (by column).

Definition at line 116 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getColumnRightEigenVectors(), bpp::MarkovModulatedSubstitutionModel::getd2Pij_dt2(), bpp::MarkovModulatedSubstitutionModel::getdPij_dt(), bpp::MarkovModulatedSubstitutionModel::getPij_t(), bpp::MarkovModulatedSubstitutionModel::operator=(), and bpp::MarkovModulatedSubstitutionModel::updateMatrices().

◆ stateMap_

MarkovModulatedStateMap bpp::MarkovModulatedSubstitutionModel::stateMap_
protectedinherited

Definition at line 82 of file MarkovModulatedSubstitutionModel.h.

Referenced by bpp::MarkovModulatedSubstitutionModel::getAlphabetStateAsChar(), bpp::MarkovModulatedSubstitutionModel::getAlphabetStateAsInt(), bpp::MarkovModulatedSubstitutionModel::getAlphabetStates(), bpp::MarkovModulatedSubstitutionModel::getModelStates(), bpp::MarkovModulatedSubstitutionModel::getStateMap(), and bpp::MarkovModulatedSubstitutionModel::operator=().

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