SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
rna4.hpp
Go to the documentation of this file.
1 // -----------------------------------------------------------------------------------------------------
2 // Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
3 // Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik
4 // This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5 // shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6 // -----------------------------------------------------------------------------------------------------
7 
13 #pragma once
14 
15 #include <vector>
16 
19 
20 // ------------------------------------------------------------------
21 // rna4
22 // ------------------------------------------------------------------
23 
24 namespace seqan3
25 {
26 
48 class rna4 : public nucleotide_base<rna4, 4>
49 {
50 private:
53 
55  friend base_t;
57  friend base_t::base_t;
59 
60 public:
64  constexpr rna4() noexcept = default;
65  constexpr rna4(rna4 const &) noexcept = default;
66  constexpr rna4(rna4 &&) noexcept = default;
67  constexpr rna4 & operator=(rna4 const &) noexcept = default;
68  constexpr rna4 & operator=(rna4 &&) noexcept = default;
69  ~rna4() noexcept = default;
70 
71  using base_t::base_t;
72 
74  constexpr rna4(dna4 const & r) noexcept
75 #if SEQAN3_WORKAROUND_GCC_90897
76  requires true
77 #endif
78  {
79  assign_rank(r.to_rank());
80  }
82 
83 private:
84 
87  {
88  'A',
89  'C',
90  'G',
91  'U'
92  };
93 
96 
98  static constexpr char_type rank_to_char(rank_type const rank)
99  {
100  return rank_to_char_table[rank];
101  }
102 
104  static constexpr rank_type char_to_rank(char_type const chr)
105  {
106  return dna4::char_to_rank(chr);
107  }
108 };
109 
110 // ------------------------------------------------------------------
111 // containers
112 // ------------------------------------------------------------------
113 
120 
121 // ------------------------------------------------------------------
122 // literals
123 // ------------------------------------------------------------------
124 inline namespace literals
125 {
126 
140 constexpr rna4 operator""_rna4(char const c) noexcept
141 {
142  return rna4{}.assign_char(c);
143 }
144 
154 inline rna4_vector operator""_rna4(char const * s, std::size_t n)
155 {
156  rna4_vector r;
157  r.resize(n);
158 
159  for (size_t i = 0; i < n; ++i)
160  r[i].assign_char(s[i]);
161 
162  return r;
163 }
165 
166 } // inline namespace literals
167 
168 // ------------------------------------------------------------------
169 // rna4 (deferred definition)
170 // ------------------------------------------------------------------
171 
173 {
174  'U'_rna4, // complement of 'A'_rna4
175  'G'_rna4, // complement of 'C'_rna4
176  'C'_rna4, // complement of 'G'_rna4
177  'A'_rna4 // complement of 'U'_rna4
178 };
179 
180 } // namespace seqan3
constexpr derived_type & assign_char(char_type const chr) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:211
static constexpr detail::min_viable_uint_t< size > alphabet_size
The size of the alphabet, i.e. the number of different values it can take.
Definition: alphabet_base.hpp:276
constexpr derived_type & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:264
rank_type rank
The value of the alphabet letter is stored as the rank.
Definition: alphabet_base.hpp:338
The four letter DNA alphabet of A,C,G,T.
Definition: dna4.hpp:53
static constexpr rank_type char_to_rank(char_type const chr)
Returns the rank representation of character.
Definition: dna4.hpp:170
A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides.
Definition: nucleotide_base.hpp:43
alphabet_base< rna4, size, char > base_t
Type of the base class.
Definition: nucleotide_base.hpp:46
The four letter RNA alphabet of A,C,G,U.
Definition: rna4.hpp:49
static constexpr rank_type char_to_rank(char_type const chr)
Returns the rank representation of character.
Definition: rna4.hpp:104
static constexpr char_type rank_to_char(rank_type const rank)
Returns the character representation of rank.
Definition: rna4.hpp:98
constexpr rna4() noexcept=default
Defaulted.
static constexpr char_type rank_to_char_table[alphabet_size]
The lookup table used in rank_to_char.
Definition: rna4.hpp:87
friend base_t
Befriend seqan3::nucleotide_base.
Definition: rna4.hpp:55
static const std::array< rna4, alphabet_size > complement_table
The complement table.
Definition: rna4.hpp:95
Provides seqan3::dna4, container aliases and string literals.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Provides seqan3::nucleotide_base.
T resize(T... args)