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-2021, Knut Reinert & Freie Universität Berlin
3 // Copyright (c) 2016-2021, 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 
80  template <std::same_as<dna4> t>
81  constexpr rna4(t const & r) noexcept
82 #if SEQAN3_WORKAROUND_GCC_90897
83  requires true
84 #endif
85  {
86  assign_rank(r.to_rank());
87  }
89 
90 private:
91 
93  static constexpr char_type rank_to_char_table[alphabet_size]
94  {
95  'A',
96  'C',
97  'G',
98  'U'
99  };
100 
102  static constexpr rank_type rank_complement(rank_type const rank)
103  {
104  return dna4::rank_complement(rank);
105  }
106 
108  static constexpr char_type rank_to_char(rank_type const rank)
109  {
110  return rank_to_char_table[rank];
111  }
112 
114  static constexpr rank_type char_to_rank(char_type const chr)
115  {
116  return dna4::char_to_rank(chr);
117  }
118 };
119 
120 // ------------------------------------------------------------------
121 // containers
122 // ------------------------------------------------------------------
123 
130 
131 // ------------------------------------------------------------------
132 // literals
133 // ------------------------------------------------------------------
134 inline namespace literals
135 {
136 
151 constexpr rna4 operator""_rna4(char const c) noexcept
152 {
153  return rna4{}.assign_char(c);
154 }
155 
165 inline rna4_vector operator""_rna4(char const * s, std::size_t n)
166 {
167  rna4_vector r;
168  r.resize(n);
169 
170  for (size_t i = 0; i < n; ++i)
171  r[i].assign_char(s[i]);
172 
173  return r;
174 }
176 
177 } // inline namespace literals
178 
179 } // 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 four letter DNA alphabet of A,C,G,T.
Definition: dna4.hpp:53
A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides.
Definition: nucleotide_base.hpp:57
The four letter RNA alphabet of A,C,G,U.
Definition: rna4.hpp:49
constexpr rna4() noexcept=default
Defaulted.
Provides seqan3::dna4, container aliases and string literals.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
SeqAn specific customisations in the standard namespace.
Provides seqan3::nucleotide_base.
T resize(T... args)