SeqAn3 3.3.0-rc.1
The Modern C++ library for sequence analysis.
rna4.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2022, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2022, 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
24namespace seqan3
25{
26
48class rna4 : public nucleotide_base<rna4, 4>
49{
50private:
53
55 friend base_t;
58 friend base_t::base_t;
60
61public:
65 constexpr rna4() noexcept = default;
66 constexpr rna4(rna4 const &) noexcept = default;
67 constexpr rna4(rna4 &&) noexcept = default;
68 constexpr rna4 & operator=(rna4 const &) noexcept = default;
69 constexpr rna4 & operator=(rna4 &&) noexcept = default;
70 ~rna4() noexcept = default;
71
72 using base_t::base_t;
73
81 template <std::same_as<dna4> t>
82 constexpr rna4(t const & r) noexcept
83 {
84 assign_rank(r.to_rank());
85 }
87
88private:
90 static constexpr char_type rank_to_char_table[alphabet_size]{'A', 'C', 'G', 'U'};
91
93 static constexpr rank_type rank_complement(rank_type const rank)
94 {
96 }
97
99 static constexpr char_type rank_to_char(rank_type const rank)
100 {
101 return rank_to_char_table[rank];
102 }
103
105 static constexpr rank_type char_to_rank(char_type const chr)
106 {
107 return dna4::char_to_rank(chr);
108 }
109};
110
111// ------------------------------------------------------------------
112// containers
113// ------------------------------------------------------------------
114
121
122// ------------------------------------------------------------------
123// literals
124// ------------------------------------------------------------------
125inline namespace literals
126{
127
142constexpr rna4 operator""_rna4(char const c) noexcept
143{
144 return rna4{}.assign_char(c);
145}
146
156SEQAN3_WORKAROUND_LITERAL rna4_vector operator""_rna4(char const * s, std::size_t n)
157{
158 rna4_vector r;
159 r.resize(n);
160
161 for (size_t i = 0; i < n; ++i)
162 r[i].assign_char(s[i]);
163
164 return r;
165}
167
168} // namespace literals
169
170} // namespace seqan3
constexpr derived_type & assign_char(char_type const chr) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:163
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:199
constexpr rna4 & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:187
rank_type rank
The value of the alphabet letter is stored as the rank.
Definition: alphabet_base.hpp:261
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:156
static constexpr rank_type rank_complement(rank_type const rank)
Returns the complement by rank.
Definition: dna4.hpp:138
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:105
static constexpr char_type rank_to_char(rank_type const rank)
Returns the character representation of rank.
Definition: rna4.hpp:99
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:90
static constexpr rank_type rank_complement(rank_type const rank)
Returns the complement by rank.
Definition: rna4.hpp:93
friend base_t
Befriend seqan3::nucleotide_base.
Definition: rna4.hpp:55
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.
#define SEQAN3_WORKAROUND_LITERAL
Our char literals returning std::vector should be constexpr if constexpr std::vector is supported.
Definition: platform.hpp:248
T resize(T... args)