bpp-phyl  2.2.0
 All Classes Namespaces Files Functions Variables Typedefs Friends Pages
bpp::DRHomogeneousTreeLikelihood Class Referenceabstract

This class implements the likelihood computation for a tree using the double-recursive algorithm. More...

#include <Bpp/Phyl/Likelihood/DRHomogeneousTreeLikelihood.h>

+ Inheritance diagram for bpp::DRHomogeneousTreeLikelihood:
+ Collaboration diagram for bpp::DRHomogeneousTreeLikelihood:

Public Member Functions

 DRHomogeneousTreeLikelihood (const Tree &tree, SubstitutionModel *model, DiscreteDistribution *rDist, bool checkRooted=true, bool verbose=true) throw (Exception)
 Build a new DRHomogeneousTreeLikelihood object without data. More...
 
 DRHomogeneousTreeLikelihood (const Tree &tree, const SiteContainer &data, SubstitutionModel *model, DiscreteDistribution *rDist, bool checkRooted=true, bool verbose=true) throw (Exception)
 Build a new DRHomogeneousTreeLikelihood object and compute the corresponding likelihood. More...
 
 DRHomogeneousTreeLikelihood (const DRHomogeneousTreeLikelihood &lik)
 Copy constructor. More...
 
DRHomogeneousTreeLikelihoodoperator= (const DRHomogeneousTreeLikelihood &lik)
 
virtual ~DRHomogeneousTreeLikelihood ()
 
DRHomogeneousTreeLikelihoodclone () const
 
void computeTreeLikelihood ()
 
void setParameters (const ParameterList &parameters) throw (ParameterNotFoundException, ConstraintException)
 Implements the Function interface. More...
 
double getValue () const throw (Exception)
 Function and NNISearchable interface. More...
 
DRASDRTreeLikelihoodDatagetLikelihoodData ()
 
const DRASDRTreeLikelihoodDatagetLikelihoodData () const
 
virtual void computeLikelihoodAtNode (int nodeId, VVVdouble &likelihoodArray) const
 Compute the likelihood array at a given node. More...
 
virtual void initParameters ()
 This builds the parameters list from all parametrizable objects, i.e. substitution model, rate distribution and tree. More...
 
virtual void applyParameters () throw (Exception)
 All parameters are stored in a parameter list. This function apply these parameters to the substitution model, to the rate distribution and to the branch lengths. More...
 
virtual void initBranchLengthsParameters (bool verbose=true)
 
virtual void setMinimumBranchLength (double minimum) throw (Exception)
 
virtual void setMaximumBranchLength (double maximum) throw (Exception)
 
virtual double getMinimumBranchLength () const
 
virtual double getMaximumBranchLength () const
 
virtual const SiteContainergetData () const =0
 Get the dataset for which the likelihood must be evaluated. More...
 
virtual bool isInitialized () const =0
 
virtual double getLikelihoodForASiteForAState (size_t site, int state) const =0
 Get the likelihood for a site and for a state. More...
 
virtual double getLogLikelihoodForASiteForAState (size_t site, int state) const =0
 Get the logarithm of the likelihood for a site and for a state. More...
 
virtual Vdouble getLikelihoodForEachSite () const =0
 Get the likelihood for each site. More...
 
virtual Vdouble getLogLikelihoodForEachSite () const =0
 Get the logarithm of the likelihood for each site. More...
 
virtual VVdouble getLikelihoodForEachSiteForEachState () const =0
 Get the likelihood for each site and for each state. More...
 
virtual VVdouble getLogLikelihoodForEachSiteForEachState () const =0
 Get the logarithm of the likelihood for each site and for each state. More...
 
virtual const TreegetTree () const =0
 Get the tree (topology and branch lengths). More...
 
virtual size_t getNumberOfSites () const =0
 Get the number of sites in the dataset. More...
 
virtual const AlphabetgetAlphabet () const =0
 Get the alphabet associated to the dataset. More...
 
virtual void enableDerivatives (bool yn)=0
 Tell if derivatives must be computed. More...
 
virtual ParameterList getDerivableParameters () const =0
 All derivable parameters. More...
 
virtual ParameterList getNonDerivableParameters () const =0
 All non derivable parameters. More...
 
virtual void enableSecondOrderDerivatives (bool yn)=0
 
virtual bool enableSecondOrderDerivatives () const =0
 
virtual void enableFirstOrderDerivatives (bool yn)=0
 
virtual bool enableFirstOrderDerivatives () const =0
 
void setNamespace (const std::string &prefix)
 
The TreeLikelihood interface.

Other methods are implemented in the AbstractTreeLikelihood class.

void setData (const SiteContainer &sites) throw (Exception)
 Set the dataset for which the likelihood must be evaluated. More...
 
double getLikelihood () const
 Get the likelihood for the whole dataset. More...
 
double getLogLikelihood () const
 Get the logarithm of the likelihood for the whole dataset. More...
 
double getLikelihoodForASite (size_t site) const
 Get the likelihood for a site. More...
 
double getLogLikelihoodForASite (size_t site) const
 Get the logarithm of the likelihood for a site. More...
 
size_t getSiteIndex (size_t site) const throw (IndexOutOfBoundsException)
 Get the index (used for inner computations) of a given site (original alignment column). More...
 
The DiscreteRatesAcrossSites interface implementation:
double getLikelihoodForASiteForARateClass (size_t site, size_t rateClass) const
 Get the likelihood for a site knowing its rate class. More...
 
double getLogLikelihoodForASiteForARateClass (size_t site, size_t rateClass) const
 Get the logarithm of the likelihood for a site knowing its rate class. More...
 
double getLikelihoodForASiteForARateClassForAState (size_t site, size_t rateClass, int state) const
 Get the likelihood for a site knowing its rate class and its ancestral state. More...
 
double getLogLikelihoodForASiteForARateClassForAState (size_t site, size_t rateClass, int state) const
 Get the logarithm of the likelihood for a site knowing its rate class and its ancestral state. More...
 
DerivableFirstOrder interface.
double getFirstOrderDerivative (const std::string &variable) const throw (Exception)
 
DerivableSecondOrder interface.
double getSecondOrderDerivative (const std::string &variable) const throw (Exception)
 
double getSecondOrderDerivative (const std::string &variable1, const std::string &variable2) const throw (Exception)
 
The TreeLikelihood interface.

Other methods are implemented in the AbstractTreeLikelihood class.

size_t getNumberOfStates () const
 
const std::vector< int > & getAlphabetStates () const
 
int getAlphabetStateAsInt (size_t i) const
 
std::string getAlphabetStateAsChar (size_t i) const
 
void initialize () throw (Exception)
 Init the likelihood object. More...
 
ParameterList getBranchLengthsParameters () const
 Get the branch lengths parameters. More...
 
ParameterList getSubstitutionModelParameters () const
 Get the parameters associated to substitution model(s). More...
 
ParameterList getRateDistributionParameters () const
 Get the parameters associated to the rate distirbution. More...
 
const std::vector< double > & getRootFrequencies (size_t siteIndex) const
 Get the values of the frequencies for each state in the alphabet at the root node. More...
 
VVVdouble getTransitionProbabilitiesPerRateClass (int nodeId, size_t siteIndex) const
 Retrieves all Pij(t) for a particular branch, defined by the upper node. More...
 
ConstBranchModelIteratorgetNewBranchModelIterator (int nodeId) const
 
ConstSiteModelIteratorgetNewSiteModelIterator (size_t siteIndex) const
 
The HomogeneousTreeLikelihood interface.

Other methods are implemented in the AbstractTreeLikelihood class.

const SubstitutionModelgetSubstitutionModel () const
 
const SubstitutionModelgetSubstitutionModel (int nodeId, size_t siteIndex) const throw (NodeNotFoundException)
 Get the substitution model associated to a given node and alignment column. More...
 
SubstitutionModelgetSubstitutionModel ()
 
SubstitutionModelgetSubstitutionModel (int nodeId, size_t siteIndex) throw (NodeNotFoundException)
 Get the substitution model associated to a given node and alignment column. More...
 
void setSubstitutionModel (SubstitutionModel *model) throw (Exception)
 
The TreeLikelihood interface.
const SiteContainergetData () const
 Get the dataset for which the likelihood must be evaluated. More...
 
bool isInitialized () const
 
Vdouble getLikelihoodForEachSite () const
 Get the likelihood for each site. More...
 
Vdouble getLogLikelihoodForEachSite () const
 Get the logarithm of the likelihood for each site. More...
 
VVdouble getLikelihoodForEachSiteForEachState () const
 Get the likelihood for each site and for each state. More...
 
VVdouble getLogLikelihoodForEachSiteForEachState () const
 Get the logarithm of the likelihood for each site and for each state. More...
 
const TreegetTree () const
 Get the tree (topology and branch lengths). More...
 
size_t getNumberOfSites () const
 Get the number of sites in the dataset. More...
 
const AlphabetgetAlphabet () const
 Get the alphabet associated to the dataset. More...
 
void enableDerivatives (bool yn)
 Tell if derivatives must be computed. More...
 
void enableSecondOrderDerivatives (bool yn)
 
bool enableSecondOrderDerivatives () const
 
void enableFirstOrderDerivatives (bool yn)
 
bool enableFirstOrderDerivatives () const
 
The TreeLikelihood interface.

Other methods are implemented in the AbstractTreeLikelihood class.

double getLikelihoodForASiteForAState (size_t site, int state) const
 Get the likelihood for a site and for a state. More...
 
double getLogLikelihoodForASiteForAState (size_t site, int state) const
 Get the logarithm of the likelihood for a site and for a state. More...
 
VVdouble getTransitionProbabilities (int nodeId, size_t siteIndex) const
 Retrieves all Pij(t) for a particular branch, defined by the upper node and site. More...
 
ParameterList getDerivableParameters () const
 All derivable parameters. More...
 
ParameterList getNonDerivableParameters () const
 All non derivable parameters. More...
 
Retrieve some particular parameters subsets.
virtual VVdouble getTransitionProbabilities (int nodeId, size_t siteIndex) const =0
 Retrieves all Pij(t) for a particular branch, defined by the upper node and site. More...
 
The DiscreteRatesAcrossSites interface implementation:
const DiscreteDistributiongetRateDistribution () const
 Get the rate distribution used for the computation. More...
 
DiscreteDistributiongetRateDistribution ()
 Get the rate distribution used for the computation. More...
 
size_t getNumberOfClasses () const
 Get the number of classes. More...
 
VVdouble getLikelihoodForEachSiteForEachRateClass () const
 Get the likelihood for each site and each rate class. More...
 
VVdouble getLogLikelihoodForEachSiteForEachRateClass () const
 Get the logarithm of the likelihood for each site and each rate class. More...
 
VVVdouble getLikelihoodForEachSiteForEachRateClassForEachState () const
 Get the likelihood for each site and each rate class and each state. More...
 
VVVdouble getLogLikelihoodForEachSiteForEachRateClassForEachState () const
 Get the logarithm of the likelihood for each site and each rate class and each state. More...
 
VVdouble getPosteriorProbabilitiesOfEachRate () const
 Get the posterior probability for each site of belonging to a particular rate class. More...
 
Vdouble getRateWithMaxPostProbOfEachSite () const
 Get the posterior rate (the one with maximum posterior probability) for each site. More...
 
std::vector< size_t > getRateClassWithMaxPostProbOfEachSite () const
 Get the posterior rate class (the one with maximum posterior probability) for each site. More...
 
Vdouble getPosteriorRateOfEachSite () const
 Get the posterior rate, i.e. averaged over all classes and weighted with posterior probabilities, for each site. More...
 

Static Public Member Functions

Generic tools to deal with likelihood arrays
static void resetLikelihoodArray (VVVdouble &likelihoodArray)
 Set all conditional likelihoods to 1. More...
 
static void displayLikelihoodArray (const VVVdouble &likelihoodArray)
 Print the likelihood array to terminal (debugging tool). More...
 

Protected Member Functions

virtual void computeLikelihoodAtNode_ (const Node *node, VVVdouble &likelihoodArray, const Node *sonNode=0) const
 
virtual void computeSubtreeLikelihoodPostfix (const Node *node)
 
virtual void computeSubtreeLikelihoodPrefix (const Node *node)
 
virtual void computeRootLikelihood ()
 
virtual void computeTreeDLikelihoodAtNode (const Node *node)
 
virtual void computeTreeDLikelihoods ()
 
virtual void computeTreeD2LikelihoodAtNode (const Node *node)
 
virtual void computeTreeD2Likelihoods ()
 
virtual void fireParameterChanged (const ParameterList &params)
 
virtual void resetLikelihoodArrays (const Node *node)
 
virtual void displayLikelihood (const Node *node)
 This method is mainly for debugging purpose. More...
 
virtual void computeAllTransitionProbabilities ()
 Fill the pxy_, dpxy_ and d2pxy_ arrays for all nodes. More...
 
virtual void computeTransitionProbabilitiesForNode (const Node *node)
 Fill the pxy_, dpxy_ and d2pxy_ arrays for one node. More...
 
void addParameter_ (Parameter *parameter)
 
void addParameters_ (const ParameterList &parameters)
 
void deleteParameter_ (size_t index)
 
void deleteParameter_ (std::string &name)
 
void deleteParameters_ (const std::vector< std::string > &names)
 
void resetParameters_ ()
 

Static Protected Member Functions

static void computeLikelihoodFromArrays (const std::vector< const VVVdouble * > &iLik, const std::vector< const VVVdouble * > &tProb, VVVdouble &oLik, size_t nbNodes, size_t nbDistinctSites, size_t nbClasses, size_t nbStates, bool reset=true)
 Compute conditional likelihoods. More...
 
static void computeLikelihoodFromArrays (const std::vector< const VVVdouble * > &iLik, const std::vector< const VVVdouble * > &tProb, const VVVdouble *iLikR, const VVVdouble *tProbR, VVVdouble &oLik, size_t nbNodes, size_t nbDistinctSites, size_t nbClasses, size_t nbStates, bool reset=true)
 Compute conditional likelihoods. More...
 

Protected Attributes

double minusLogLik_
 
SubstitutionModelmodel_
 
ParameterList brLenParameters_
 
std::map< int, VVVdoublepxy_
 
std::map< int, VVVdoubledpxy_
 
std::map< int, VVVdoubled2pxy_
 
std::vector< double > rootFreqs_
 
std::vector< Node * > nodes_
 Pointer toward all nodes in the tree. More...
 
size_t nbSites_
 
size_t nbDistinctSites_
 
size_t nbClasses_
 
size_t nbStates_
 
size_t nbNodes_
 
bool verbose_
 
double minimumBrLen_
 
double maximumBrLen_
 
std::auto_ptr< ConstraintbrLenConstraint_
 
DiscreteDistributionrateDistribution_
 
const SiteContainerdata_
 
TreeTemplate< Node > * tree_
 
bool computeFirstOrderDerivatives_
 
bool computeSecondOrderDerivatives_
 
bool initialized_
 

Private Member Functions

void init_ () throw (Exception)
 Method called by constructors. More...
 

Private Attributes

DRASDRTreeLikelihoodDatalikelihoodData_
 

Friends

class DRHomogeneousMixedTreeLikelihood
 

Detailed Description

This class implements the likelihood computation for a tree using the double-recursive algorithm.

The substitution model is the same over the tree (homogeneous model). A non-uniform distribution of rates among the sites is allowed (ASRV models).

This class uses an instance of the DRASDRTreeLikelihoodData for conditionnal likelihood storage.

All nodes share the same site patterns.

Definition at line 64 of file DRHomogeneousTreeLikelihood.h.

Constructor & Destructor Documentation

DRHomogeneousTreeLikelihood::DRHomogeneousTreeLikelihood ( const Tree tree,
SubstitutionModel model,
DiscreteDistribution rDist,
bool  checkRooted = true,
bool  verbose = true 
)
throw (Exception
)

Build a new DRHomogeneousTreeLikelihood object without data.

This constructor only initialize the parameters. To compute a likelihood, you will need to call the setData() and the computeTreeLikelihood() methods.

Parameters
treeThe tree to use.
modelThe substitution model to use.
rDistThe rate across sites distribution to use.
checkRootedTell if we have to check for the tree to be unrooted. If true, any rooted tree will be unrooted before likelihood computation.
verboseShould I display some info?
Exceptions
Exceptionin an error occured.

Definition at line 60 of file DRHomogeneousTreeLikelihood.cpp.

Referenced by clone().

DRHomogeneousTreeLikelihood::DRHomogeneousTreeLikelihood ( const Tree tree,
const SiteContainer data,
SubstitutionModel model,
DiscreteDistribution rDist,
bool  checkRooted = true,
bool  verbose = true 
)
throw (Exception
)

Build a new DRHomogeneousTreeLikelihood object and compute the corresponding likelihood.

This constructor initializes all parameters, data, and likelihood arrays.

Parameters
treeThe tree to use.
dataSequences to use.
modelThe substitution model to use.
rDistThe rate across sites distribution to use.
checkRootedTell if we have to check for the tree to be unrooted. If true, any rooted tree will be unrooted before likelihood computation.
verboseShould I display some info?
Exceptions
Exceptionin an error occured.

Definition at line 76 of file DRHomogeneousTreeLikelihood.cpp.

DRHomogeneousTreeLikelihood::DRHomogeneousTreeLikelihood ( const DRHomogeneousTreeLikelihood lik)
DRHomogeneousTreeLikelihood::~DRHomogeneousTreeLikelihood ( )
virtual

Definition at line 128 of file DRHomogeneousTreeLikelihood.cpp.

References likelihoodData_.

Member Function Documentation

DRHomogeneousTreeLikelihood* bpp::DRHomogeneousTreeLikelihood::clone ( ) const
inlinevirtual
virtual void bpp::DRHomogeneousTreeLikelihood::computeLikelihoodAtNode ( int  nodeId,
VVVdouble likelihoodArray 
) const
inlinevirtual

Compute the likelihood array at a given node.

Parameters
nodeIdThe id of the node to consider.
likelihoodArrayThe array where to store the results.

Implements bpp::DRTreeLikelihood.

Definition at line 209 of file DRHomogeneousTreeLikelihood.h.

References computeLikelihoodAtNode_(), and bpp::AbstractTreeLikelihood::tree_.

void DRHomogeneousTreeLikelihood::computeLikelihoodFromArrays ( const std::vector< const VVVdouble * > &  iLik,
const std::vector< const VVVdouble * > &  tProb,
VVVdouble oLik,
size_t  nbNodes,
size_t  nbDistinctSites,
size_t  nbClasses,
size_t  nbStates,
bool  reset = true 
)
staticprotected

Compute conditional likelihoods.

This method is the "core" likelihood computation function, performing all the product uppon all nodes, the summation for each ancestral state and each rate class. It is designed for inner usage, and a maximum efficiency, so no checking is performed on the input parameters. Use with care!

Parameters
iLikA vector of likelihood arrays, one for each conditional node.
tProbA vector of transition probabilities, one for each node.
oLikThe likelihood array to store the computed likelihoods.
nbNodesThe number of nodes = the size of the input vectors.
nbDistinctSitesThe number of distinct sites (the first dimension of the likelihood array).
nbClassesThe number of rate classes (the second dimension of the likelihood array).
nbStatesThe number of states (the third dimension of the likelihood array).
resetTell if the output likelihood array must be initalized prior to computation. If true, the resetLikelihoodArray method will be called.

Definition at line 825 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::resetLikelihoodArray().

Referenced by computeLikelihoodAtNode_(), computeRootLikelihood(), computeSubtreeLikelihoodPostfix(), and computeSubtreeLikelihoodPrefix().

void DRHomogeneousTreeLikelihood::computeLikelihoodFromArrays ( const std::vector< const VVVdouble * > &  iLik,
const std::vector< const VVVdouble * > &  tProb,
const VVVdouble iLikR,
const VVVdouble tProbR,
VVVdouble oLik,
size_t  nbNodes,
size_t  nbDistinctSites,
size_t  nbClasses,
size_t  nbStates,
bool  reset = true 
)
staticprotected

Compute conditional likelihoods.

This method is the "core" likelihood computation function, performing all the product uppon all nodes, the summation for each ancestral state and each rate class. This function is specific to non-reversible models: the subtree containing the root is specified separately. It is designed for inner usage, and a maximum efficiency, so no checking is performed on the input parameters. Use with care!

Parameters
iLikA vector of likelihood arrays, one for each conditional node.
tProbA vector of transition probabilities, one for each node.
iLikRThe likelihood array for the subtree containing the root of the tree.
tProbRThe transition probabilities for thr subtree containing the root of the tree.
oLikThe likelihood array to store the computed likelihoods.
nbNodesThe number of nodes = the size of the input vectors.
nbDistinctSitesThe number of distinct sites (the first dimension of the likelihood array).
nbClassesThe number of rate classes (the second dimension of the likelihood array).
nbStatesThe number of states (the third dimension of the likelihood array).
resetTell if the output likelihood array must be initalized prior to computation. If true, the resetLikelihoodArray method will be called.

Definition at line 874 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::resetLikelihoodArray().

void DRHomogeneousTreeLikelihood::computeSubtreeLikelihoodPostfix ( const Node node)
protectedvirtual
void DRHomogeneousTreeLikelihood::computeTreeD2Likelihoods ( )
protectedvirtual
void DRHomogeneousTreeLikelihood::computeTreeDLikelihoods ( )
protectedvirtual
void DRHomogeneousTreeLikelihood::computeTreeLikelihood ( )
void DRHomogeneousTreeLikelihood::displayLikelihood ( const Node node)
protectedvirtual
void AbstractDiscreteRatesAcrossSitesTreeLikelihood::displayLikelihoodArray ( const VVVdouble likelihoodArray)
staticinherited

Print the likelihood array to terminal (debugging tool).

Parameters
likelihoodArraythe likelihood array.

Definition at line 287 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

Referenced by displayLikelihood(), bpp::DRNonHomogeneousTreeLikelihood::displayLikelihood(), bpp::RHomogeneousTreeLikelihood::displayLikelihood(), and bpp::RNonHomogeneousTreeLikelihood::displayLikelihood().

void bpp::AbstractTreeLikelihood::enableDerivatives ( bool  yn)
inlinevirtualinherited

Tell if derivatives must be computed.

This methods calls the enableFirstOrderDerivatives and enableSecondOrderDerivatives.

Parameters
ynYes or no.

Implements bpp::TreeLikelihood.

Definition at line 292 of file AbstractTreeLikelihood.h.

References bpp::AbstractTreeLikelihood::computeFirstOrderDerivatives_, and bpp::AbstractTreeLikelihood::computeSecondOrderDerivatives_.

Referenced by bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::AbstractDiscreteRatesAcrossSitesTreeLikelihood(), and bpp::DistanceEstimation::computeMatrix().

virtual void bpp::TreeLikelihood::enableDerivatives ( bool  yn)
pure virtualinherited

Tell if derivatives must be computed.

This methods calls the enableFirstOrderDerivatives and enableSecondOrderDerivatives.

Parameters
ynYes or no.

Implemented in bpp::AbstractTreeLikelihood.

void bpp::AbstractTreeLikelihood::enableFirstOrderDerivatives ( bool  yn)
inlinevirtualinherited
bool bpp::AbstractTreeLikelihood::enableFirstOrderDerivatives ( ) const
inlinevirtualinherited
void bpp::AbstractTreeLikelihood::enableSecondOrderDerivatives ( bool  yn)
inlinevirtualinherited
bool bpp::AbstractTreeLikelihood::enableSecondOrderDerivatives ( ) const
inlinevirtualinherited
const Alphabet* bpp::AbstractTreeLikelihood::getAlphabet ( ) const
inlinevirtualinherited

Get the alphabet associated to the dataset.

Returns
the alphabet associated to the dataset.

Implements bpp::TreeLikelihood.

Definition at line 285 of file AbstractTreeLikelihood.h.

References bpp::AbstractTreeLikelihood::data_, and bpp::OrderedSequenceContainer::getAlphabet().

virtual const Alphabet* bpp::TreeLikelihood::getAlphabet ( ) const
pure virtualinherited

Get the alphabet associated to the dataset.

Returns
the alphabet associated to the dataset.

Implemented in bpp::AbstractTreeLikelihood.

std::string bpp::AbstractHomogeneousTreeLikelihood::getAlphabetStateAsChar ( size_t  i) const
inlinevirtualinherited
Returns
the alphabet state corresponding to the given model state.

Implements bpp::TreeLikelihood.

Definition at line 171 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::SubstitutionModel::getAlphabetStateAsChar(), and bpp::AbstractHomogeneousTreeLikelihood::model_.

int bpp::AbstractHomogeneousTreeLikelihood::getAlphabetStateAsInt ( size_t  i) const
inlinevirtualinherited
Returns
the alphabet state corresponding to the given model state.

Implements bpp::TreeLikelihood.

Definition at line 169 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::SubstitutionModel::getAlphabetStateAsInt(), and bpp::AbstractHomogeneousTreeLikelihood::model_.

const std::vector<int>& bpp::AbstractHomogeneousTreeLikelihood::getAlphabetStates ( ) const
inlinevirtualinherited
Returns
the alphabet states corresponding to all model states.

Implements bpp::TreeLikelihood.

Definition at line 167 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::SubstitutionModel::getAlphabetStates(), and bpp::AbstractHomogeneousTreeLikelihood::model_.

ParameterList AbstractHomogeneousTreeLikelihood::getBranchLengthsParameters ( ) const
virtualinherited
virtual const SiteContainer* bpp::TreeLikelihood::getData ( ) const
pure virtualinherited

Get the dataset for which the likelihood must be evaluated.

Returns
A pointer toward the site container where the sequences are stored.

Implemented in bpp::AbstractTreeLikelihood.

const SiteContainer* bpp::AbstractTreeLikelihood::getData ( ) const
inlinevirtualinherited

Get the dataset for which the likelihood must be evaluated.

Returns
A pointer toward the site container where the sequences are stored.

Implements bpp::TreeLikelihood.

Definition at line 284 of file AbstractTreeLikelihood.h.

References bpp::AbstractTreeLikelihood::data_.

Referenced by bpp::RNonHomogeneousMixedTreeLikelihood::init().

ParameterList AbstractDiscreteRatesAcrossSitesTreeLikelihood::getDerivableParameters ( ) const
virtualinherited

All derivable parameters.

Usually, this contains all branch lengths parameters.

Returns
A ParameterList.

Implements bpp::TreeLikelihood.

Reimplemented in bpp::RHomogeneousClockTreeLikelihood.

Definition at line 73 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

virtual ParameterList bpp::TreeLikelihood::getDerivableParameters ( ) const
pure virtualinherited

All derivable parameters.

Usually, this contains all branch lengths parameters.

Returns
A ParameterList.

Implemented in bpp::RHomogeneousClockTreeLikelihood, and bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood.

double DRHomogeneousTreeLikelihood::getFirstOrderDerivative ( const std::string &  variable) const
throw (Exception
)
virtual

Implements bpp::DerivableFirstOrder.

Definition at line 344 of file DRHomogeneousTreeLikelihood.cpp.

double DRHomogeneousTreeLikelihood::getLikelihood ( ) const
virtual
DRASDRTreeLikelihoodData* bpp::DRHomogeneousTreeLikelihood::getLikelihoodData ( )
inlinevirtual
Returns
The underlying likelihood data structure.

Implements bpp::DRTreeLikelihood.

Definition at line 206 of file DRHomogeneousTreeLikelihood.h.

References likelihoodData_.

Referenced by bpp::NNIHomogeneousTreeLikelihood::setData(), and bpp::NNIHomogeneousTreeLikelihood::topologyChangeTested().

const DRASDRTreeLikelihoodData* bpp::DRHomogeneousTreeLikelihood::getLikelihoodData ( ) const
inlinevirtual
Returns
The underlying likelihood data structure.

Implements bpp::DRTreeLikelihood.

Definition at line 207 of file DRHomogeneousTreeLikelihood.h.

References likelihoodData_.

double DRHomogeneousTreeLikelihood::getLikelihoodForASite ( size_t  site) const
virtual

Get the likelihood for a site.

Parameters
siteThe site index to analyse.
Returns
The likelihood for site site.

Implements bpp::TreeLikelihood.

Definition at line 192 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), bpp::DRASDRTreeLikelihoodData::getRootRateSiteLikelihoodArray(), and likelihoodData_.

double DRHomogeneousTreeLikelihood::getLikelihoodForASiteForARateClass ( size_t  site,
size_t  rateClass 
) const
virtual

Get the likelihood for a site knowing its rate class.

Parameters
siteThe site index.
rateClassThe rate class index.
Returns
The likelihood for the specified site and rate class.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 205 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), bpp::DRASDRTreeLikelihoodData::getRootSiteLikelihoodArray(), and likelihoodData_.

double DRHomogeneousTreeLikelihood::getLikelihoodForASiteForARateClassForAState ( size_t  site,
size_t  rateClass,
int  state 
) const
virtual

Get the likelihood for a site knowing its rate class and its ancestral state.

Parameters
siteThe site index.
rateClassThe rate class index.
stateThe ancestral state.
Returns
The likelihood for the specified site and rate class and ancestral state.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 219 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), bpp::DRASDRTreeLikelihoodData::getRootLikelihoodArray(), and likelihoodData_.

double AbstractDiscreteRatesAcrossSitesTreeLikelihood::getLikelihoodForASiteForAState ( size_t  site,
int  state 
) const
virtualinherited

Get the likelihood for a site and for a state.

Parameters
siteThe site index to analyse.
stateThe state to consider.
Returns
The likelihood for site site and state state.

Implements bpp::TreeLikelihood.

Definition at line 111 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

virtual double bpp::TreeLikelihood::getLikelihoodForASiteForAState ( size_t  site,
int  state 
) const
pure virtualinherited

Get the likelihood for a site and for a state.

Parameters
siteThe site index to analyse.
stateThe state to consider.
Returns
The likelihood for site site and state state.

Implemented in bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood.

Referenced by bpp::AbstractTreeLikelihood::getLikelihoodForEachSiteForEachState().

virtual Vdouble bpp::TreeLikelihood::getLikelihoodForEachSite ( ) const
pure virtualinherited

Get the likelihood for each site.

Returns
A vector with all likelihoods for each site.

Implemented in bpp::AbstractTreeLikelihood.

Vdouble AbstractTreeLikelihood::getLikelihoodForEachSite ( ) const
virtualinherited

Get the likelihood for each site.

Returns
A vector with all likelihoods for each site.

Implements bpp::TreeLikelihood.

Definition at line 46 of file AbstractTreeLikelihood.cpp.

References bpp::TreeLikelihood::getLikelihoodForASite(), and bpp::AbstractTreeLikelihood::getNumberOfSites().

VVdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getLikelihoodForEachSiteForEachRateClass ( ) const
virtualinherited

Get the likelihood for each site and each rate class.

Returns
A two-dimension vector with all likelihoods.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 93 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

VVVdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getLikelihoodForEachSiteForEachRateClassForEachState ( ) const
virtualinherited

Get the likelihood for each site and each rate class and each state.

Returns
A three-dimension vector with all likelihoods.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 156 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

virtual VVdouble bpp::TreeLikelihood::getLikelihoodForEachSiteForEachState ( ) const
pure virtualinherited

Get the likelihood for each site and for each state.

Returns
A 2d vector with all likelihoods for each site and for each state.

Implemented in bpp::AbstractTreeLikelihood.

VVdouble AbstractTreeLikelihood::getLikelihoodForEachSiteForEachState ( ) const
virtualinherited

Get the likelihood for each site and for each state.

Returns
A 2d vector with all likelihoods for each site and for each state.

Implements bpp::TreeLikelihood.

Definition at line 64 of file AbstractTreeLikelihood.cpp.

References bpp::TreeLikelihood::getLikelihoodForASiteForAState(), bpp::AbstractTreeLikelihood::getNumberOfSites(), and bpp::TreeLikelihood::getNumberOfStates().

double DRHomogeneousTreeLikelihood::getLogLikelihood ( ) const
virtual

Get the logarithm of the likelihood for the whole dataset.

Returns
The logarithm of the likelihood of the dataset.

Implements bpp::TreeLikelihood.

Definition at line 172 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::DRASDRTreeLikelihoodData::getRootRateSiteLikelihoodArray(), bpp::AbstractTreeLikelihoodData::getWeights(), likelihoodData_, and bpp::AbstractHomogeneousTreeLikelihood::nbDistinctSites_.

Referenced by fireParameterChanged().

double DRHomogeneousTreeLikelihood::getLogLikelihoodForASite ( size_t  site) const
virtual

Get the logarithm of the likelihood for a site.

Parameters
siteThe site index to analyse.
Returns
The logarithm of the likelihood for site site.

Implements bpp::TreeLikelihood.

Definition at line 199 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), bpp::DRASDRTreeLikelihoodData::getRootRateSiteLikelihoodArray(), and likelihoodData_.

double DRHomogeneousTreeLikelihood::getLogLikelihoodForASiteForARateClass ( size_t  site,
size_t  rateClass 
) const
virtual

Get the logarithm of the likelihood for a site knowing its rate class.

Parameters
siteThe site index.
rateClassThe rate class index.
Returns
The logarithm of the likelihood for the specified site and rate class.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 212 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), bpp::DRASDRTreeLikelihoodData::getRootSiteLikelihoodArray(), and likelihoodData_.

double DRHomogeneousTreeLikelihood::getLogLikelihoodForASiteForARateClassForAState ( size_t  site,
size_t  rateClass,
int  state 
) const
virtual

Get the logarithm of the likelihood for a site knowing its rate class and its ancestral state.

Parameters
siteThe site index.
rateClassThe rate class index.
stateThe ancestral state.
Returns
The logarithm of the likelihood for the specified site and rate class and ancestral state..

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 226 of file DRHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), bpp::DRASDRTreeLikelihoodData::getRootLikelihoodArray(), and likelihoodData_.

double AbstractDiscreteRatesAcrossSitesTreeLikelihood::getLogLikelihoodForASiteForAState ( size_t  site,
int  state 
) const
virtualinherited

Get the logarithm of the likelihood for a site and for a state.

Parameters
siteThe site index to analyse.
stateThe state to consider.
Returns
The logarithm of the likelihood for site site and state state.

Implements bpp::TreeLikelihood.

Definition at line 124 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

virtual double bpp::TreeLikelihood::getLogLikelihoodForASiteForAState ( size_t  site,
int  state 
) const
pure virtualinherited

Get the logarithm of the likelihood for a site and for a state.

Parameters
siteThe site index to analyse.
stateThe state to consider.
Returns
The logarithm of the likelihood for site site and state state.

Implemented in bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood.

Referenced by bpp::AbstractTreeLikelihood::getLogLikelihoodForEachSiteForEachState().

virtual Vdouble bpp::TreeLikelihood::getLogLikelihoodForEachSite ( ) const
pure virtualinherited

Get the logarithm of the likelihood for each site.

Returns
A vector with all log likelihoods for each site.

Implemented in bpp::AbstractTreeLikelihood.

Vdouble AbstractTreeLikelihood::getLogLikelihoodForEachSite ( ) const
virtualinherited

Get the logarithm of the likelihood for each site.

Returns
A vector with all log likelihoods for each site.

Implements bpp::TreeLikelihood.

Definition at line 55 of file AbstractTreeLikelihood.cpp.

References bpp::TreeLikelihood::getLogLikelihoodForASite(), and bpp::AbstractTreeLikelihood::getNumberOfSites().

VVdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getLogLikelihoodForEachSiteForEachRateClass ( ) const
virtualinherited

Get the logarithm of the likelihood for each site and each rate class.

Returns
A two-dimension vector with all log likelihoods: V[i][j] = likelihood of site i and rate class j.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 138 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

VVVdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getLogLikelihoodForEachSiteForEachRateClassForEachState ( ) const
virtualinherited

Get the logarithm of the likelihood for each site and each rate class and each state.

Returns
A three-dimension vector with all log likelihoods: V[i][j][k} = likelihood of site i and rate class j and state k.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 179 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

virtual VVdouble bpp::TreeLikelihood::getLogLikelihoodForEachSiteForEachState ( ) const
pure virtualinherited

Get the logarithm of the likelihood for each site and for each state.

Returns
A 2d vector with all log likelihoods for each site and for each state.

Implemented in bpp::AbstractTreeLikelihood.

VVdouble AbstractTreeLikelihood::getLogLikelihoodForEachSiteForEachState ( ) const
virtualinherited

Get the logarithm of the likelihood for each site and for each state.

Returns
A 2d vector with all log likelihoods for each site and for each state.

Implements bpp::TreeLikelihood.

Definition at line 81 of file AbstractTreeLikelihood.cpp.

References bpp::TreeLikelihood::getLogLikelihoodForASiteForAState(), bpp::AbstractTreeLikelihood::getNumberOfSites(), and bpp::TreeLikelihood::getNumberOfStates().

virtual double bpp::AbstractHomogeneousTreeLikelihood::getMaximumBranchLength ( ) const
inlinevirtualinherited
virtual double bpp::AbstractHomogeneousTreeLikelihood::getMinimumBranchLength ( ) const
inlinevirtualinherited
ConstBranchModelIterator* bpp::AbstractHomogeneousTreeLikelihood::getNewBranchModelIterator ( int  nodeId) const
inlinevirtualinherited
ConstSiteModelIterator* bpp::AbstractHomogeneousTreeLikelihood::getNewSiteModelIterator ( size_t  siteIndex) const
inlinevirtualinherited
ParameterList AbstractDiscreteRatesAcrossSitesTreeLikelihood::getNonDerivableParameters ( ) const
virtualinherited

All non derivable parameters.

Usually, this contains all substitution model parameters and rate distribution.

Returns
A ParameterList.

Implements bpp::TreeLikelihood.

Reimplemented in bpp::RHomogeneousClockTreeLikelihood.

Definition at line 82 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

References bpp::ParameterList::addParameters().

virtual ParameterList bpp::TreeLikelihood::getNonDerivableParameters ( ) const
pure virtualinherited

All non derivable parameters.

Usually, this contains all substitution model parameters and rate distribution.

Returns
A ParameterList.

Implemented in bpp::RHomogeneousClockTreeLikelihood, and bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood.

size_t bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::getNumberOfClasses ( ) const
inlinevirtualinherited
size_t bpp::AbstractTreeLikelihood::getNumberOfSites ( ) const
inlinevirtualinherited
virtual size_t bpp::TreeLikelihood::getNumberOfSites ( ) const
pure virtualinherited

Get the number of sites in the dataset.

Returns
the number of sites in the dataset.

Implemented in bpp::AbstractTreeLikelihood.

Referenced by bpp::SubstitutionMappingTools::getNormalizationsPerBranch().

size_t bpp::AbstractHomogeneousTreeLikelihood::getNumberOfStates ( ) const
inlinevirtualinherited
Returns
the number of model states of the underlying Markov chain.

Implements bpp::TreeLikelihood.

Definition at line 165 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::SubstitutionModel::getNumberOfStates(), and bpp::AbstractHomogeneousTreeLikelihood::model_.

VVdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getPosteriorProbabilitiesOfEachRate ( ) const
virtualinherited

Get the posterior probability for each site of belonging to a particular rate class.

Returns
A two-dimension vector with all posterior probabilities: V[i][j] = probablity for site i of belonging to rate class j.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 202 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

Vdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getPosteriorRateOfEachSite ( ) const
virtualinherited

Get the posterior rate, i.e. averaged over all classes and weighted with posterior probabilities, for each site.

Returns
A vector with all rates.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 220 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

vector< size_t > AbstractDiscreteRatesAcrossSitesTreeLikelihood::getRateClassWithMaxPostProbOfEachSite ( ) const
virtualinherited

Get the posterior rate class (the one with maximum posterior probability) for each site.

Returns
A vector with all rate classes indexes.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 239 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

const DiscreteDistribution* bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::getRateDistribution ( ) const
inlinevirtualinherited

Get the rate distribution used for the computation.

Returns
A const pointer toward the rate distribution of this instance.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 106 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.h.

References bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::rateDistribution_.

DiscreteDistribution* bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::getRateDistribution ( )
inlinevirtualinherited

Get the rate distribution used for the computation.

Returns
A pointer toward the rate distribution of this instance.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 107 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.h.

References bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::rateDistribution_.

ParameterList bpp::AbstractHomogeneousTreeLikelihood::getRateDistributionParameters ( ) const
inlinevirtualinherited

Get the parameters associated to the rate distirbution.

Returns
A ParameterList object with all rate distribution parameters.

Reimplemented from bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 179 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::getRateDistributionParameters().

Vdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getRateWithMaxPostProbOfEachSite ( ) const
virtualinherited

Get the posterior rate (the one with maximum posterior probability) for each site.

Returns
A vector with all rate classes indexes.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 253 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

const std::vector<double>& bpp::AbstractHomogeneousTreeLikelihood::getRootFrequencies ( size_t  siteIndex) const
inlinevirtualinherited

Get the values of the frequencies for each state in the alphabet at the root node.

For reversible models, these are the equilibrium frequencies. For non-reversible models, these usually are distinct parameters.

For models without site partitioning, the set of frequencies is the same for all positions. For partition models, the frequencies may differ from one site to another.

Parameters
siteIndexThe index of the alignment position.
See Also
getSiteIndex
Returns
A vector with ancestral frequencies for each state in the alphabet;

Implements bpp::TreeLikelihood.

Definition at line 184 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::SubstitutionModel::getFrequencies(), and bpp::AbstractHomogeneousTreeLikelihood::model_.

double DRHomogeneousTreeLikelihood::getSecondOrderDerivative ( const std::string &  variable) const
throw (Exception
)
virtual

Implements bpp::DerivableSecondOrder.

Definition at line 430 of file DRHomogeneousTreeLikelihood.cpp.

double bpp::DRHomogeneousTreeLikelihood::getSecondOrderDerivative ( const std::string &  variable1,
const std::string &  variable2 
) const
throw (Exception
)
inlinevirtual

Implements bpp::DerivableSecondOrder.

Definition at line 201 of file DRHomogeneousTreeLikelihood.h.

size_t bpp::DRHomogeneousTreeLikelihood::getSiteIndex ( size_t  site) const
throw (IndexOutOfBoundsException
)
inlinevirtual

Get the index (used for inner computations) of a given site (original alignment column).

Parameters
siteAn alignment position.
Returns
The site index corresponding to the given input alignment position.

Implements bpp::TreeLikelihood.

Definition at line 152 of file DRHomogeneousTreeLikelihood.h.

References bpp::AbstractTreeLikelihoodData::getRootArrayPosition(), and likelihoodData_.

const SubstitutionModel* bpp::AbstractHomogeneousTreeLikelihood::getSubstitutionModel ( ) const
inlinevirtualinherited
Returns
The substitution model attached to this instance.

Implements bpp::HomogeneousTreeLikelihood.

Definition at line 207 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::AbstractHomogeneousTreeLikelihood::model_.

const SubstitutionModel* bpp::AbstractHomogeneousTreeLikelihood::getSubstitutionModel ( int  nodeId,
size_t  siteIndex 
) const
throw (NodeNotFoundException
)
inlinevirtualinherited

Get the substitution model associated to a given node and alignment column.

Parameters
nodeIdThe id of the request node.
siteIndexThe index of the alignment position.
See Also
getSiteIndex
Returns
A pointer toward the corresponding model.
Exceptions
NodeNotFoundExceptionThis exception may be thrown if the node is not found (depending on the implementation).

Implements bpp::TreeLikelihood.

Definition at line 208 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::AbstractHomogeneousTreeLikelihood::model_.

SubstitutionModel* bpp::AbstractHomogeneousTreeLikelihood::getSubstitutionModel ( )
inlinevirtualinherited
Returns
The substitution model attached to this instance.

Implements bpp::HomogeneousTreeLikelihood.

Definition at line 210 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::AbstractHomogeneousTreeLikelihood::model_.

SubstitutionModel* bpp::AbstractHomogeneousTreeLikelihood::getSubstitutionModel ( int  nodeId,
size_t  siteIndex 
)
throw (NodeNotFoundException
)
inlinevirtualinherited

Get the substitution model associated to a given node and alignment column.

Parameters
nodeIdThe id of the request node.
siteIndexThe index of the alignment position.
See Also
getSiteIndex
Returns
A pointer toward the corresponding model.
Exceptions
NodeNotFoundExceptionThis exception may be thrown if the node is not found (depending on the implementation).

Implements bpp::TreeLikelihood.

Definition at line 211 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::AbstractHomogeneousTreeLikelihood::model_.

ParameterList AbstractHomogeneousTreeLikelihood::getSubstitutionModelParameters ( ) const
virtualinherited

Get the parameters associated to substitution model(s).

Returns
A ParameterList.

Implements bpp::TreeLikelihood.

Definition at line 259 of file AbstractHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihood::initialized_, and bpp::AbstractHomogeneousTreeLikelihood::model_.

VVdouble AbstractDiscreteRatesAcrossSitesTreeLikelihood::getTransitionProbabilities ( int  nodeId,
size_t  siteIndex 
) const
virtualinherited

Retrieves all Pij(t) for a particular branch, defined by the upper node and site.

These intermediate results may be used by other methods.

Parameters
nodeIdThe node defining the branch of interest.
siteIndexThe index of the alignment position.
See Also
getSiteIndex
Returns
An array of dimension 2, where a[x][y] is the probability of substituting from x to y.

Implements bpp::TreeLikelihood.

Definition at line 311 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.cpp.

virtual VVdouble bpp::TreeLikelihood::getTransitionProbabilities ( int  nodeId,
size_t  siteIndex 
) const
pure virtualinherited

Retrieves all Pij(t) for a particular branch, defined by the upper node and site.

These intermediate results may be used by other methods.

Parameters
nodeIdThe node defining the branch of interest.
siteIndexThe index of the alignment position.
See Also
getSiteIndex
Returns
An array of dimension 2, where a[x][y] is the probability of substituting from x to y.

Implemented in bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood.

VVVdouble bpp::AbstractHomogeneousTreeLikelihood::getTransitionProbabilitiesPerRateClass ( int  nodeId,
size_t  siteIndex 
) const
inlinevirtualinherited

Retrieves all Pij(t) for a particular branch, defined by the upper node.

These intermediate results may be used by other methods.

Parameters
nodeIdThe node defining the branch of interest.
siteIndexThe position in the alignment.
Returns
An array of dimension 3, where a[c][x][y] is the probability of substituting from x to y while being in rate class c.

Implements bpp::DiscreteRatesAcrossSitesTreeLikelihood.

Definition at line 186 of file AbstractHomogeneousTreeLikelihood.h.

References bpp::AbstractHomogeneousTreeLikelihood::pxy_.

const Tree& bpp::AbstractTreeLikelihood::getTree ( ) const
inlinevirtualinherited

Get the tree (topology and branch lengths).

Returns
The tree of this TreeLikelihood object.

Implements bpp::TreeLikelihood.

Definition at line 291 of file AbstractTreeLikelihood.h.

References bpp::AbstractTreeLikelihood::tree_.

Referenced by bpp::NNIHomogeneousTreeLikelihood::getTopology(), and bpp::RNonHomogeneousMixedTreeLikelihood::init().

double DRHomogeneousTreeLikelihood::getValue ( ) const
throw (Exception
)
void DRHomogeneousTreeLikelihood::init_ ( )
throw (Exception
)
private

Method called by constructors.

Definition at line 94 of file DRHomogeneousTreeLikelihood.cpp.

void AbstractHomogeneousTreeLikelihood::initialize ( )
throw (Exception
)
virtualinherited

Init the likelihood object.

This method is used to initialize all parameters. It is typically called after the constructor and the setData method. It contains virtual methods that can't be called in the constructor.

Exceptions
Exceptionif something bad happened, for instance if no data are associated to the likelihood function.

Implements bpp::TreeLikelihood.

Reimplemented in bpp::DRHomogeneousMixedTreeLikelihood, and bpp::RHomogeneousMixedTreeLikelihood.

Definition at line 237 of file AbstractHomogeneousTreeLikelihood.cpp.

References bpp::AbstractTreeLikelihood::data_, bpp::AbstractParametrizable::fireParameterChanged(), bpp::AbstractTreeLikelihood::initialized_, and bpp::AbstractHomogeneousTreeLikelihood::initParameters().

Referenced by bpp::OptimizationTools::buildDistanceTree(), bpp::RHomogeneousMixedTreeLikelihood::initialize(), and bpp::DRHomogeneousMixedTreeLikelihood::initialize().

virtual bool bpp::TreeLikelihood::isInitialized ( ) const
pure virtualinherited
Returns
'true' is the likelihood function has been initialized.

Implemented in bpp::AbstractTreeLikelihood.

bool bpp::AbstractTreeLikelihood::isInitialized ( ) const
inlinevirtualinherited
void DRHomogeneousTreeLikelihood::setData ( const SiteContainer sites)
throw (Exception
)
virtual
void DRHomogeneousTreeLikelihood::setParameters ( const ParameterList parameters)
throw (ParameterNotFoundException,
ConstraintException
)
virtual

Implements the Function interface.

Update the parameter list and call the fireParameterChanged() method.

If a subset of the whole parameter list is passed to the function, only these parameters are updated and the other remain constant (i.e. equal to their last value).

Parameters
parametersThe parameter list to pass to the function.

Implements bpp::Function.

Definition at line 233 of file DRHomogeneousTreeLikelihood.cpp.

void AbstractHomogeneousTreeLikelihood::setSubstitutionModel ( SubstitutionModel model)
throw (Exception
)
virtualinherited
Returns
Set the substitution model for this instance.
Exceptions
ExceptionIf the model could not be set (for instance, because of a wrong alphabet type).

Implements bpp::HomogeneousTreeLikelihood.

Definition at line 172 of file AbstractHomogeneousTreeLikelihood.cpp.

References bpp::Node::getId().

Friends And Related Function Documentation

friend class DRHomogeneousMixedTreeLikelihood
friend

Definition at line 306 of file DRHomogeneousTreeLikelihood.h.

Member Data Documentation

double bpp::DRHomogeneousTreeLikelihood::minusLogLik_
protected
DiscreteDistribution* bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::rateDistribution_
protectedinherited

Definition at line 61 of file AbstractDiscreteRatesAcrossSitesTreeLikelihood.h.

Referenced by bpp::AbstractHomogeneousTreeLikelihood::applyParameters(), bpp::AbstractNonHomogeneousTreeLikelihood::applyParameters(), bpp::TwoTreeLikelihood::applyParameters(), computeRootLikelihood(), bpp::DRNonHomogeneousTreeLikelihood::computeRootLikelihood(), bpp::AbstractHomogeneousTreeLikelihood::computeTransitionProbabilitiesForNode(), bpp::RNonHomogeneousMixedTreeLikelihood::computeTransitionProbabilitiesForNode(), bpp::AbstractNonHomogeneousTreeLikelihood::computeTransitionProbabilitiesForNode(), bpp::TwoTreeLikelihood::computeTreeD2Likelihood(), computeTreeD2LikelihoodAtNode(), bpp::DRNonHomogeneousTreeLikelihood::computeTreeD2LikelihoodAtNode(), bpp::TwoTreeLikelihood::computeTreeDLikelihood(), computeTreeDLikelihoodAtNode(), bpp::DRNonHomogeneousTreeLikelihood::computeTreeDLikelihoodAtNode(), bpp::TwoTreeLikelihood::computeTreeLikelihood(), fireParameterChanged(), bpp::DRNonHomogeneousTreeLikelihood::fireParameterChanged(), bpp::RHomogeneousTreeLikelihood::fireParameterChanged(), bpp::RNonHomogeneousTreeLikelihood::fireParameterChanged(), bpp::TwoTreeLikelihood::fireParameterChanged(), bpp::RNonHomogeneousMixedTreeLikelihood::fireParameterChanged(), bpp::RNonHomogeneousTreeLikelihood::getD2LikelihoodForASite(), bpp::RHomogeneousTreeLikelihood::getD2LikelihoodForASite(), bpp::RNonHomogeneousTreeLikelihood::getDLikelihoodForASite(), bpp::RHomogeneousTreeLikelihood::getDLikelihoodForASite(), bpp::RHomogeneousTreeLikelihood::getLikelihoodForASite(), bpp::RNonHomogeneousTreeLikelihood::getLikelihoodForASite(), bpp::RHomogeneousTreeLikelihood::getLogLikelihoodForASite(), bpp::RNonHomogeneousTreeLikelihood::getLogLikelihoodForASite(), bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::getNumberOfClasses(), bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::getRateDistribution(), bpp::RNonHomogeneousMixedTreeLikelihood::init(), bpp::AbstractHomogeneousTreeLikelihood::initParameters(), bpp::AbstractNonHomogeneousTreeLikelihood::initParameters(), bpp::TwoTreeLikelihood::initParameters(), and bpp::AbstractDiscreteRatesAcrossSitesTreeLikelihood::operator=().

TreeTemplate<Node>* bpp::AbstractTreeLikelihood::tree_
mutableprotectedinherited

Definition at line 226 of file AbstractTreeLikelihood.h.

Referenced by bpp::AbstractHomogeneousTreeLikelihood::AbstractHomogeneousTreeLikelihood(), bpp::AbstractNonHomogeneousTreeLikelihood::AbstractNonHomogeneousTreeLikelihood(), bpp::AbstractTreeLikelihood::AbstractTreeLikelihood(), computeLikelihoodAtNode(), bpp::DRNonHomogeneousTreeLikelihood::computeLikelihoodAtNode(), computeRootLikelihood(), bpp::DRNonHomogeneousTreeLikelihood::computeRootLikelihood(), bpp::RNonHomogeneousTreeLikelihood::computeTreeD2Likelihood(), bpp::RNonHomogeneousMixedTreeLikelihood::computeTreeD2Likelihood(), bpp::RNonHomogeneousTreeLikelihood::computeTreeDLikelihood(), bpp::RNonHomogeneousMixedTreeLikelihood::computeTreeDLikelihood(), computeTreeLikelihood(), bpp::DRNonHomogeneousTreeLikelihood::computeTreeLikelihood(), bpp::RNonHomogeneousTreeLikelihood::computeTreeLikelihood(), bpp::RHomogeneousTreeLikelihood::computeTreeLikelihood(), DRHomogeneousTreeLikelihood(), bpp::DRNonHomogeneousTreeLikelihood::DRNonHomogeneousTreeLikelihood(), bpp::DRNonHomogeneousTreeLikelihood::fireParameterChanged(), bpp::RNonHomogeneousTreeLikelihood::fireParameterChanged(), bpp::RNonHomogeneousMixedTreeLikelihood::fireParameterChanged(), bpp::RNonHomogeneousTreeLikelihood::getD2LikelihoodForASiteForARateClass(), bpp::RHomogeneousTreeLikelihood::getD2LikelihoodForASiteForARateClass(), bpp::RNonHomogeneousTreeLikelihood::getDLikelihoodForASiteForARateClass(), bpp::RHomogeneousTreeLikelihood::getDLikelihoodForASiteForARateClass(), bpp::RHomogeneousTreeLikelihood::getLikelihoodForASiteForARateClass(), bpp::RNonHomogeneousTreeLikelihood::getLikelihoodForASiteForARateClass(), bpp::RHomogeneousTreeLikelihood::getLikelihoodForASiteForARateClassForAState(), bpp::RNonHomogeneousTreeLikelihood::getLikelihoodForASiteForARateClassForAState(), bpp::RHomogeneousTreeLikelihood::getLogLikelihoodForASiteForARateClass(), bpp::RNonHomogeneousTreeLikelihood::getLogLikelihoodForASiteForARateClass(), bpp::RHomogeneousTreeLikelihood::getLogLikelihoodForASiteForARateClassForAState(), bpp::RNonHomogeneousTreeLikelihood::getLogLikelihoodForASiteForARateClassForAState(), bpp::AbstractHomogeneousTreeLikelihood::getNewSiteModelIterator(), bpp::AbstractTreeLikelihood::getTree(), operator=(), bpp::DRNonHomogeneousTreeLikelihood::operator=(), bpp::AbstractHomogeneousTreeLikelihood::operator=(), bpp::RHomogeneousTreeLikelihood::operator=(), bpp::RNonHomogeneousTreeLikelihood::operator=(), bpp::AbstractNonHomogeneousTreeLikelihood::operator=(), bpp::AbstractTreeLikelihood::operator=(), bpp::RHomogeneousTreeLikelihood::RHomogeneousTreeLikelihood(), bpp::RNonHomogeneousTreeLikelihood::RNonHomogeneousTreeLikelihood(), and bpp::AbstractTreeLikelihood::~AbstractTreeLikelihood().

bool bpp::AbstractHomogeneousTreeLikelihood::verbose_
protectedinherited

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