Implementation of a masked composition, which extends a given alphabet with a mask. More...
#include <seqan3/alphabet/mask/masked.hpp>
Public Types | |
using | char_type = underlying_char_t< sequence_alphabet_type > |
Equals the char_type of sequence_alphabet_type. | |
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()). | |
using | sequence_alphabet_type = sequence_alphabet_t |
First template parameter as member type. | |
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | masked () |
constexpr | masked (masked const &)=default |
constexpr | masked (masked &&)=default |
constexpr masked & | operator= (masked const &)=default |
constexpr masked & | operator= (masked &&)=default |
~masked ()=default | |
constexpr | masked (component_type const alph) |
Construction via a value of one of the components. More... | |
constexpr | masked (indirect_component_type const alph) |
Construction via a value of a subtype that is assignable to one of the components. More... | |
constexpr masked & | operator= (component_type const alph) |
Assignment via a value of one of the components. More... | |
constexpr masked & | operator= (indirect_component_type const alph) |
Assignment via a value of a subtype that is assignable to one of the components. More... | |
Write functions | |
constexpr masked & | assign_char (char_type const c) |
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 |
Implicit cast to a single letter. Works only if the type is unique in the type list. | |
Comparison operators (against indirect component_list) | |
| |
constexpr bool | operator== (indirect_component_type const &rhs) const noexcept |
constexpr bool | operator!= (indirect_component_type const &rhs) const noexcept |
constexpr bool | operator< (indirect_component_type const &rhs) const noexcept |
constexpr bool | operator> (indirect_component_type const &rhs) const noexcept |
constexpr bool | operator<= (indirect_component_type const &rhs) const noexcept |
constexpr bool | operator>= (indirect_component_type const &rhs) const noexcept |
Read functions | |
constexpr rank_type | to_rank () const noexcept |
Return the letter's numeric value (rank in the alphabet). More... | |
Write functions | |
constexpr derived_type & | assign_rank (rank_type const c) noexcept |
Assign from a numeric value. More... | |
constexpr derived_type & | assign_char (std::conditional_t< std::Same< char_type, void >, char, char_type > const c) noexcept |
Assign from a character. More... | |
Static Public Attributes | |
static detail::min_viable_uint_t< size > constexpr | value_size = 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.) | |
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. 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... | |
Comparison operators | |
Free function (in-)equality comparison operators that forward to member operators (for types != self). | |
constexpr bool | operator== (indirect_component_type const &lhs, cartesian_composition< masked< sequence_alphabet_t >, component_types... > const &rhs) |
constexpr bool | operator!= (indirect_component_type const &lhs, cartesian_composition< masked< sequence_alphabet_t >, indirect_component_types... > const &rhs) |
constexpr bool | operator< (indirect_component_type const &lhs, cartesian_composition< masked< sequence_alphabet_t >, indirect_component_types... > const &rhs) |
constexpr bool | operator> (indirect_component_type const &lhs, cartesian_composition< masked< sequence_alphabet_t >, indirect_component_types... > const &rhs) |
constexpr bool | operator<= (indirect_component_type const &lhs, cartesian_composition< masked< sequence_alphabet_t >, indirect_component_types... > const &rhs) |
constexpr bool | operator>= (indirect_component_type const &lhs, cartesian_composition< masked< sequence_alphabet_t >, indirect_component_types... > const &rhs) |
Implementation of a masked composition, which extends a given alphabet with a mask.
sequence_alphabet_t | Type of the first letter; must satisfy seqan3::semi_alphabet_concept. |
mask_t | Types of masked letter; must satisfy seqan3::semi_alphabet_concept, defaults to seqan3::mask. |
The masked composition represents a seqan3::cartesian_composition 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.
|
inline |
Construction via a value of one of the components.
component_type | Must be one uniquely contained in the type list of the composition. |
alph | The value of a component that should be assigned. |
Note: Since the cartesian_composition is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
inline |
Construction via a value of a subtype that is assignable to one of the components.
indirect_component_type | Type that models the seqan3::is_assignable_concept for one of the component types. |
alph | The value that should be assigned. |
Note that the value will be assigned to the FIRST type T that fulfils the assignable_concept<T, indirect_component_type>
, regardless if other types are also fit for assignment.
Note: Since the cartesian_composition is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
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.
|
inline |
Assignment via a value of one of the components.
component_type | One of the component types. Must be uniquely contained in the type list of the composition. |
alph | The value of a component that should be assigned. |
Note: Since the cartesian_composition is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
inline |
Assignment via a value of a subtype that is assignable to one of the components.
indirect_component_type | Type that models the seqan3::is_assignable_concept for one of the component types. |
alph | The value of a component that should be assigned. |
Note: Since the cartesian_composition is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
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 |
Type deduction guide enables usage of masked without specifying template args.