The twenty-seven letter amino acid alphabet. More...
#include <seqan3/alphabet/aminoacid/aa27.hpp>
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | aa27 () noexcept=default |
Defaulted. | |
constexpr | aa27 (aa27 const &) noexcept=default |
Defaulted. | |
constexpr | aa27 (aa27 &&) noexcept=default |
Defaulted. | |
constexpr aa27 & | operator= (aa27 const &) noexcept=default |
Defaulted. | |
constexpr aa27 & | operator= (aa27 &&) noexcept=default |
Defaulted. | |
~aa27 () noexcept=default | |
Defaulted. | |
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 aa27 & | assign_char (char_type const c) noexcept |
Assign from a character, implicitly converts invalid characters. More... | |
constexpr aa27 & | 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 constexpr detail::min_viable_uint_t< size > | 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_as< 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()). | |
Static Protected Attributes | |
static constexpr std::array< rank_type, 256 > | char_to_rank |
Char to value conversion table. More... | |
static constexpr char_type | rank_to_char [alphabet_size] |
Value to char conversion table. More... | |
Related Functions | |
(Note that these are not member functions.) | |
using | aa27_vector = std::vector< aa27 > |
Alias for an std::vector of seqan3::aa27. | |
Literals | |
constexpr aa27 | operator""_aa27 (char const c) noexcept |
The seqan3::aa27 char literal. More... | |
aa27_vector | operator""_aa27 (const char *s, std::size_t n) |
The seqan3::aa27 string literal. More... | |
The twenty-seven letter amino acid alphabet.
The alphabet consists of letters A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, *
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::aa27::assign_char().
|
inlineconstexprnoexceptinherited |
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.
|
inlineconstexprnoexceptinherited |
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.
|
inlinestaticconstexprnoexceptinherited |
Validate whether a character value has a one-to-one mapping to an alphabet value.
Models the seqan3::semialphabet::char_is_valid_for() requirement via the seqan3::char_is_valid_for() wrapper.
Behaviour specific to amino acids: True also for lower case letters that silently convert to their upper case.
Constant.
Guaranteed not to throw.
|
inlineconstexprnoexceptinherited |
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.
|
inlineconstexprnoexceptinherited |
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 |
The seqan3::aa27 char literal.
[in] | c | The character to assign. |
|
related |
The seqan3::aa27 string literal.
[in] | s | A pointer to the character string to assign. |
[in] | n | The size of the character string to assign. |
You can use this string literal to easily assign to aa27_vector:
|
staticconstexprprotected |
Char to value conversion table.
|
staticconstexprprotected |
Value to char conversion table.