The five letter DNA alphabet of A,C,G,T and the unknown character N. More...
#include <seqan3/alphabet/nucleotide/dna5.hpp>
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | dna5 () noexcept=default |
Defaulted. | |
constexpr | dna5 (dna5 const &) noexcept=default |
Defaulted. | |
constexpr | dna5 (dna5 &&) noexcept=default |
Defaulted. | |
constexpr dna5 & | operator= (dna5 const &) noexcept=default |
Defaulted. | |
constexpr dna5 & | operator= (dna5 &&) noexcept=default |
Defaulted. | |
~dna5 () noexcept=default | |
Defaulted. | |
template<std::Same< rna5 > t> | |
constexpr | dna5 (t const &r) noexcept |
Allow implicit construction from dna/rna of the same size. | |
Read functions | |
constexpr dna5 | 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 dna5 & | assign_char (char_type const c) noexcept |
Assign from a character, implicitly converts invalid characters. More... | |
constexpr dna5 & | assign_rank (rank_type const c) noexcept |
Assign from a numeric value. More... | |
Static Public Member Functions | |
static constexpr bool | char_is_valid (char_type const c) noexcept |
Validate whether a character value has a one-to-one mapping to an alphabet value. More... | |
Static Public Attributes | |
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. | |
Protected Types | |
Member types | |
using | char_type = std::conditional_t< std::Same< char, void >, char, char > |
The char representation; conditional needed to make semi alphabet definitions legal. | |
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()). | |
Related Functions | |
(Note that these are not member functions.) | |
using | dna5_vector = std::vector< dna5 > |
Alias for an std::vector of seqan3::dna5. More... | |
Literals | |
constexpr dna5 | operator""_dna5 (char const c) noexcept |
The seqan3::dna5 char literal. More... | |
dna5_vector | operator""_dna5 (char const *s, std::size_t n) |
The seqan3::dna5 string literal. 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... | |
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::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... | |
The five letter DNA alphabet of A,C,G,T and the unknown character N.
Note that you can assign 'U' as a character to dna5 and it will silently be converted to 'T'.
Like most alphabets, this alphabet cannot be initialised directly from its character representation. Instead initialise/assign from the character literal or use the function seqan3::dna5::assign_char().
|
inlinenoexceptinherited |
Assign from a character, implicitly converts invalid characters.
c | The character to be assigned. |
Provides an implementation for seqan3::assign_char_to, required to model seqan3::Alphabet.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Assign from a numeric value.
c | The rank to be assigned. |
Provides an implementation for seqan3::assign_rank_to, required to model seqan3::Semialphabet.
Constant.
Guaranteed not to throw.
|
inlinestaticnoexceptinherited |
Validate whether a character value has a one-to-one mapping to an alphabet value.
Satisfies the seqan3::Semialphabet::char_is_valid_for() requirement via the seqan3::char_is_valid_for() wrapper.
Behaviour specific to nucleotides: True also for lower case letters that silently convert to their upper case and true also for U/T respectively, e.g. 'U' is a valid character for seqan3::dna4, because its informational content is identical to 'T'.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Return the complement of the letter.
See Nucleotide for the actual values.
Provides an implementation for seqan3::complement, required to model seqan3::NucleotideAlphabet.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Return the letter as a character of char_type.
Provides an implementation for seqan3::to_char, required to model seqan3::Alphabet.
Constant.
Guaranteed not to throw.
|
inlinenoexceptinherited |
Return the letter's numeric value (rank in the alphabet).
Provides an implementation for seqan3::to_rank, required to model seqan3::Semialphabet.
Constant.
Guaranteed not to throw.
|
related |
Alias for an std::vector of seqan3::dna5.
|
related |
The seqan3::dna5 char literal.
|
related |
The seqan3::dna5 string literal.
You can use this string literal to easily assign to dna5_vector: