/usr/include/Bpp/Phyl/Model/Nucleotide/F84.h is in libbpp-phyl-dev 2.1.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 216 217 218 219 220 221 222 223 224 225 226 227 | //
// File: F84.h
// Created by: Julien Dutheil
// Created on: Tue May 23 11:13 2005
//
/*
Copyright or © or Copr. CNRS, (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 _F84_H_
#define _F84_H_
#include "NucleotideSubstitutionModel.h"
#include "../AbstractSubstitutionModel.h"
#include <Bpp/Numeric/Constraints.h>
// From SeqLib:
#include <Bpp/Seq/Alphabet/NucleicAlphabet.h>
namespace bpp
{
/**
* @brief The Felsenstein (1984) substitution model for nucleotides.
*
* This model is similar to the HKY85 model, with a different parametrization.
* \f[
* S = \begin{pmatrix}
* \cdots & r & \left(1 + \kappa/\pi_R\right) r & r \\
* r & \cdots & r & \left(1 + \kappa/\pi_Y\right) r \\
* \left(1 + \kappa/\pi_R\right) r & r & \cdots & r \\
* r & \left(1 + \kappa/\pi_Y\right) r & r & \cdots \\
* \end{pmatrix}
* \f]
* with \f$\pi_R = \pi_A + \pi_G\f$ and \f$\pi_Y = \pi_C + \pi_T\f$.
* \f[
* \pi = \left(\pi_A, \pi_C, \pi_G, \pi_T\right)
* \f]
* This models includes five parameters, the transition / transversion
* relative rate \f$\kappa\f$ and four frequencies \f$\pi_A, \pi_C, \pi_G, \pi_T\f$.
* These four frequencies are not independent parameters, since they have the constraint to
* sum to 1.
* We use instead a different parametrization to remove this constraint:
* \f[
* \begin{cases}
* \theta = \pi_C + \pi_G\\
* \theta_1 = \frac{\pi_A}{1 - \theta} = \frac{\pi_A}{\pi_A + \pi_T}\\
* \theta_2 = \frac{\pi_G}{\theta} = \frac{\pi_G}{\pi_C + \pi_G}\\
* \end{cases}
* \Longleftrightarrow
* \begin{cases}
* \pi_A = \theta_1 (1 - \theta)\\
* \pi_C = (1 - \theta_2) \theta\\
* \pi_G = \theta_2 \theta\\
* \pi_T = (1 - \theta_1)(1 - \theta).
* \end{cases}
* \f]
* These parameters can also be measured from the data and not optimized.
*
* Normalization: \f$r\f$ is set so that \f$\sum_i Q_{i,i}\pi_i = -1\f$:
* \f[
* S = \frac{1}{P}\begin{pmatrix}
* \frac{-\pi_T-\left(1 + \kappa/\pi_R\right)\pi_G-\pi_C}{\pi_A} & 1 & \left(1 + \kappa/\pi_R\right) & 1 \\
* 1 & \frac{-\left(1 + \kappa/\pi_Y\right)\pi_T-\pi_G-\pi_A}{\pi_C} & 1 & \left(1 + \kappa/\pi_Y\right) \\
* \left(1 + \kappa/\pi_R\right) & 1 & \frac{-\pi_T-\pi_C-\left(1 + \kappa/\pi_R\right)\pi_A}{\pi_G} & 1 \\
* 1 & \left(1 + \kappa/\pi_Y\right) & 1 & \frac{-\pi_G-\left(1 + \kappa/\pi_Y\right)\pi_C-\pi_A}{\pi_T} \\
* \end{pmatrix}
* \f]
* with \f$P=2k\left({frac{piC.piT}{piT+piC}}+{\frac{piA.piG}{piG+piA}}\right)-piT^2-piG^2-piC^2-piA^2+1\f$.
*
* The normalized generator is obtained by taking the dot product of \f$S\f$ and \f$\pi\f$:
* \f[
* Q = S . \pi = \frac{1}{P}\begin{pmatrix}
* -\pi_T-\left(1 + \kappa/\pi_R\right)\pi_G-\pi_C & \pi_C & \left(1 + \kappa/\pi_R\right)\pi_G & \pi_T \\
* \pi_A & -\left(1 + \kappa/\pi_Y\right)\pi_T-\pi_G-\pi_A & \pi_G & \left(1 + \kappa/\pi_Y\right)\pi_T \\
* \left(1 + \kappa/\pi_R\right)\pi_A & \pi_C & -\pi_T-\pi_C-\left(1 + \kappa/\pi_R\right)\pi_A & \pi_T \\
* \pi_A & \left(1 + \kappa/\pi_Y\right)\pi_C & \pi_G & -\pi_G-\left(1 + \kappa/\pi_Y\right)\pi_C-\pi_A \\
* \end{pmatrix}
* \f]
*
* The eigen values are \f$\left(0, -\frac{-1-k}{P}, -\frac{-1-k}{P}, \frac{-1}{P}\right)\f$,
* The left eigen vectors are, by row:
* \f[
* U = \begin{pmatrix}
* \pi_A & \pi_C & \pi_G & \pi_T \\
* 0 & \frac{\pi_T}{\pi_Y} & 0 & -\frac{\pi_T}{\pi_Y} \\
* \frac{\pi_G}{\pi_R} & 0 & -\frac{\pi_G}{\pi_R} & 0 \\
* \frac{\pi_A\pi_Y}{\pi_R} & -\pi_C & \frac{\pi_G\pi_Y}{\pi_R} & -\pi_T \\
* \end{pmatrix}
* \f]
* and the right eigen vectors are, by column:
* \f[
* U^-1 = \begin{pmatrix}
* 1 & 0 & 1 & 1 \\
* 1 & 1 & 0 & -\frac{\pi_R}{\pi_Y} \\
* 1 & 0 & \frac{\pi_A}{\pi_G} & 1 \\
* 1 & -\frac{\pi_C}{\pi_T} & 0 & -\frac{\pi_R}{\pi_Y} \\
* \end{pmatrix}
* \f]
*
* In addition, a rate_ factor defines the mean rate of the model.
*
* The probabilities of changes are computed analytically using the formulas:
* \f{multline*}
* P_{i,j}(t) = \\
* \begin{pmatrix}
* \frac{\pi_G}{\pi_R}A + \frac{\pi_A\pi_Y}{\pi_R}B + \pi_A & \pi_C - \pi_CB & -\frac{\pi_G}{\pi_R}A + \frac{\pi_G\pi_Y}{\pi_R}B + \pi_G & \pi_T - \pi_TB \\
* \pi_A - \pi_AB & \frac{\pi_T}{\pi_Y}A + \frac{\pi_C\pi_R}{\pi_Y}B + \pi_C & \pi_G - \pi_GB & -\frac{\pi_T}{\pi_Y}A + \frac{\pi_T\pi_R}{\pi_Y}B + \pi_T \\
* -\frac{\pi_A}{\pi_R}A + \frac{\pi_A\pi_Y}{\pi_R}B + \pi_A & \pi_C - \pi_CB & \frac{\pi_A}{\pi_R}A + \frac{\pi_G\pi_Y}{\pi_R}B + \pi_G & \pi_T - \pi_TB \\
* \pi_A - \pi_AB & -\frac{\pi_C}{\pi_Y}A + \frac{\pi_C\pi_R}{\pi_Y}B + \pi_C & \pi_G - \pi_GB & \frac{\pi_C}{\pi_Y}A + \frac{\pi_R\pi_T}{\pi_Y}B + \pi_T \\
* \end{pmatrix}
* \f}
* with \f$A=e^{-\frac{rate\_*(-1-\kappa)t}{P}}\f$ and \f$B = e^{-\frac{rate\_*t}{P}}\f$.
*
* First and second order derivatives are also computed analytically using the formulas:
* \f{multline*}
* \frac{\partial P_{i,j}(t)}{\partial t} = rate\_ * \\
* \frac{1}{P}
* \begin{pmatrix}
* -\frac{\pi_G((-1-\kappa))}{\pi_R}A - \frac{\pi_A\pi_Y}{\pi_R}B & \pi_CB & \frac{\pi_G((-1-\kappa))}{\pi_R}A - \frac{\pi_G\pi_Y}{\pi_R}B & \pi_TB \\
* \pi_AB & -\frac{\pi_T((-1-\kappa))}{\pi_Y}A - \frac{\pi_C\pi_R}{\pi_Y}B & \pi_GB & \frac{\pi_T((-1-\kappa))}{\pi_Y}A - \frac{\pi_T\pi_R}{\pi_Y}B \\
* \frac{\pi_A((-1-\kappa))}{\pi_R}A - \frac{\pi_A\pi_Y}{\pi_R}B & \pi_CB & -\frac{\pi_A((-1-\kappa))}{\pi_R}A - \frac{\pi_G\pi_Y}{\pi_R}B & \pi_TB \\
* \pi_AB & \frac{\pi_C((-1-\kappa))}{\pi_Y}A - \frac{\pi_C\pi_R}{\pi_Y}B & \pi_GB & -\frac{\pi_C((-1-\kappa))}{\pi_Y}A - \frac{\pi_R\pi_T}{\pi_Y}B \\
* \end{pmatrix}
* \f}
* \f{multline*}
* \frac{\partial^2 P_{i,j}(t)}{\partial t^2} = rate\_^2 * \\
* \frac{1}{P^2}
* \begin{pmatrix}
* \frac{\pi_G{((-1-\kappa))}^2}{\pi_R}A + \frac{\pi_A\pi_Y}{\pi_R}B & -\pi_CB & -\frac{\pi_G{((-1-\kappa))}^2}{\pi_R}A + \frac{\pi_G\pi_Y}{\pi_R}B & -\pi_TB \\
* -\pi_AB & \frac{\pi_T{((-1-\kappa))}^2}{\pi_Y}A + \frac{\pi_C\pi_R}{\pi_Y}B & -\pi_GB & -\frac{\pi_T{((-1-\kappa))}^2}{\pi_Y}A + \frac{\pi_T\pi_R}{\pi_Y}B \\
* -\frac{\pi_A{((-1-\kappa))}^2}{\pi_R}A + \frac{\pi_A\pi_Y}{\pi_R}B & -\pi_CB & \frac{\pi_A{((-1-\kappa))}^2}{\pi_R}A + \frac{\pi_G\pi_Y}{\pi_R}B & -\pi_TB \\
* -\pi_AB & -\frac{\pi_C{((-1-\kappa))}^2}{\pi_Y}A + \frac{\pi_C\pi_R}{\pi_Y}B & -\pi_GB & \frac{\pi_C{((-1-\kappa))}^2}{\pi_Y}A + \frac{\pi_R\pi_T}{\pi_Y}B \\
* \end{pmatrix}
* \f}
*
* The parameters are named \c "kappa", \c "theta", \c "theta1" and \c "theta2"
* and their values may be retrieve with the command
* \code
* getParameterValue("kappa")
* \endcode
* for instance.
*
* Reference:
* - Felsenstein (1984), Phylip version 2.6.
*/
class F84:
public virtual NucleotideSubstitutionModel,
public AbstractReversibleSubstitutionModel
{
private:
double kappa_, piA_, piC_, piG_, piT_, piY_, piR_, r_, k1_, k2_, theta_, theta1_, theta2_;
mutable double l_, exp1_, exp2_;
mutable RowMatrix<double> p_;
public:
F84(
const NucleicAlphabet * alpha,
double kappa = 1.,
double piA = 0.25,
double piC = 0.25,
double piG = 0.25,
double piT = 0.25);
virtual ~F84() {}
#ifndef NO_VIRTUAL_COV
F84*
#else
Clonable*
#endif
clone() const { return new F84(*this); }
public:
double Pij_t (int i, int j, double d) const;
double dPij_dt (int i, int j, double d) const;
double d2Pij_dt2(int i, int j, double d) const;
const Matrix<double> & getPij_t (double d) const;
const Matrix<double> & getdPij_dt (double d) const;
const Matrix<double> & getd2Pij_dt2(double d) const;
std::string getName() const { return "F84"; }
/**
* @brief This method is redefined to actualize the corresponding parameters piA, piT, piG and piC too.
*/
void setFreq(std::map<int, double>&);
protected:
void updateMatrices();
};
} //end of namespace bpp.
#endif //_F84_H_
|