/usr/include/Bpp/Seq/Alphabet/WordAlphabet.h is in libbpp-seq-dev 2.4.0-2.
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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | //
// File: WordAlphabet.h
// Created by: Laurent Gueguen
// Created on: Sun Dec 28 2008
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for sequences 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 _WORDALPHABET_H_
#define _WORDALPHABET_H_
#include "AbstractAlphabet.h"
// From the STL:
#include <string>
#include <vector>
#include "../Sequence.h"
namespace bpp
{
/**
* @brief The interface class for word alphabets.
*
*/
class CoreWordAlphabet
{
public:
CoreWordAlphabet() {}
virtual ~CoreWordAlphabet() {}
virtual unsigned int getLength() const = 0;
virtual unsigned int getSize() const = 0;
virtual bool hasUniqueAlphabet() const = 0;
virtual const Alphabet* getNAlphabet(size_t n) const = 0;
virtual int getWord(const Sequence& seq, size_t pos = 0) const = 0;
/**
* @brief Get the int code for a word given the int code of the underlying positions.
*
* The int code of each position must match the corresponding alphabet specified at this position.
* @param vint description for all the positions.
* @param pos the start position to match in the vector.
* @return The int code of the word.
* @throw IndexOutOfBoundsException In case of wrong position.
*/
virtual int getWord(const std::vector<int>& vint, size_t pos = 0) const = 0;
/**
* @brief Get the char code for a word given the char code of the
* underlying positions.
*
* The char code of each position must match the corresponding alphabet specified at this position.
* @param vpos vector description for all the positions.
* @param pos the start position to match in the vector.
* @return The string of the word.
* @throw IndexOutOfBoundsException In case of wrong position.
*/
virtual std::string getWord(const std::vector<std::string>& vpos, size_t pos = 0) const = 0;
/**
* @brief Get the int code of the n-position of a word given its int description.
*
* @param word The int description of the word.
* @param n The position in the word (starting at 0).
* @return The int description of the n-position of the word.
*/
virtual int getNPosition(int word, size_t n) const = 0;
/**
* @brief Get the int codes of each position of a word given its int description.
*
* @param word The int description of the word.
* @return The int description of the positions of the codon.
*/
virtual std::vector<int> getPositions(int word) const = 0;
/**
* @brief Get the char code of the n-position of a word given its char description.
*
* @param word The char description of the word.
* @param n The position in the word (starting at 0).
* @return The char description of the n-position of the word.
*/
virtual std::string getNPosition(const std::string& word, size_t n) const = 0;
/**
* @brief Get the char codes of each position of a word given its char description.
*
* @param word The char description of the word.
* @return The char description of the three positions of the word.
*/
virtual std::vector<std::string> getPositions(const std::string& word) const = 0;
/**
* @brief Translate a whole sequence from letters alphabet to words alphabet.
*
* @param sequence A sequence in letters alphabet.
* @param pos the start postion (default 0)
* @return The corresponding sequence in words alphabet.
* @throw AlphabetMismatchException If the sequence alphabet do not match the source alphabet.
* @throw Exception Other kind of error, depending on the implementation.
*/
virtual Sequence* translate(const Sequence &sequence, size_t pos = 0) const = 0;
/**
* @brief Translate a whole sequence from words alphabet to letters alphabet.
*
* @param sequence A sequence in words alphabet.
* @return The corresponding sequence in letters alphabet.
* @throw AlphabetMismatchException If the sequence alphabet do not match the target alphabet.
* @throw Exception Other kind of error, depending on the implementation.
*/
virtual Sequence* reverse(const Sequence& sequence) const = 0;
private:
/**
* @name Inner utilitary functions
*
* @{
*/
virtual bool containsUnresolved(const std::string& state) const = 0;
virtual bool containsGap(const std::string& state) const = 0;
/** @} */
};
/**
* @brief The base class for word alphabets.
*
* These alphabets are compounds of several alphabets. The only
* constraint on these alphabets is that their words have length one
* (so it is not possible to make WordAlphabets from other
* WordAlphabets). The construction is made from a vector of pointers
* to AbstractAlphabets.
*
* The strings of the WordAlphabet are concatenations of the strings
* of the Alphabets. They are made from the resolved letters of the
* Alphabets.
*/
class WordAlphabet :
public virtual CoreWordAlphabet,
public AbstractAlphabet
{
protected:
std::vector<const Alphabet* > vAbsAlph_;
public:
// Constructor and destructor.
/**
* @brief Builds a new word alphabet from a vector of Alphabets.
*
* The unit alphabets are not owned by the world alphabet, and won't
* be destroyed when this instance is destroyed.
*
* @param vAlpha The vector of Alphabets to be used.
*/
WordAlphabet(const std::vector<const Alphabet*>& vAlpha);
/**
* @brief Builds a new word alphabet from a pointer to number of
* Alphabets.
*
* @param pAlpha The Pointer to the Alphabet to be used.
* @param num the length of the words.
*/
WordAlphabet(const Alphabet* pAlpha, size_t num);
WordAlphabet(const WordAlphabet& bia) : AbstractAlphabet(bia), vAbsAlph_(bia.vAbsAlph_) {}
WordAlphabet& operator=(const WordAlphabet& bia)
{
AbstractAlphabet::operator=(bia);
vAbsAlph_=bia.vAbsAlph_;
return *this;
}
WordAlphabet* clone() const
{
return new WordAlphabet(*this);
}
virtual ~WordAlphabet() {}
public:
/**
* @name Methods redefined from Alphabet
*
* @{
*/
/**
* @brief Get the complete name of a state given its string description.
*
* In case of undefined characters (i.e. N and X for nucleic alphabets),
* this method will return the name of the undefined word.
*
* @param state The string description of the given state.
* @return The name of the state.
* @throw BadCharException When state is not a valid char description.
*/
std::string getName(const std::string& state) const;
int charToInt(const std::string& state) const
{
if (state.size() != vAbsAlph_.size())
throw BadCharException(state, "WordAlphabet::charToInt", this);
if (containsUnresolved(state))
return static_cast<int>(getSize());
if (containsGap(state))
return -1;
else return AbstractAlphabet::charToInt(state);
}
unsigned int getSize() const
{
return getNumberOfChars() - 2;
}
/** @} */
/**
* @brief Returns True if the Alphabet of the letters in the word
* are the same type.
*
*/
bool hasUniqueAlphabet() const;
/**
* @brief Returns the length of the word
*
*/
unsigned int getLength() const
{
return static_cast<unsigned int>(vAbsAlph_.size());
}
/**
* @brief Returns the number of resolved states + one for unresolved
*
*/
unsigned int getNumberOfTypes() const
{
return getNumberOfChars() - 1;
}
std::string getAlphabetType() const;
int getUnknownCharacterCode() const
{
return static_cast<int>(getSize());
}
bool isUnresolved(int state) const { return state == getUnknownCharacterCode(); }
bool isUnresolved(const std::string& state) const { return charToInt(state) == getUnknownCharacterCode(); }
std::vector<int> getAlias(int state) const;
std::vector<std::string> getAlias(const std::string& state) const;
int getGeneric(const std::vector<int>& states) const;
std::string getGeneric(const std::vector<std::string>& states) const;
private:
/**
* @name Inner utilitary functions
*
* @{
*/
bool containsUnresolved(const std::string& state) const;
bool containsGap(const std::string& state) const;
void build_();
/** @} */
public:
/**
* @name Word specific methods
*
* @{
*/
/**
* @brief Get the pointer to the Alphabet of the n-position.
*
* @param n The position in the word (starting at 0).
* @return The pointer to the Alphabet of the n-position.
*/
const Alphabet* getNAlphabet(size_t n) const
{
if (n >= vAbsAlph_.size())
throw IndexOutOfBoundsException("WordAlphabet::getNPosition", n, 0, vAbsAlph_.size());
return vAbsAlph_[n];
}
/**
* @brief Get the int code for a word given the int code of the underlying positions.
*
* The int code of each position must match the corresponding alphabet specified at this position.
* @param seq description for all the positions as a Sequence object.
* @param pos the start position to match in the vector.
* @return The int code of the word.
* @throw IndexOutOfBoundsException In case of wrong position.
*/
virtual int getWord(const Sequence& seq, size_t pos = 0) const;
/**
* @brief Get the int code for a word given the int code of the underlying positions.
*
* The int code of each position must match the corresponding alphabet specified at this position.
* @param vint description for all the positions.
* @param pos the start position to match in the vector.
* @return The int code of the word.
* @throw IndexOutOfBoundsException In case of wrong position.
*/
virtual int getWord(const std::vector<int>& vint, size_t pos = 0) const;
/**
* @brief Get the char code for a word given the char code of the
* underlying positions.
*
* The char code of each position must match the corresponding alphabet specified at this position.
* @param vpos vector description for all the positions.
* @param pos the start position to match in the vector.
* @return The string of the word.
* @throw IndexOutOfBoundsException In case of wrong position.
*/
virtual std::string getWord(const std::vector<std::string>& vpos, size_t pos = 0) const;
/**
* @brief Get the int code of the n-position of a word given its int description.
*
* @param word The int description of the word.
* @param n The position in the word (starting at 0).
* @return The int description of the n-position of the word.
*/
int getNPosition(int word, size_t n) const
{
if (n >= vAbsAlph_.size())
throw IndexOutOfBoundsException("WordAlphabet::getNPosition", n, 0, vAbsAlph_.size());
std::string s = intToChar(word);
return vAbsAlph_[n]->charToInt(s.substr(n, 1));
}
/**
* @brief Get the int codes of each position of a word given its int description.
*
* @param word The int description of the word.
* @return The int description of the positions of the codon.
*/
std::vector<int> getPositions(int word) const
{
std::string s = intToChar(word);
std::vector<int> positions;
for (size_t i = 0; i < s.size(); i++)
{
positions.push_back(vAbsAlph_[i]->charToInt(s.substr(i, 1)));
}
return positions;
}
/**
* @brief Get the char code of the n-position of a word given its char description.
*
* @param word The char description of the word.
* @param n The position in the word (starting at 0).
* @return The char description of the n-position of the word.
*/
std::string getNPosition(const std::string& word, size_t n) const
{
if (n > vAbsAlph_.size())
throw BadCharException("", "WordAlphabet::getNPosition", this);
// Test:
charToInt(word);
return "" + word.substr(n, 1);
}
/**
* @brief Get the char codes of each position of a word given its char description.
*
* @param word The char description of the word.
* @return The char description of the three positions of the word.
*/
std::vector<std::string> getPositions(const std::string& word) const
{
charToInt(word);
std::vector<std::string> positions;
for (size_t i = 0; i < word.size(); i++)
{
positions.push_back(word.substr(i, 1));
}
return positions;
}
/**
* @brief Translate a whole sequence from letters alphabet to words alphabet.
*
* @param sequence A sequence in letters alphabet.
* @param pos the start postion (default 0)
* @return The corresponding sequence in words alphabet.
* @throw AlphabetMismatchException If the sequence alphabet do not match the source alphabet.
* @throw Exception Other kind of error, depending on the implementation.
*/
Sequence* translate(const Sequence &sequence, size_t = 0) const;
/**
* @brief Translate a whole sequence from words alphabet to letters alphabet.
*
* @param sequence A sequence in words alphabet.
* @return The corresponding sequence in letters alphabet.
* @throw AlphabetMismatchException If the sequence alphabet do not match the target alphabet.
* @throw Exception Other kind of error, depending on the implementation.
*/
Sequence* reverse(const Sequence& sequence) const;
/** @} */
/**
* @name Overloaded AbstractAlphabet methods.
* @{
*/
unsigned int getStateCodingSize() const { return static_cast<unsigned int>(vAbsAlph_.size()); }
/** @} */
};
} // end of namespace bpp.
#endif // _WORDALPHABET_H_
|