bpp-seq  2.2.0
RNY.h
Go to the documentation of this file.
1 //
2 // File: RNY.h
3 // Created by: Laurent Gueguen
4 // Created on: Tue Jul 31 2007
5 //
6 
7 /*
8  Copyright or © or Copr. CNRS, (November 17, 2004)
9 
10  This software is a computer program whose purpose is to provide classes
11  for sequences analysis.
12 
13  This software is governed by the CeCILL license under French law and
14  abiding by the rules of distribution of free software. You can use,
15  modify and/ or redistribute the software under the terms of the CeCILL
16  license as circulated by CEA, CNRS and INRIA at the following URL
17  "http://www.cecill.info".
18 
19  As a counterpart to the access to the source code and rights to copy,
20  modify and redistribute granted by the license, users are provided
21  only with a limited warranty and the software's author, the holder of
22  the economic rights, and the successive licensors have only limited
23  liability.
24 
25  In this respect, the user's attention is drawn to the risks associated
26  with loading, using, modifying and/or developing or reproducing the
27  software by the user in light of its specific status of free software,
28  that may mean that it is complicated to manipulate, and that also
29  therefore means that it is reserved for developers and experienced
30  professionals having in-depth computer knowledge. Users are therefore
31  encouraged to load and test the software's suitability as regards
32  their requirements in conditions enabling the security of their
33  systems and/or data to be ensured and, more generally, to use and
34  operate it in the same conditions as regards security.
35 
36  The fact that you are presently reading this means that you have had
37  knowledge of the CeCILL license and that you accept its terms.
38  */
39 
40 
41 #ifndef _RNY_H_
42 #define _RNY_H_
43 
44 #include "AbstractAlphabet.h"
45 #include "NucleicAlphabet.h"
46 
47 #include <string>
48 
63 namespace bpp
64 {
65 class RNY : public AbstractAlphabet
66 {
67 private:
69 
70 public:
71  RNY(const NucleicAlphabet&);
72 
73  RNY(const RNY& bia) : AbstractAlphabet(bia), nuclalph_(bia.nuclalph_) {}
74 
75  RNY& operator=(const RNY& bia)
76  {
78 // nuclalph_=bia.nuclalph_;
79  return *this;
80  }
81 
82  RNY* clone() const
83  {
84  return new RNY(*this);
85  }
86 
87  ~RNY() {}
88 
89 public:
90  int charToInt(const std::string& state) const throw (BadCharException);
91  std::string intToChar(int state) const throw (BadIntException);
92 
93  bool containsGap(const std::string& state) const throw (BadCharException);
94 
95  unsigned int getSize() const { return 36; }
96  unsigned int getNumberOfTypes() const { return 80; }
97  int getUnknownCharacterCode() const { return 350; }
98  bool isGap(int state) const;
99  std::vector<int > getAlias( int state) const throw (BadIntException);
100  std::vector<std::string> getAlias(const std::string& state) const throw (BadCharException);
101  bool isUnresolved(int state) const;
102  bool isUnresolved(const std::string& state) const;
103 
104  std::string getAlphabetType() const { return "RNY alphabet"; }
105 
106  const NucleicAlphabet& getLetterAlphabet() const;
107 
108 public:
119  std::string getRNY(const std::string&, const std::string&, const std::string&) const throw (BadCharException);
120 
121  int getRNY(int, int, int, const Alphabet&) const throw (BadCharException);
122 };
123 }
124 
125 #endif // _RNY_H_
126 
std::string getAlphabetType() const
Identification method.
Definition: RNY.h:104
RNY * clone() const
Definition: RNY.h:82
An alphabet exception thrown when trying to specify a bad char to the alphabet.
bool isGap(int state) const
Definition: RNY.cpp:411
RNY & operator=(const RNY &bia)
Definition: RNY.h:75
const NucleicAlphabet & getLetterAlphabet() const
Definition: RNY.cpp:273
Definition: RNY.h:65
This alphabet is used to deal NumericAlphabet.
The Alphabet interface.
Definition: Alphabet.h:130
const NucleicAlphabet & nuclalph_
Definition: RNY.h:68
AbstractAlphabet & operator=(const AbstractAlphabet &alph)
bool containsGap(const std::string &state) const
Definition: RNY.cpp:416
bool isUnresolved(int state) const
Definition: RNY.cpp:426
int getUnknownCharacterCode() const
Definition: RNY.h:97
RNY(const RNY &bia)
Definition: RNY.h:73
A partial implementation of the Alphabet interface.
std::string intToChar(int state) const
Give the string description of a state given its int description.
Definition: RNY.cpp:444
std::string getRNY(const std::string &, const std::string &, const std::string &) const
Get the char code for a triplet given the char code of the three underlying positions.
Definition: RNY.cpp:299
int charToInt(const std::string &state) const
Give the int description of a state given its string description.
Definition: RNY.cpp:433
std::vector< int > getAlias(int state) const
Get all resolved states that match a generic state.
Definition: RNY.cpp:189
RNY(const NucleicAlphabet &)
Definition: RNY.cpp:52
An alphabet exception thrown when trying to specify a bad int to the alphabet.
~RNY()
Definition: RNY.h:87
unsigned int getNumberOfTypes() const
Get the number of distinct states in alphabet (e.g. return 15 for DNA alphabet). This is the number o...
Definition: RNY.h:96
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&#39;ll need in most cases.
Definition: RNY.h:95
The abstract base class for nucleic alphabets.