/usr/include/Bpp/Phyl/Model/RegisterRatesSubstitutionModel.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 | //
// File: RegisterRatesSubstitutionModel.h
// Created by: Laurent Gueguen
// Created on: lundi 16 octobre 2017, à 16h 38
//
/*
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 _REGISTER_RATES_TRANSITION_MODEL_H_
#define _REGISTER_RATES_TRANSITION_MODEL_H_
#include <Bpp/Numeric/AbstractParameterAliasable.h>
#include "AbstractWrappedModel.h"
#include "AnonymousSubstitutionModel.h"
#include "AbstractSubstitutionModel.h"
#include "../Mapping/SubstitutionRegister.h"
namespace bpp
{
/**
* @brief From a model, substitution rates are set into categories
* following a given register. Each substitution of a category is then
* multiplied by a rate parameter specific to this category.
*
* It has the same parameters as the SubModel.
*
* @see SubstitutionRegister
*/
class RegisterRatesSubstitutionModel :
virtual public AbstractWrappedSubstitutionModel,
virtual public AbstractSubstitutionModel
{
private:
/*
* @brief The related model.
*
*/
std::unique_ptr<SubstitutionModel> originalModel_;
/*
* For output
*
*/
std::string registerName_;
/*
* @brief Vector of register state -> vector of from states ->
* vector of to states (for acceleration purpose)
*
*/
VVVuint vRegStates_;
size_t nbTypes_;
/*
* @brief vector of the rates of the register types
*
*/
Vdouble vRates_;
public:
/*
* @brief Constructor
*
* @param originalModel the substitution model used
* @param reg the register in which the considered types of event are
* used.
* @param isNormalized says if model is normalized (default false)
*
*/
RegisterRatesSubstitutionModel(const SubstitutionModel& originalModel, const SubstitutionRegister& reg, bool isNormalized = false);
RegisterRatesSubstitutionModel(const RegisterRatesSubstitutionModel& fmsm) :
AbstractParameterAliasable(fmsm),
AbstractSubstitutionModel(fmsm),
originalModel_(fmsm.originalModel_->clone()),
registerName_(fmsm.registerName_),
vRegStates_(fmsm.vRegStates_),
nbTypes_(fmsm.nbTypes_),
vRates_(fmsm.vRates_)
{}
RegisterRatesSubstitutionModel& operator=(const RegisterRatesSubstitutionModel& fmsm)
{
AbstractSubstitutionModel::operator=(fmsm);
originalModel_.reset(fmsm.originalModel_->clone());
registerName_= fmsm.registerName_;
vRegStates_ = fmsm.vRegStates_;
nbTypes_ = fmsm.nbTypes_;
vRates_ = fmsm.vRates_;
return *this;
}
~RegisterRatesSubstitutionModel() {}
RegisterRatesSubstitutionModel* clone() const { return new RegisterRatesSubstitutionModel(*this); }
public:
/*
* @brief clear overrides of AbstractSubstitutionModel and
* AbstractWrappedSubstitutionModel.
*
*/
const std::vector<int>& getAlphabetStates() const
{
return AbstractWrappedSubstitutionModel::getAlphabetStates();
}
std::vector<size_t> getModelStates(int i) const
{
return AbstractWrappedSubstitutionModel::getModelStates(i);
}
std::vector<size_t> getModelStates(const std::string& s) const
{
return AbstractWrappedSubstitutionModel::getModelStates(s);
}
int getAlphabetStateAsInt(size_t i) const{
return AbstractWrappedSubstitutionModel::getAlphabetStateAsInt(i);
}
std::string getAlphabetStateAsChar(size_t s) const
{
return AbstractWrappedSubstitutionModel::getAlphabetStateAsChar(s);
}
const Alphabet* getAlphabet() const
{
return AbstractWrappedSubstitutionModel::getAlphabet();
}
const StateMap& getStateMap() const
{
return AbstractWrappedSubstitutionModel::getStateMap();
}
/*
* @brief From AbstractWrappedSubstitutionModel
*
*/
const SubstitutionModel& getSubstitutionModel() const
{
return *originalModel_.get();
}
const TransitionModel& getModel() const
{
return *originalModel_.get();
}
protected:
SubstitutionModel& getSubstitutionModel()
{
return *originalModel_.get();
}
TransitionModel& getModel()
{
return *originalModel_.get();
}
public:
/*
* @brief From AbstractSubstitutionModel
*
*/
void fireParameterChanged(const ParameterList& parameters)
{
getSubstitutionModel().matchParametersValues(parameters);
AbstractParameterAliasable::fireParameterChanged(parameters);
updateMatrices();
}
size_t getNumberOfStates() const
{
return getModel().getNumberOfStates();
}
public:
void updateMatrices();
std::string getName() const
{
return "FromRegister";
}
const std::string& getRegisterName() const
{
return registerName_;
}
void addRateParameter()
{
throw Exception("RegisterRatesSubstitutionModel::addRateParameter method should not be called, because rates are defined through registers.");
}
/*
* @}
*
*/
void setRate(double rate) { getModel().setRate(rate); }
double getRate() const { return getModel().getRate(); }
private:
void setRegStates_();
};
} // end of namespace bpp.
#endif // _REGISTER_RATES_TRANSITION_MODEL_H_
|