Implementation of a masked composite, which extends a given alphabet with a mask. More...
#include <seqan3/alphabet/mask/masked.hpp>
Public Types | |
using | char_type = alphabet_char_t< sequence_alphabet_type > |
Equals the char_type of sequence_alphabet_type. | |
using | sequence_alphabet_type = sequence_alphabet_t |
First template parameter as member type. | |
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | masked ()=default |
Defaulted. | |
constexpr | masked (masked const &)=default |
Defaulted. | |
constexpr | masked (masked &&)=default |
Defaulted. | |
constexpr masked & | operator= (masked const &)=default |
Defaulted. | |
constexpr masked & | operator= (masked &&)=default |
Defaulted. | |
~masked ()=default | |
Defaulted. | |
Write functions | |
constexpr masked & | assign_char (char_type const c) noexcept |
Assign from a character. | |
Read functions | |
constexpr char_type | to_char () const noexcept |
Return a character. | |
Read functions | |
All read operations are constant complexity. | |
constexpr | operator type () const noexcept |
Implicit cast to a single letter. Works only if the type is unique in the type list. | |
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 masked< sequence_alphabet_t > & | assign_char (char_type const c) noexcept |
Assign from a character, implicitly converts invalid characters. More... | |
constexpr masked< sequence_alphabet_t > & | assign_rank (rank_type const c) noexcept |
Assign from a numeric 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 | 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, detail::size_in_values_v< char_type > > | char_to_rank |
Char to rank conversion table. More... | |
static constexpr std::array< char_type, alphabet_size > | rank_to_char |
Rank to char conversion table. More... | |
Related Functions | |
(Note that these are not member functions.) | |
template<typename sequence_alphabet_type > | |
masked (sequence_alphabet_type &&, mask const &) -> masked< std::decay_t< sequence_alphabet_type >> | |
Type deduction guide enables usage of masked without specifying template args. | |
Implementation of a masked composite, which extends a given alphabet with a mask.
sequence_alphabet_t | Type of the first letter; must satisfy seqan3::writable_alphabet and std::regular. |
The masked composite represents a seqan3::alphabet_tuple_base of any given alphabet with the masked alphabet. It allows one to specify which portions of a sequence should be masked, without losing additional information by replacing the sequence directly.
|
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.
|
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.
|
staticconstexprprotected |
Char to rank conversion table.
|
staticconstexprprotected |
Rank to char conversion table.