/usr/include/Bpp/Phyl/Model/InMixedSubstitutionModel.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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | //
// File: InMixtureSubstitutionModel.h
// Created by: Laurent Gueguen
// Created on: vendredi 22 septembre 2017, à 09h 57
//
/*
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 _IN_MIXED_SUBSTITUTIONMODEL_H_
#define _IN_MIXED_SUBSTITUTIONMODEL_H_
#include "AbstractSubstitutionModel.h"
#include "MixedSubstitutionModel.h"
#include "AbstractWrappedModel.h"
namespace bpp
{
/**
* @brief SubModel taken from a MixedSubstitutionModel, kept in the
* context of the MixedSubstitutionModel (see
* FromMixtureSubstitutionModel for an out of context subModel). So
* "rate" and "scale" are set for the MixedSubstitutionModel.
*
* But method getRate returns the specific rate of the subModel.
*
* It owns the MixedSubstitutionModel.
*
* It has the same parameters as the MixedSubstitutionModel.
*/
class InMixedSubstitutionModel :
public virtual AbstractWrappedSubstitutionModel,
public AbstractParameterAliasable
{
private:
/*
* @brief The MixedOfSubstitutionModels.
*
*/
std::unique_ptr<MixedSubstitutionModel> mixedModel_;
/*
* @brief the number of the submodel
*
*/
size_t subModelNumber_;
/*
* @brief The name of the mixture model (for io purpose).
*/
std::string mixtName_;
public:
InMixedSubstitutionModel(const MixedSubstitutionModel& mixedModel, const std::string& subModelName, const std::string& mixtDesc);
InMixedSubstitutionModel(const MixedSubstitutionModel& mixedModel, size_t subModelNumber, const std::string& mixtDesc);
InMixedSubstitutionModel(const InMixedSubstitutionModel& fmsm);
InMixedSubstitutionModel& operator=(const InMixedSubstitutionModel& fmsm);
InMixedSubstitutionModel* clone() const { return new InMixedSubstitutionModel(*this); }
public:
const MixedSubstitutionModel& getMixedModel() const
{
return *mixedModel_.get();
}
const SubstitutionModel& getSubstitutionModel() const
{
return *mixedModel_->getNModel(subModelNumber_);
}
size_t getSubModelNumber() const
{
return subModelNumber_;
}
bool computeFrequencies() const
{
return getMixedModel().computeFrequencies();
}
/**
* @return Set if equilibrium frequencies should be computed from
* the generator
*/
void computeFrequencies(bool yn)
{
getMixedModel().computeFrequencies(yn);
}
protected:
Vdouble& getFrequencies_()
{
return getMixedModel().getFrequencies_();
}
/*
* @}
*
*/
MixedSubstitutionModel& getMixedModel()
{
return *mixedModel_.get();
}
SubstitutionModel& getSubstitutionModel()
{
return *mixedModel_->getNModel(subModelNumber_);
}
public:
/*
*@ brief Methods to supersede WrappedSubstitutionModel methods.
*
* @{
*/
double freq(size_t i) const { return getModel().freq(i); }
double Pij_t (size_t i, size_t j, double t) const { return getModel().Pij_t(i, j, t); }
double dPij_dt (size_t i, size_t j, double t) const { return getModel().dPij_dt (i, j, t); }
double d2Pij_dt2(size_t i, size_t j, double t) const { return getModel().d2Pij_dt2(i, j, t); }
const Vdouble& getFrequencies() const { return getModel().getFrequencies(); }
const Matrix<double>& getPij_t(double t) const { return getModel().getPij_t(t); }
const Matrix<double>& getdPij_dt(double t) const { return getModel().getdPij_dt(t); }
const Matrix<double>& getd2Pij_dt2(double t) const { return getModel().getd2Pij_dt2(t); }
double getInitValue(size_t i, int state) const
{
return getModel().getInitValue(i,state);
}
void setFreqFromData(const SequenceContainer& data, double pseudoCount = 0)
{
getMixedModel().setFreqFromData(data, pseudoCount);
}
void setFreq(std::map<int, double>& frequencies)
{
getMixedModel().setFreq(frequencies);
}
/*
*@ brief Methods to supersede SubstitutionModel methods.
*
* @{
*/
double Qij(size_t i, size_t j) const { return getSubstitutionModel().Qij(i, j); }
const Matrix<double>& getGenerator() const { return getSubstitutionModel().getGenerator(); }
const Matrix<double>& getExchangeabilityMatrix() const { return getSubstitutionModel().getExchangeabilityMatrix(); }
double Sij(size_t i, size_t j) const { return getSubstitutionModel().Sij(i, j); }
void enableEigenDecomposition(bool yn) { getMixedModel().enableEigenDecomposition(yn); }
bool enableEigenDecomposition() { return getMixedModel().enableEigenDecomposition(); }
bool isDiagonalizable() const { return getSubstitutionModel().isDiagonalizable(); }
bool isNonSingular() const { return getSubstitutionModel().isNonSingular(); }
const Vdouble& getEigenValues() const { return getSubstitutionModel().getEigenValues(); }
const Vdouble& getIEigenValues() const { return getSubstitutionModel().getIEigenValues(); }
const Matrix<double>& getRowLeftEigenVectors() const { return getSubstitutionModel().getRowLeftEigenVectors(); }
const Matrix<double>& getColumnRightEigenVectors() const { return getSubstitutionModel().getColumnRightEigenVectors(); }
/*
* @}
*
*/
bool isScalable() const
{
return getMixedModel().isScalable();
}
void setScalable(bool scalable)
{
getMixedModel().setScalable(scalable);
}
double getScale() const { return getMixedModel().getScale(); }
void setScale(double scale) { getMixedModel().setScale(scale); }
void normalize()
{
getMixedModel().normalize();
}
void setDiagonal()
{
getMixedModel().setDiagonal();
}
double getRate() const
{
return getModel().getRate();
}
void setRate(double rate)
{
return getMixedModel().setRate(rate);
}
void addRateParameter()
{
getMixedModel().addRateParameter();
addParameter_(new Parameter(getNamespace() + "rate", getMixedModel().getRate(), &Parameter::R_PLUS_STAR));
}
/*
* @}
*
*/
/*
*@ brief Methods to supersede AbstractSubstitutionModel methods.
*
* @{
*/
/**
* @brief Tells the model that a parameter value has changed.
*
* This updates the matrices consequently.
*/
void fireParameterChanged(const ParameterList& parameters)
{
getMixedModel().matchParametersValues(parameters);
}
void setNamespace(const std::string& name)
{
AbstractParameterAliasable::setNamespace(name);
getMixedModel().setNamespace(name);
}
/*
* @}
*/
std::string getName() const
{
return mixedModel_->getName();
}
protected:
void updateMatrices()
{
}
};
} // end of namespace bpp.
#endif // _IN_MIXED_SUBSTITUTIONMODEL_H_
|