/usr/include/Bpp/Phyl/Model/StateMap.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 | //
// File: StateMap.h
// Created by: Julien Dutheil
// Created on: Wed Jun 13 15:03 2012
//
/*
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 _STATEMAP_H_
#define _STATEMAP_H_
#include <Bpp/Clonable.h>
#include <Bpp/Seq/Alphabet/Alphabet.h>
#include <Bpp/Seq/Alphabet/NucleicAlphabet.h>
#include <Bpp/Numeric/VectorTools.h>
//From the STL:
#include <vector>
#include <string>
namespace bpp
{
/**
* @brief Map the states of a given alphabet which have a model state.
*/
class StateMap:
public virtual Clonable
{
public:
virtual ~StateMap() {}
virtual StateMap* clone() const = 0;
public:
/**
* @return The associated alphabet.
*/
virtual const Alphabet* getAlphabet() const = 0;
/**
* @return The number of states supported by the model.
*/
virtual size_t getNumberOfModelStates() const = 0;
/**
* @return A string describing the model state.
* @param index The state index.
*/
virtual std::string getStateDescription(size_t index) const = 0;
/**
* @return A vector with the corresponding alphabet states for each model state.
* the size of the vector is the number of model states, not the number of supported alphabet states,
* as distinct model states can correspond to a single alphabet state.
*/
virtual const std::vector<int>& getAlphabetStates() const = 0;
/**
* @param index The model state.
* @return The corresponding alphabet state as character code.
*/
virtual std::string getAlphabetStateAsChar(size_t index) const = 0;
/**
* @param index The model state.
* @return The corresponding alphabet state as int code.
*/
virtual int getAlphabetStateAsInt(size_t index) const = 0;
/**
* @param code The character code of the alphabet state to check.
* @return The corresponding model states, is any.
*/
virtual std::vector<size_t> getModelStates(const std::string& code) const = 0;
/**
* @param code The int code of the alphabet state to check.
* @return The corresponding model states, is any.
*/
virtual std::vector<size_t> getModelStates(int code) const = 0;
};
/**
* @brief A convenience partial implementation of the StateMap interface.
*
* Model states are stored as their corresponding int codes, stored in a vector 'states_'.
* This vector has to be initialized and filled by the derived class.
*/
class AbstractStateMap:
public virtual StateMap
{
protected:
const Alphabet* alphabet_;
std::vector<int> states_;
public:
AbstractStateMap(const Alphabet* alphabet):
alphabet_(alphabet),
states_()
{}
AbstractStateMap(const AbstractStateMap& absm):
alphabet_(absm.alphabet_),
states_(absm.states_)
{}
AbstractStateMap& operator=(const AbstractStateMap& absm)
{
alphabet_ = absm.alphabet_;
states_ = absm.states_;
return *this;
}
public:
virtual const Alphabet* getAlphabet() const { return alphabet_; }
virtual size_t getNumberOfModelStates() const { return states_.size(); }
virtual const std::vector<int>& getAlphabetStates() const { return states_; }
virtual int getAlphabetStateAsInt(size_t index) const { return states_[index]; }
virtual std::string getAlphabetStateAsChar(size_t index) const { return alphabet_->intToChar(states_[index]); }
virtual std::vector<size_t> getModelStates(int code) const {
return VectorTools::whichAll(states_, code);
}
virtual std::vector<size_t> getModelStates(const std::string& code) const {
return VectorTools::whichAll(states_, alphabet_->charToInt(code));
}
};
/**
* @brief This class implements a state map where all resolved states are modeled.
*
* For nucleotides, the underlying states are for instance: A (0), C (1), G (2), T/U (3).
* Optionally, gaps can be modeled.
*/
class CanonicalStateMap:
public AbstractStateMap
{
public:
CanonicalStateMap(const Alphabet* alphabet, bool includeGaps);
/**
* @brief this contructors takes an existing StateMap and adds one model states for gaps.
* If the original StateMap alread had a state for gaps, a new one will be appended.
*/
CanonicalStateMap(const StateMap& sm, bool includeGaps);
virtual CanonicalStateMap* clone() const { return new CanonicalStateMap(*this); }
virtual std::string getStateDescription(size_t index) const { return getAlphabetStateAsChar(index); }
};
/**
* @brief This class implements a state map for Markov modulated models.
*
* For nucleotides with two classes, the underlying states are for instance:
* A (0), C (1), G (2), T/U (3), A (4), C (5), G (6), T/U (7).
*/
class MarkovModulatedStateMap:
public AbstractStateMap
{
private:
unsigned int nbClasses_;
public:
MarkovModulatedStateMap(const StateMap& unitMap, unsigned int nbClasses);
virtual MarkovModulatedStateMap* clone() const { return new MarkovModulatedStateMap(*this); }
virtual std::string getStateDescription(size_t index) const { return getAlphabetStateAsChar(index) + TextTools::toString(index % nbClasses_); }
};
}// end of namespace bpp
#endif //_STATEMAP_H_
|