SeqAn3  3.0.2
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 
46 class rna5 : public nucleotide_base<rna5, 5>
47 {
48 private:
51 
53  friend base_t;
55  friend base_t::base_t;
57 
58 public:
62  constexpr rna5() noexcept = default;
63  constexpr rna5(rna5 const &) noexcept = default;
64  constexpr rna5(rna5 &&) noexcept = default;
65  constexpr rna5 & operator=(rna5 const &) noexcept = default;
66  constexpr rna5 & operator=(rna5 &&) noexcept = default;
67  ~rna5() noexcept = default;
68 
69  using base_t::base_t;
70 
72  constexpr rna5(dna5 const & r) noexcept
73 #if SEQAN3_WORKAROUND_GCC_90897
74  requires true
75 #endif
76  {
77  assign_rank(r.to_rank());
78  }
80 
81 protected:
83 
85  static constexpr char_type rank_to_char[alphabet_size]
86  {
87  'A',
88  'C',
89  'G',
90  'N',
91  'U'
92  };
93 
95  static constexpr std::array<rank_type, 256> char_to_rank = dna5::char_to_rank;
96 
98  static const std::array<rna5, alphabet_size> complement_table;
99 };
100 
101 // ------------------------------------------------------------------
102 // containers
103 // ------------------------------------------------------------------
104 
108 
109 // ------------------------------------------------------------------
110 // literals
111 // ------------------------------------------------------------------
112 
121 constexpr rna5 operator""_rna5(char const c) noexcept
122 {
123  return rna5{}.assign_char(c);
124 }
125 
135 inline rna5_vector operator""_rna5(char const * s, std::size_t n)
136 {
137  rna5_vector r;
138  r.resize(n);
139 
140  for (size_t i = 0; i < n; ++i)
141  r[i].assign_char(s[i]);
142 
143  return r;
144 }
146 
147 // ------------------------------------------------------------------
148 // rna5 (deferred definition)
149 // ------------------------------------------------------------------
150 
151 constexpr std::array<rna5, rna5::alphabet_size> rna5::complement_table
152 {
153  'U'_rna5, // complement of 'A'_rna5
154  'G'_rna5, // complement of 'C'_rna5
155  'C'_rna5, // complement of 'G'_rna5
156  'N'_rna5, // complement of 'N'_rna5
157  'A'_rna5 // complement of 'U'_rna5
158 };
159 
160 } // namespace seqan3
std::vector::resize
T resize(T... args)
seqan3::alphabet_base< rna5, size, char >::alphabet_size
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:176
vector
seqan3::alphabet_base< rna5, size, char >
seqan3::nucleotide_base
A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides.
Definition: nucleotide_base.hpp:41
seqan3::alphabet_base::assign_char
constexpr derived_type & assign_char(char_type const c) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:142
dna5.hpp
Provides seqan3::dna5, container aliases and string literals.
std::array< rank_type, 256 >
seqan3
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
seqan3::rna5
The five letter RNA alphabet of A,C,G,U and the unknown character N.
Definition: rna5.hpp:47
nucleotide_base.hpp
Provides seqan3::nucleotide_base.
seqan3::rna5::rna5
constexpr rna5() noexcept=default
Defaulted.
seqan3::alphabet_base< rna5, size, char >::char_type
std::conditional_t< std::same_as< char, void >, char, char > char_type
The char representation; conditional needed to make semi alphabet definitions legal.
Definition: alphabet_base.hpp:62
seqan3::alphabet_base< rna5, size, char >::assign_rank
constexpr rna5 & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:167
std::size_t
seqan3::dna5
The five letter DNA alphabet of A,C,G,T and the unknown character N.
Definition: dna5.hpp:49