/usr/include/Bpp/Phyl/Likelihood/DRHomogeneousMixedTreeLikelihood.h is in libbpp-phyl-dev 2.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | //
// File: DRHomogeneousMixedTreeLikelihood.h
// Created by: Laurent Gueguen
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
This software is a computer program whose purpose is to provide classes
for phylogenetic data analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _DRHOMOGENEOUSMIXEDTREELIKELIHOOD_H_
#define _DRHOMOGENEOUSMIXEDTREELIKELIHOOD_H_
#include "DRHomogeneousTreeLikelihood.h"
#include "../Model/SubstitutionModel.h"
#include "../Model/MixedSubstitutionModel.h"
#include <Bpp/Numeric/VectorTools.h>
#include <Bpp/Numeric/Prob/DiscreteDistribution.h>
namespace bpp
{
/**
* @brief A class to compute the average of several
* DRHomogeneousTreeLikelihood defined from a Mixed Substitution
* Model.
*
* In all computations, the average of the likelihoods, probabilities
* are computed.
**/
class DRHomogeneousMixedTreeLikelihood :
public DRHomogeneousTreeLikelihood
{
private:
std::vector<DRHomogeneousTreeLikelihood*> treeLikelihoodsContainer_;
std::vector<double> probas_;
// true if the root Array should be computed (for ancestral
// reconstruction)
bool rootArray_;
public:
/**
* @brief Build a new DRHomogeneousMixedTreeLikelihood object without
* data.
*
* This constructor only initialize the parameters. To compute a
* likelihood, you will need to call the setData() and the
* computeTreeLikelihood() methods.
*
* @param tree The tree to use.
* @param model The mixed substitution model to use.
* @param rDist The rate across sites distribution to use.
* @param checkRooted Tell if we have to check for the tree to be unrooted.
* If true, any rooted tree will be unrooted before likelihood computation.
* @param verbose Should I display some info?
* @param rootArray is true if the array of the likelihoods at the root
* should be computed (useful for ancestral reconstruction).
* @throw Exception in an error occured.
*/
DRHomogeneousMixedTreeLikelihood(
const Tree& tree,
TransitionModel* model,
DiscreteDistribution* rDist,
bool checkRooted = true,
bool verbose = true,
bool rootArray = false);
/**
* @brief Build a new DRHomogeneousMixedTreeLikelihood object with data.
*
* This constructor initializes all parameters, data, and likelihood arrays.
*
* @param tree The tree to use.
* @param data Sequences to use.
* @param model The mixed substitution model to use.
* @param rDist The rate across sites distribution to use.
* @param checkRooted Tell if we have to check for the tree to be unrooted.
* If true, any rooted tree will be unrooted before likelihood computation.
* @param verbose Should I display some info?
* @param rootArray is true if the array of the likelihoods at the root
* should be computed (useful for ancestral reconstruction).
* @throw Exception in an error occured.
*/
DRHomogeneousMixedTreeLikelihood(
const Tree& tree,
const SiteContainer& data,
TransitionModel* model,
DiscreteDistribution* rDist,
bool checkRooted = true,
bool verbose = true,
bool rootArray = false);
DRHomogeneousMixedTreeLikelihood(const DRHomogeneousMixedTreeLikelihood& lik);
DRHomogeneousMixedTreeLikelihood& operator=(const DRHomogeneousMixedTreeLikelihood& lik);
virtual ~DRHomogeneousMixedTreeLikelihood();
DRHomogeneousMixedTreeLikelihood* clone() const { return new DRHomogeneousMixedTreeLikelihood(*this); }
public:
/**
* @name The TreeLikelihood interface.
*
* Other methods are implemented in the DRHomogeneousTreeLikelihood class.
*
* @{
*/
double getLikelihood() const;
double getLogLikelihood() const;
void setData(const SiteContainer& sites);
double getLikelihoodForASite (size_t site) const;
double getLogLikelihoodForASite(size_t site) const;
/** @} */
/**
* @name The DiscreteRatesAcrossSites interface implementation:
*
* @{
*/
double getLikelihoodForASiteForARateClass(size_t site, size_t rateClass) const;
double getLogLikelihoodForASiteForARateClass(size_t site, size_t rateClass) const;
double getLikelihoodForASiteForARateClassForAState(size_t site, size_t rateClass, int state) const;
double getLogLikelihoodForASiteForARateClassForAState(size_t site, size_t rateClass, int state) const;
/** @} */
/**
* @name DerivableFirstOrder interface.
*
* @{
*/
double getFirstOrderDerivative(const std::string& variable) const;
/** @} */
/**
* @name DerivableSecondOrder interface.
*
* @{
*/
double getSecondOrderDerivative(const std::string& variable) const;
double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const { return 0; } // Not implemented for now.
/** @} */
public:
// Specific methods:
void initialize();
void fireParameterChanged(const ParameterList& params);
void computeTreeLikelihood();
virtual void computeTreeDLikelihoods();
protected:
virtual void computeLikelihoodAtNode_(const Node* node, VVVdouble& likelihoodArray, const Node* sonNode = 0) const;
/**
* @brief Compute the likelihood for a subtree defined by the Tree::Node <i>node</i>.
*
* @param node The root of the subtree.
*/
virtual void computeSubtreeLikelihoodPostfix(const Node* node);
virtual void computeSubtreeLikelihoodPrefix(const Node* node);
virtual void computeRootLikelihood();
virtual void computeTreeD2LikelihoodAtNode(const Node*);
virtual void computeTreeD2Likelihoods();
void resetLikelihoodArrays(const Node* node);
/**
* @brief This method is mainly for debugging purpose.
*
* @param node The node at which likelihood values must be displayed.
*/
virtual void displayLikelihood(const Node* node);
};
} // end of namespace bpp.
#endif // _DRHOMOGENEOUSMIXEDTREELIKELIHOOD_H_
|