/usr/include/Bpp/Phyl/Simulation/NonHomogeneousSequenceSimulator.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 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 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | //
// File: NonHomogeneousSequenceSimulator.h
// Created by: Julien Dutheil
// Bastien Boussau
// Created on: Wed Aug 24 15:20 2005
//
/*
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 _NONHOMOGENEOUSSEQUENCESIMULATOR_H_
#define _NONHOMOGENEOUSSEQUENCESIMULATOR_H_
#include "DetailedSiteSimulator.h"
#include "SequenceSimulator.h"
#include "../TreeTemplate.h"
#include "../NodeTemplate.h"
#include "../Model/SubstitutionModel.h"
#include <Bpp/Numeric/Random/RandomTools.h>
#include <Bpp/Numeric/Prob/DiscreteDistribution.h>
// From SeqLib:
#include <Bpp/Seq/Alphabet/Alphabet.h>
#include <Bpp/Seq/Site.h>
#include <Bpp/Seq/Container/SiteContainer.h>
// From the STL:
#include <map>
#include <vector>
#include "../Model/SubstitutionModelSet.h"
namespace bpp
{
class SimData
{
public:
int state;
std::vector<int> states;
VVVdouble cumpxy;
const SubstitutionModel* model;
public:
SimData(): state(), states(), cumpxy(), model(0) {}
SimData(const SimData& sd): state(sd.state), states(sd.states), cumpxy(), model(sd.model) {}
SimData& operator=(const SimData& sd)
{
state = sd.state;
states = sd.states;
cumpxy = sd.cumpxy;
model = sd.model;
return *this;
}
};
typedef NodeTemplate<SimData> SNode;
/**
* @brief Site and sequences simulation under non-homogeneous models.
*
* Rate across sites variation is supported, using a DiscreteDistribution object or by specifying explicitely the rate of the sites to simulate.
*/
class NonHomogeneousSequenceSimulator:
public DetailedSiteSimulator,
public virtual SequenceSimulator
{
private:
const SubstitutionModelSet* modelSet_;
const Alphabet * alphabet_;
const DiscreteDistribution* rate_;
const Tree * templateTree_;
mutable TreeTemplate<SNode> tree_;
bool ownModelSet_;
/**
* @brief This stores once for all all leaves in a given order.
* This order will be used during site creation.
*/
std::vector<SNode*> leaves_;
std::vector<std::string> seqNames_;
size_t nbNodes_;
size_t nbClasses_;
size_t nbStates_;
bool continuousRates_;
/**
* @name Stores intermediate results.
*
* @{
*/
public:
NonHomogeneousSequenceSimulator(
const SubstitutionModelSet* modelSet,
const DiscreteDistribution* rate,
const Tree* tree
) throw (Exception);
NonHomogeneousSequenceSimulator(
const SubstitutionModel* model,
const DiscreteDistribution* rate,
const Tree* tree
);
virtual ~NonHomogeneousSequenceSimulator()
{
if (ownModelSet_ && modelSet_) delete modelSet_;
}
NonHomogeneousSequenceSimulator(const NonHomogeneousSequenceSimulator& nhss) :
modelSet_ (nhss.modelSet_),
alphabet_ (nhss.alphabet_),
rate_ (nhss.rate_),
templateTree_ (nhss.templateTree_),
tree_ (nhss.tree_),
ownModelSet_ (nhss.ownModelSet_),
leaves_ (nhss.leaves_),
seqNames_ (nhss.seqNames_),
nbNodes_ (nhss.nbNodes_),
nbClasses_ (nhss.nbClasses_),
nbStates_ (nhss.nbStates_),
continuousRates_(nhss.continuousRates_)
{}
NonHomogeneousSequenceSimulator& operator=(const NonHomogeneousSequenceSimulator& nhss)
{
modelSet_ = nhss.modelSet_;
alphabet_ = nhss.alphabet_;
rate_ = nhss.rate_;
templateTree_ = nhss.templateTree_;
tree_ = nhss.tree_;
ownModelSet_ = nhss.ownModelSet_;
leaves_ = nhss.leaves_;
seqNames_ = nhss.seqNames_;
nbNodes_ = nhss.nbNodes_;
nbClasses_ = nhss.nbClasses_;
nbStates_ = nhss.nbStates_;
continuousRates_ = nhss.continuousRates_;
return *this;
}
#ifndef NO_VIRTUAL_COV
NonHomogeneousSequenceSimulator*
#else
Clonable*
#endif
clone() const { return new NonHomogeneousSequenceSimulator(*this); }
private:
/**
* @brief Init all probabilities.
*
* Method called by constructors.
*/
void init();
public:
/**
* @name The SiteSimulator interface
*
* @{
*/
Site* simulate() const;
Site* simulate(int ancestralState) const;
Site* simulate(int ancestralState, double rate) const;
Site* simulate(double rate) const;
std::vector<std::string> getSequencesNames() const { return seqNames_; }
/** @} */
/**
* @name The PreciseSiteSimulator interface.
*
* @{
*/
RASiteSimulationResult* dSimulate() const;
RASiteSimulationResult* dSimulate(int ancestralState) const;
RASiteSimulationResult* dSimulate(int ancestralState, double rate) const;
RASiteSimulationResult* dSimulate(double rate) const;
/** @} */
/**
* @name The SequenceSimulator interface
*
* @{
*/
SiteContainer* simulate(size_t numberOfSites) const;
/** @} */
/**
* @name SiteSimulator and SequenceSimulator interface
*
* @{
*/
const Alphabet* getAlphabet() const { return alphabet_; }
/** @} */
/**
* @name Functions with rate classes instead of absolute rates.
*
* @{
*/
virtual Site* simulate(int ancestralState, size_t rateClass) const;
virtual RASiteSimulationResult* dSimulate(int ancestralState, size_t rateClass) const;
/** @} */
/**
* @brief Get the mutation process associated to this instance.
*
* @return The MutationProcess object associated to this instance.
*/
const SubstitutionModelSet* getSubstitutionModelSet() const { return modelSet_; }
/**
* @brief Get the rate distribution associated to this instance.
*
* @return The DiscreteDistribution object associated to this instance.
*/
const DiscreteDistribution* getRateDistribution() const { return rate_; }
/**
* @brief Get the tree associated to this instance.
*
* @return The Tree object associated to this instance.
*/
const Tree* getTree() const { return templateTree_; }
/**
* @brief Enable the use of continuous rates instead of discrete rates.
*
* To work, the DiscreteDistribution object used should implement the randC method.
*
* @param yn Tell if we should use continuous rates.
*/
void enableContinuousRates(bool yn) { continuousRates_ = yn; }
protected:
/**
* @brief Evolve from an initial state along a branch, knowing the evolutionary rate class.
*
* This method is fast since all pijt have been computed in the constructor of the class.
* This method is used for the implementation of the SiteSimulator interface.
*/
int evolve(const SNode * node, int initialState, size_t rateClass) const;
/**
* @brief Evolve from an initial state along a branch, knowing the evolutionary rate.
*
* This method is slower than the previous one since exponential terms must be computed.
* This method is used for the implementation of the SiteSimulator interface.
*/
int evolve(const SNode * node, int initialState, double rate) const;
/**
* @brief The same as the evolve(initialState, rateClass) function, but for several sites at a time.
*
* This method is used for the implementation of the SequenceSimulator interface.
*/
void multipleEvolve(const SNode* node, const Vint& initialState, const std::vector<size_t>& rateClasses, Vint& finalStates) const;
SiteContainer* multipleEvolve(const Vint& initialStates, const std::vector<size_t>& rateClasses) const;
void dEvolve(int initialState, double rate, RASiteSimulationResult& rassr) const;
/**
* @name The 'Internal' methods.
*
* @{
*/
/**
* This method uses the states_ variable for saving ancestral states.
*/
void evolveInternal(SNode* node, size_t rateClass) const;
/**
* This method uses the states_ variable for saving ancestral states.
*/
void evolveInternal(SNode* node, double rate) const;
/**
* This method uses the multipleStates_ variable for saving ancestral states.
*/
void multipleEvolveInternal(SNode* node, const std::vector<size_t>& rateClasses) const;
/**
* This method uses the states_ variable for saving ancestral states.
*/
void dEvolveInternal(SNode * node, double rate, RASiteSimulationResult & rassr) const;
/** @} */
};
} //end of namespace bpp.
#endif //_NONHOMOGENEOUSSEQUENCESIMULATOR_H_
|