bpp-seq
2.2.0
|
#include <Bpp/Seq/Alphabet/NumericAlphabet.h>
Public Member Functions | |
NumericAlphabet (const UniformDiscreteDistribution &) | |
virtual | ~NumericAlphabet () |
NumericAlphabet (const NumericAlphabet &) | |
NumericAlphabet & | operator= (const NumericAlphabet &) |
NumericAlphabet * | clone () const |
void | setState (size_t pos, AlphabetState *st) throw (Exception) |
Set a state in the Alphabet. More... | |
void | registerState (AlphabetState *st) throw (Exception) |
Add a state to the Alphabet. More... | |
bool | containsGap (const std::string &state) const throw (BadCharException) |
unsigned int | getSize () const |
Get the number of resolved states in the alphabet (e.g. return 4 for DNA alphabet). This is the method you'll need in most cases. More... | |
unsigned int | getNumberOfTypes () const |
Get the number of distinct states in alphabet (e.g. return 15 for DNA alphabet). This is the number of integers used for state description. More... | |
int | getUnknownCharacterCode () const |
bool | isGap (int state) const |
std::vector< int > | getAlias (int state) const throw (BadIntException) |
Get all resolved states that match a generic state. More... | |
std::vector< std::string > | getAlias (const std::string &state) const throw (BadCharException) |
Get all resolved states that match a generic state. More... | |
bool | isUnresolved (int state) const |
bool | isUnresolved (const std::string &state) const |
std::string | getAlphabetType () const |
Identification method. More... | |
AlphabetNumericState & | getStateAt (size_t stateIndex) throw (IndexOutOfBoundsException) |
Get a state at a position in the alphabet_ vector. More... | |
const AlphabetNumericState & | getStateAt (size_t stateIndex) const throw (IndexOutOfBoundsException) |
Get a state at a position in the alphabet_ vector. More... | |
double | getDelta () const |
Returns the difference between successive values. More... | |
double | intToValue (int state) const throw (BadIntException) |
Returns the value for the character number. More... | |
size_t | getValueIndex (double value) const |
Returns the CategoryIndex of the category to which the value belongs. More... | |
void | remap () |
Re-update the maps. More... | |
Implement these methods from the Alphabet interface. | |
size_t | getNumberOfStates () const |
This is a convenient alias for getNumberOfChars(), returning a size_t instead of unsigned int. More... | |
unsigned int | getNumberOfChars () const |
Get the number of supported characters in this alphabet, including generic characters (e.g. return 20 for DNA alphabet). More... | |
std::string | getName (const std::string &state) const throw (BadCharException) |
Get the complete name of a state given its string description. More... | |
std::string | getName (int state) const throw (BadIntException) |
Get the complete name of a state given its int description. More... | |
int | charToInt (const std::string &state) const throw (BadCharException) |
Give the int description of a state given its string description. More... | |
std::string | intToChar (int state) const throw (BadIntException) |
Give the string description of a state given its int description. More... | |
bool | isIntInAlphabet (int state) const |
Tell if a state (specified by its int description) is allowed by the the alphabet. More... | |
bool | isCharInAlphabet (const std::string &state) const |
Tell if a state (specified by its string description) is allowed by the the alphabet. More... | |
int | getGeneric (const std::vector< int > &states) const throw (BadIntException) |
Get the generic state that match a set of states. More... | |
std::string | getGeneric (const std::vector< std::string > &states) const throw (AlphabetException) |
Get the generic state that match a set of states. More... | |
const std::vector< int > & | getSupportedInts () const |
const std::vector< std::string > & | getSupportedChars () const |
int | getGapCharacterCode () const |
bool | isGap (const std::string &state) const |
Specific methods to access AlphabetState | |
const AlphabetState & | getState (const std::string &letter) const throw (BadCharException) |
Get a state by its letter. More... | |
AlphabetState & | getState (const std::string &letter) throw (BadCharException) |
const AlphabetState & | getState (int num) const throw (BadIntException) |
Get a state by its num. More... | |
AlphabetState & | getState (int num) throw (BadIntException) |
int | getIntCodeAt (size_t stateIndex) const throw (IndexOutOfBoundsException) |
const std::string & | getCharCodeAt (size_t stateIndex) const throw (IndexOutOfBoundsException) |
size_t | getStateIndex (int state) const throw (BadIntException) |
size_t | getStateIndex (const std::string &state) const throw (BadCharException) |
Protected Member Functions | |
void | resize (size_t size) |
Resize the private alphabet_ vector. More... | |
unsigned int | getStateCodingSize () const |
Get the size of the string coding a state. More... | |
bool | equals (const Alphabet &alphabet) const |
Comparison of alphabets. More... | |
Protected Attributes | |
Available codes | |
These vectors will be computed the first time you call the getAvailableInts or getAvailableChars method. | |
std::vector< std::string > | charList_ |
std::vector< int > | intList_ |
Private Attributes | |
const UniformDiscreteDistribution * | pdd_ |
std::map< double, size_t > | values_ |
Definition at line 58 of file NumericAlphabet.h.
NumericAlphabet::NumericAlphabet | ( | const UniformDiscreteDistribution & | pd | ) |
Definition at line 52 of file NumericAlphabet.cpp.
References pdd_, and registerState().
Referenced by clone().
|
inlinevirtual |
Definition at line 69 of file NumericAlphabet.h.
References pdd_.
NumericAlphabet::NumericAlphabet | ( | const NumericAlphabet & | na | ) |
Definition at line 66 of file NumericAlphabet.cpp.
|
virtualinherited |
Give the int description of a state given its string description.
state | The string description. |
BadCharException | When state is not a valid char description. |
Implements bpp::Alphabet.
Reimplemented in bpp::WordAlphabet, bpp::LetterAlphabet, and bpp::RNY.
Definition at line 178 of file AbstractAlphabet.cpp.
Referenced by bpp::RNY::charToInt(), bpp::WordAlphabet::charToInt(), and bpp::AbstractAlphabet::isGap().
|
inlinevirtual |
Implements bpp::AbstractAlphabet.
Definition at line 75 of file NumericAlphabet.h.
References NumericAlphabet().
bool NumericAlphabet::containsGap | ( | const std::string & | state | ) | const |
throw | ( | BadCharException | |||
) |
Definition at line 127 of file NumericAlphabet.cpp.
|
inlineprotectedvirtualinherited |
Comparison of alphabets.
Implements bpp::Alphabet.
Definition at line 268 of file AbstractAlphabet.h.
References bpp::Alphabet::getAlphabetType().
|
virtual |
Get all resolved states that match a generic state.
If the given state is not a generic code then the output vector will contain this unique code.
state | The alias to resolve. |
BadIntException | When state is not a valid integer. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 106 of file NumericAlphabet.cpp.
|
virtual |
Get all resolved states that match a generic state.
If the given state is not a generic code then the output vector will contain this unique code.
state | The alias to resolve. |
BadCharException | When state is not a valid char description. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 113 of file NumericAlphabet.cpp.
|
inlinevirtual |
Identification method.
Used to tell if two alphabets describe the same type of sequences. For instance, this method is used by sequence containers to compare two alphabets and allow or deny addition of sequences.
Implements bpp::Alphabet.
Definition at line 95 of file NumericAlphabet.h.
|
inlinevirtualinherited |
stateIndex | The index of the state to fetch. |
Implements bpp::Alphabet.
Definition at line 220 of file AbstractAlphabet.h.
References bpp::AlphabetState::getLetter(), and bpp::AbstractAlphabet::getStateAt().
double NumericAlphabet::getDelta | ( | ) | const |
Returns the difference between successive values.
@ brief Specific methods
Definition at line 165 of file NumericAlphabet.cpp.
References pdd_.
|
inlinevirtualinherited |
Implements bpp::Alphabet.
Definition at line 159 of file AbstractAlphabet.h.
Referenced by bpp::SequenceTools::replaceStopsWithGaps().
|
virtualinherited |
Get the generic state that match a set of states.
If the given states contain generic code, each generic code is first resolved and then the new generic state is returned. If only a single resolved state is given the function return this state.
states | A vector of states to resolve. |
BadIntException | When a state is not a valid integer. |
Implements bpp::Alphabet.
Reimplemented in bpp::WordAlphabet, bpp::ProteicAlphabet, bpp::DNA, and bpp::RNA.
Definition at line 232 of file AbstractAlphabet.cpp.
|
virtualinherited |
Get the generic state that match a set of states.
If the given states contain generic code, each generic code is first resolved and then the new generic state is returned. If only a single resolved state is given the function return this state.
states | A vector of states to resolve. |
BadCharException | when a state is not a valid char description. |
CharStateNotSupportedException | when the alphabet does not support Char state for unresolved state. |
Implements bpp::Alphabet.
Reimplemented in bpp::WordAlphabet, bpp::ProteicAlphabet, bpp::DNA, and bpp::RNA.
Definition at line 258 of file AbstractAlphabet.cpp.
|
inlinevirtualinherited |
stateIndex | The index of the state to fetch. |
Implements bpp::Alphabet.
Definition at line 216 of file AbstractAlphabet.h.
References bpp::AlphabetState::getNum(), and bpp::AbstractAlphabet::getStateAt().
|
virtualinherited |
Get the complete name of a state given its string description.
In case of several states with identical number (i.e. N and X for nucleic alphabets), this method will return the name of the first found in the vector.
state | The string description of the given state. |
BadCharException | When state is not a valid char description. |
Implements bpp::Alphabet.
Reimplemented in bpp::WordAlphabet.
Definition at line 164 of file AbstractAlphabet.cpp.
Referenced by bpp::WordAlphabet::getName().
|
virtualinherited |
Get the complete name of a state given its int description.
In case of several states with identical number (i.e. N and X for nucleic alphabets), this method returns the name of the first found in the vector.
state | The int description of the given state. |
BadIntException | When state is not a valid integer. |
Implements bpp::Alphabet.
Definition at line 171 of file AbstractAlphabet.cpp.
|
inlinevirtualinherited |
Get the number of supported characters in this alphabet, including generic characters (e.g. return 20 for DNA alphabet).
Implements bpp::Alphabet.
Definition at line 146 of file AbstractAlphabet.h.
References bpp::AbstractAlphabet::alphabet_.
Referenced by bpp::WordAlphabet::getNumberOfTypes(), bpp::WordAlphabet::getSize(), and bpp::NucleicAlphabet::registerState().
|
inlinevirtualinherited |
This is a convenient alias for getNumberOfChars(), returning a size_t instead of unsigned int.
This funcion is typically used il loops over all states of an alphabet.
Implements bpp::Alphabet.
Definition at line 145 of file AbstractAlphabet.h.
References bpp::AbstractAlphabet::alphabet_.
|
virtual |
Get the number of distinct states in alphabet (e.g. return 15 for DNA alphabet). This is the number of integers used for state description.
Implements bpp::Alphabet.
Definition at line 147 of file NumericAlphabet.cpp.
References values_.
|
virtual |
Get the number of resolved states in the alphabet (e.g. return 4 for DNA alphabet). This is the method you'll need in most cases.
Implements bpp::Alphabet.
Definition at line 142 of file NumericAlphabet.cpp.
References values_.
Referenced by remap().
|
virtualinherited |
Get a state by its letter.
This method must be overloaded in specialized classes to send back a reference of the corect type.
letter | The letter of the state to find. |
BadCharException | If the letter is not in the Alphabet. |
Implements bpp::Alphabet.
Reimplemented in bpp::NucleicAlphabet, and bpp::ProteicAlphabet.
Definition at line 94 of file AbstractAlphabet.cpp.
Referenced by bpp::CaseMaskedAlphabet::CaseMaskedAlphabet(), bpp::ProteicAlphabet::getState(), and bpp::NucleicAlphabet::getState().
|
inherited |
Definition at line 130 of file AbstractAlphabet.cpp.
|
virtualinherited |
Get a state by its num.
This method must be overloaded in specialized classes to send back a reference of the corect type.
num | The num of the state to find. |
BadIntException | If the num is not in the Alphabet. |
Implements bpp::Alphabet.
Reimplemented in bpp::NucleicAlphabet, and bpp::ProteicAlphabet.
Definition at line 112 of file AbstractAlphabet.cpp.
|
inherited |
Definition at line 139 of file AbstractAlphabet.cpp.
|
virtual |
Get a state at a position in the alphabet_ vector.
This method must be overloaded in specialized classes to send back a reference of the corect type.
stateIndex | The index of the state in the alphabet_ vector. |
IndexOutOfBoundsException | If the index is invalid. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 181 of file NumericAlphabet.cpp.
References bpp::AbstractAlphabet::getStateAt().
Referenced by remap().
|
virtual |
Get a state at a position in the alphabet_ vector.
This method must be overloaded in specialized classes to send back a reference of the corect type.
stateIndex | The index of the state in the alphabet_ vector. |
IndexOutOfBoundsException | If the index is invalid. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 186 of file NumericAlphabet.cpp.
References bpp::AbstractAlphabet::getStateAt().
|
inlineprotectedvirtualinherited |
Get the size of the string coding a state.
Implements bpp::Alphabet.
Reimplemented in bpp::WordAlphabet.
Definition at line 266 of file AbstractAlphabet.h.
|
virtualinherited |
Implements bpp::Alphabet.
Definition at line 121 of file AbstractAlphabet.cpp.
Referenced by bpp::AAIndex2Entry::getIndex().
|
virtualinherited |
Implements bpp::Alphabet.
Definition at line 103 of file AbstractAlphabet.cpp.
|
virtualinherited |
Note for developers of new alphabets: we return a const reference here since the list is supposed to be stored within the class and should not be modified outside the class.
Implements bpp::Alphabet.
Definition at line 301 of file AbstractAlphabet.cpp.
Referenced by bpp::CaseMaskedAlphabet::CaseMaskedAlphabet().
|
virtualinherited |
Note for developers of new alphabets: we return a const reference here since the list is supposed to be stored within the class and should not be modified outside the class.
Implements bpp::Alphabet.
Definition at line 284 of file AbstractAlphabet.cpp.
|
inlinevirtual |
Implements bpp::Alphabet.
Definition at line 88 of file NumericAlphabet.h.
size_t NumericAlphabet::getValueIndex | ( | double | value | ) | const |
Returns the CategoryIndex of the category to which the value belongs.
Definition at line 175 of file NumericAlphabet.cpp.
|
virtualinherited |
Give the string description of a state given its int description.
state | The int description. |
BadIntException | When state is not a valid integer. |
Implements bpp::Alphabet.
Reimplemented in bpp::RNY.
Definition at line 185 of file AbstractAlphabet.cpp.
Referenced by bpp::RNY::getAlias(), bpp::GeneticCode::getCodingSequence(), bpp::WordAlphabet::getNPosition(), bpp::NucleicAlphabet::getOverlap(), bpp::WordAlphabet::getPositions(), bpp::EchinodermMitochondrialGeneticCode::isAltStart(), bpp::YeastMitochondrialGeneticCode::isAltStart(), bpp::InvertebrateMitochondrialGeneticCode::isAltStart(), bpp::MoldMitochondrialGeneticCode::isAltStart(), bpp::StandardGeneticCode::isAltStart(), bpp::AscidianMitochondrialGeneticCode::isAltStart(), bpp::VertebrateMitochondrialGeneticCode::isAltStart(), bpp::GeneticCode::isStart(), bpp::EchinodermMitochondrialGeneticCode::isStop(), bpp::StandardGeneticCode::isStop(), bpp::MoldMitochondrialGeneticCode::isStop(), bpp::YeastMitochondrialGeneticCode::isStop(), bpp::InvertebrateMitochondrialGeneticCode::isStop(), bpp::VertebrateMitochondrialGeneticCode::isStop(), bpp::AscidianMitochondrialGeneticCode::isStop(), and bpp::NucleicAlphabet::subtract().
double NumericAlphabet::intToValue | ( | int | state | ) | const |
throw | ( | BadIntException | |||
) |
Returns the value for the character number.
Definition at line 170 of file NumericAlphabet.cpp.
|
virtualinherited |
Tell if a state (specified by its string description) is allowed by the the alphabet.
state | The string description. |
Implements bpp::Alphabet.
Reimplemented in bpp::LetterAlphabet.
Definition at line 202 of file AbstractAlphabet.cpp.
|
virtual |
state | The state to test. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 122 of file NumericAlphabet.cpp.
|
inlinevirtualinherited |
state | The state to test. |
Implements bpp::Alphabet.
Definition at line 161 of file AbstractAlphabet.h.
References bpp::AbstractAlphabet::charToInt().
|
virtualinherited |
Tell if a state (specified by its int description) is allowed by the the alphabet.
state | The int description. |
Implements bpp::Alphabet.
Definition at line 192 of file AbstractAlphabet.cpp.
|
virtual |
state | The state to test. |
Implements bpp::Alphabet.
Definition at line 137 of file NumericAlphabet.cpp.
|
virtual |
state | The state to test. |
Implements bpp::Alphabet.
Definition at line 132 of file NumericAlphabet.cpp.
NumericAlphabet & NumericAlphabet::operator= | ( | const NumericAlphabet & | na | ) |
Definition at line 72 of file NumericAlphabet.cpp.
References bpp::AbstractAlphabet::operator=(), and pdd_.
|
virtual |
Add a state to the Alphabet.
st | The state to add. |
Exception | If a wrong alphabet state is provided. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 93 of file NumericAlphabet.cpp.
References bpp::AbstractAlphabet::registerState().
Referenced by NumericAlphabet().
void NumericAlphabet::remap | ( | ) |
Re-update the maps.
Definition at line 152 of file NumericAlphabet.cpp.
References getSize(), getStateAt(), bpp::AlphabetNumericState::getValue(), bpp::AbstractAlphabet::remap(), and values_.
|
inlineprotectedinherited |
Resize the private alphabet_ vector.
size | The new size of the Alphabet. |
Definition at line 253 of file AbstractAlphabet.h.
References bpp::AbstractAlphabet::alphabet_.
Referenced by bpp::IntegerAlphabet::IntegerAlphabet().
|
virtual |
Set a state in the Alphabet.
pos | The index of the state in the alphabet_ vector. |
st | The new state to put in the Alphabet. |
Exception | If a wrong alphabet state is provided. |
IndexOutOfBoundsException | If an incorrect index is provided. |
Reimplemented from bpp::AbstractAlphabet.
Definition at line 81 of file NumericAlphabet.cpp.
References bpp::AbstractAlphabet::setState().
|
mutableprotectedinherited |
Definition at line 99 of file AbstractAlphabet.h.
Referenced by bpp::AbstractAlphabet::operator=().
|
mutableprotectedinherited |
Definition at line 100 of file AbstractAlphabet.h.
Referenced by bpp::AbstractAlphabet::operator=().
|
private |
Definition at line 61 of file NumericAlphabet.h.
Referenced by getDelta(), getValueIndex(), NumericAlphabet(), operator=(), and ~NumericAlphabet().
|
private |
Definition at line 63 of file NumericAlphabet.h.
Referenced by getNumberOfTypes(), getSize(), getValueIndex(), and remap().