SeqAn3 3.2.0-rc.1
The Modern C++ library for sequence analysis.
rna5.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// rna5
22// ------------------------------------------------------------------
23
24namespace seqan3
25{
26
48class rna5 : public nucleotide_base<rna5, 5>
49{
50private:
53
55 friend base_t;
57 friend base_t::base_t;
59
60public:
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
80 template <std::same_as<dna5> t>
81 constexpr rna5(t const & r) noexcept
82 {
83 assign_rank(r.to_rank());
84 }
86
87private:
90 {
91 'A',
92 'C',
93 'G',
94 'N',
95 'U'
96 };
97
99 static constexpr rank_type rank_complement(rank_type const rank)
100 {
102 }
103
105 static constexpr char_type rank_to_char(rank_type const rank)
106 {
107 return rank_to_char_table[rank];
108 }
109
111 static constexpr rank_type char_to_rank(char_type const chr)
112 {
113 return dna5::char_to_rank(chr);
114 }
115};
116
117// ------------------------------------------------------------------
118// containers
119// ------------------------------------------------------------------
120
127
128
129// ------------------------------------------------------------------
130// literals
131// ------------------------------------------------------------------
132inline namespace literals
133{
134
149constexpr rna5 operator""_rna5(char const c) noexcept
150{
151 return rna5{}.assign_char(c);
152}
153
163inline rna5_vector operator""_rna5(char const * s, std::size_t n)
164{
165 rna5_vector r;
166 r.resize(n);
167
168 for (size_t i = 0; i < n; ++i)
169 r[i].assign_char(s[i]);
170
171 return r;
172}
174
175} // inline namespace literals
176
177} // namespace seqan3
static detail::min_viable_uint_t< size > constexpr alphabet_size
The size of the alphabet, i.e. the number of different values it can take.
Definition: alphabet_base.hpp:203
constexpr derived_type & assign_char(char_type const chr) noexcept
Assign from a character, implicitly converts invalid characters.
Definition: alphabet_base.hpp:165
constexpr rna5 & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:191
rank_type rank
The value of the alphabet letter is stored as the rank.
Definition: alphabet_base.hpp:265
The five letter DNA alphabet of A,C,G,T and the unknown character N..
Definition: dna5.hpp:51
static constexpr rank_type rank_complement(rank_type const rank)
Returns the complement by rank.
Definition: dna5.hpp:139
static constexpr rank_type char_to_rank(char_type const chr)
Returns the rank representation of character.
Definition: dna5.hpp:151
A CRTP-base that refines seqan3::alphabet_base and is used by the nucleotides.
Definition: nucleotide_base.hpp:43
alphabet_base< rna5, size, char > base_t
Type of the base class.
Definition: nucleotide_base.hpp:46
The five letter RNA alphabet of A,C,G,U and the unknown character N..
Definition: rna5.hpp:49
constexpr rna5() noexcept=default
Defaulted.
static constexpr rank_type char_to_rank(char_type const chr)
Returns the rank representation of character.
Definition: rna5.hpp:111
static constexpr char_type rank_to_char(rank_type const rank)
Returns the character representation of rank.
Definition: rna5.hpp:105
static constexpr char_type rank_to_char_table[alphabet_size]
The lookup table used in rank_to_char.
Definition: rna5.hpp:90
friend base_t
Befriend nucleotide_base.
Definition: rna5.hpp:55
static constexpr rank_type rank_complement(rank_type const rank)
Returns the complement by rank.
Definition: rna5.hpp:99
Provides seqan3::dna5, 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)