SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
rna5.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 // rna5
22 // ------------------------------------------------------------------
23 
24 namespace seqan3
25 {
26 
48 class rna5 : public nucleotide_base<rna5, 5>
49 {
50 private:
53 
55  friend base_t;
57  friend base_t::base_t;
59 
60 public:
64  constexpr rna5() noexcept = default;
65  constexpr rna5(rna5 const &) noexcept = default;
66  constexpr rna5(rna5 &&) noexcept = default;
67  constexpr rna5 & operator=(rna5 const &) noexcept = default;
68  constexpr rna5 & operator=(rna5 &&) noexcept = default;
69  ~rna5() noexcept = default;
70 
71  using base_t::base_t;
72 
77  constexpr rna5(dna5 const & r) noexcept
78 #if SEQAN3_WORKAROUND_GCC_90897
79  requires true
80 #endif
81  {
82  assign_rank(r.to_rank());
83  }
85 
86 private:
88  static constexpr char_type rank_to_char_table[alphabet_size]
89  {
90  'A',
91  'C',
92  'G',
93  'N',
94  'U'
95  };
96 
98  static const std::array<rna5, alphabet_size> complement_table;
99 
101  static constexpr char_type rank_to_char(rank_type const rank)
102  {
103  return rank_to_char_table[rank];
104  }
105 
107  static constexpr rank_type char_to_rank(char_type const chr)
108  {
109  return dna5::char_to_rank(chr);
110  }
111 };
112 
113 // ------------------------------------------------------------------
114 // containers
115 // ------------------------------------------------------------------
116 
123 
124 // ------------------------------------------------------------------
125 // literals
126 // ------------------------------------------------------------------
127 
138 constexpr rna5 operator""_rna5(char const c) noexcept
139 {
140  return rna5{}.assign_char(c);
141 }
142 
153 inline rna5_vector operator""_rna5(char const * s, std::size_t n)
154 {
155  rna5_vector r;
156  r.resize(n);
157 
158  for (size_t i = 0; i < n; ++i)
159  r[i].assign_char(s[i]);
160 
161  return r;
162 }
164 
165 // ------------------------------------------------------------------
166 // rna5 (deferred definition)
167 // ------------------------------------------------------------------
168 
169 constexpr std::array<rna5, rna5::alphabet_size> rna5::complement_table
170 {
171  'U'_rna5, // complement of 'A'_rna5
172  'G'_rna5, // complement of 'C'_rna5
173  'C'_rna5, // complement of 'G'_rna5
174  'N'_rna5, // complement of 'N'_rna5
175  'A'_rna5 // complement of 'U'_rna5
176 };
177 
178 } // namespace seqan3
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:81
detail::min_viable_uint_t< size - 1 > rank_type
The type of the alphabet when represented as a number (e.g. via to_rank()).
Definition: alphabet_base.hpp:104
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
std::conditional_t< std::same_as< char_t, void >, char, char_t > char_type
The char representation; conditional needed to make semi alphabet definitions legal.
Definition: alphabet_base.hpp:96
The five letter DNA alphabet of A,C,G,T and the unknown character N.
Definition: dna5.hpp:51
A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides.
Definition: nucleotide_base.hpp:43
The five letter RNA alphabet of A,C,G,U and the unknown character N.
Definition: rna5.hpp:49
constexpr rna5() noexcept=default
Defaulted.
Provides seqan3::dna5, container aliases and string literals.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Provides seqan3::nucleotide_base.
T resize(T... args)