The five letter RNA alphabet of A,C,G,U and the unknown character N. More...
#include <seqan3/alphabet/nucleotide/rna5.hpp>
Public Types | |
using | char_type = char_t |
The type of the alphabet when converted to char (e.g. via to_char()). | |
using | rank_type = detail::min_viable_uint_t< size - 1 > |
The type of the alphabet when represented as a number (e.g. via to_rank()). | |
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | rna5 () noexcept |
constexpr | rna5 (rna5 const &)=default |
constexpr | rna5 (rna5 &&)=default |
constexpr rna5 & | operator= (rna5 const &)=default |
constexpr rna5 & | operator= (rna5 &&)=default |
~rna5 ()=default | |
constexpr | rna5 (dna5 const &r) noexcept |
Allow implicit construction from dna/rna of the same size. | |
Read functions | |
constexpr rna5 | complement () const noexcept |
Return the complement of the letter. More... | |
Read functions | |
constexpr char_type | to_char () const noexcept |
Return the letter as a character of char_type. More... | |
constexpr rank_type | to_rank () const noexcept |
Return the letter's numeric value (rank in the alphabet). More... | |
Write functions | |
constexpr rna5 & | assign_char (std::conditional_t< std::Same< char_type, void >, char, char_type > const c) noexcept |
Assign from a character. More... | |
constexpr rna5 & | assign_rank (rank_type const c) noexcept |
Assign from a numeric value. More... | |
Static Public Attributes | |
static detail::min_viable_uint_t< size > constexpr | value_size |
The size of the alphabet, i.e. the number of different values it can take. | |
Related Functions | |
(Note that these are not member functions.) | |
using | rna5_vector = std::vector< rna5 > |
Alias for an std::vector of seqan3::rna5. More... | |
Literals | |
constexpr rna5 | operator""_rna5 (char const c) noexcept |
The seqan3::rna5 char literal. More... | |
rna5_vector | operator""_rna5 (char const *s, std::size_t n) |
The seqan3::rna5 string literal. More... | |
Requirements for seqan3::nucleotide_concept | |
You can expect these functions on all types that implement seqan3::nucleotide_concept. | |
nucleotide_type | complement (nucleotide_type const alph) |
Returns the alphabet letter's complement value. More... | |
Requirements for seqan3::alphabet_concept | |
You can expect these functions on all types that implement seqan3::alphabet_concept. | |
template<typename alphabet_type > | |
using | underlying_char_t = typename underlying_char< alphabet_type >::type |
The char_type of the alphabet. [type metafunction shortcut]. More... | |
char_type | to_char (alphabet_concept const alph) |
Returns the alphabet letter's value in character representation. More... | |
alphabet_concept && | assign_char (alphabet_concept &&alph, char_type const chr) |
Returns the alphabet letter's value in character representation. More... | |
Requirements for seqan3::semi_alphabet_concept | |
You can expect these functions on all types that implement seqan3::semi_alphabet_concept. | |
template<typename semi_alphabet_type > | |
using | underlying_rank_t = typename underlying_rank< semi_alphabet_type >::type |
The rank_type of the semi_alphabet. [type metafunction shortcut]. More... | |
template<typename alphabet_type > | |
constexpr auto | alphabet_size_v = alphabet_size<alphabet_type>::value |
The size of the alphabet. [value metafunction shortcut]. More... | |
rank_type | to_rank (semi_alphabet_concept const alph) |
Returns the alphabet letter's value in rank representation. More... | |
semi_alphabet_concept && | assign_rank (semi_alphabet_concept &&alph, rank_type const rank) |
Returns the alphabet letter's value in rank representation. More... | |
Requirements for std::Swappable | |
You can expect these functions on all types that implement std::Swappable. | |
void | swap (t &lhs, t &rhs) |
Swaps the contents of two objects. More... | |
Requirements for std::EqualityComparable | |
You can expect these functions on all types that implement std::Equality_comparable. | |
bool | operator== (type const &lhs, type const &rhs) |
(In-)Equality comparison. More... | |
bool | operator!= (type const &lhs, type const &rhs) |
(In-)Equality comparison. More... | |
Requirements for std::StrictTotallyOrdered | |
You can expect these functions on all types that implement std::StrictTotallyOrdered. | |
bool | operator< (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
bool | operator<= (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
bool | operator> (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
bool | operator>= (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
The five letter RNA alphabet of A,C,G,U and the unknown character N.
This alphabet has the same internal representation as seqan3::dna5, the only difference is that it prints 'U' on character conversion instead of 'T'. You can assign between values of seqan3::dna5 and seqan3::rna5.
The alphabet may be brace initialized from the static letter members. Note that you cannot assign the alphabet by using letters of type char
, but you instead have to use the function seqan3::rna5::assign_char().
|
inlinenoexceptinherited |
Assign from a character.
Satisfies the seqan3::alphabet_concept::assign_char() requirement via the seqan3::assign_char() wrapper.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Assign from a numeric value.
Satisfies the seqan3::semi_alphabet_concept::assign_rank() requirement via the seqan3::assign_rank() wrapper.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Return the complement of the letter.
See Nucleotide for the actual values.
Satisfies the seqan3::nucleotide_concept::complement() requirement via the seqan3::complement() wrapper.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Return the letter as a character of char_type.
Satisfies the seqan3::alphabet_concept::to_char() requirement via the seqan3::to_char() wrapper.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Return the letter's numeric value (rank in the alphabet).
Satisfies the seqan3::semi_alphabet_concept::to_rank() requirement via the to_rank() wrapper.
Constant.
Guaranteed not to throw.
|
related |
Returns the alphabet letter's complement value.
alph | The alphabet letter for whom you wish to receive the complement. |
|
related |
The seqan3::rna5 char literal.
|
related |
The seqan3::rna5 string literal.
You can use this string literal to easily assign to rna5_vector:
|
related |
Alias for an std::vector of seqan3::rna5.