SeqAn3 3.4.0-rc.4
The Modern C++ library for sequence analysis.
|
A combined alphabet that can hold values of either of its alternatives.. More...
#include <seqan3/alphabet/composite/alphabet_variant.hpp>
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | alphabet_variant () noexcept=default |
Defaulted. | |
constexpr | alphabet_variant (alphabet_variant const &) noexcept=default |
Defaulted. | |
constexpr | alphabet_variant (alphabet_variant &&) noexcept=default |
Defaulted. | |
constexpr alphabet_variant & | operator= (alphabet_variant const &) noexcept=default |
Defaulted. | |
constexpr alphabet_variant & | operator= (alphabet_variant &&) noexcept=default |
Defaulted. | |
~alphabet_variant () noexcept=default | |
Defaulted. | |
template<typename alternative_t > requires (!std::same_as<alternative_t, alphabet_variant>) && (!detail::is_span<alternative_t>::value) && (!std::is_base_of_v<alphabet_variant, alternative_t>) && (!list_traits::contains< alphabet_variant, detail::transformation_trait_or_t<detail::recursive_required_types<alternative_t>, type_list<>>>) && (is_alternative<alternative_t>()) | |
constexpr | alphabet_variant (alternative_t const alternative) noexcept |
Construction via the value of an alternative. | |
template<typename indirect_alternative_t > requires (!detail::is_span<indirect_alternative_t>::value) && (( detail::instantiate_if_v<detail::lazy<std::is_convertible, indirect_alternative_t, alternative_types>, detail::variant_general_guard<indirect_alternative_t, alternative_types...>> || ...)) | |
constexpr | alphabet_variant (indirect_alternative_t const rhs) noexcept |
Constructor for arguments implicitly convertible to an alternative. | |
template<typename indirect_alternative_t > requires ( (!(detail::instantiate_if_v<detail::lazy<std::is_convertible, indirect_alternative_t, alternative_types>, detail::variant_general_guard<indirect_alternative_t, alternative_types...>> || ...)) && (detail::instantiate_if_v<detail::lazy<std::is_constructible, alternative_types, indirect_alternative_t>, detail::variant_general_guard<indirect_alternative_t, alternative_types...>> || ...)) | |
constexpr | alphabet_variant (indirect_alternative_t const rhs) noexcept |
Constructor for arguments explicitly (but not implicitly) convertible to an alternative. | |
template<typename indirect_alternative_t > requires (detail::variant_general_guard<indirect_alternative_t, alternative_types...> && (weakly_assignable_from<alternative_types, indirect_alternative_t> || ...)) | |
constexpr alphabet_variant & | operator= (indirect_alternative_t const &rhs) noexcept |
Assignment for arguments assignable to an alternative. | |
Conversion (by index) | |
template<size_t index> | |
constexpr bool | holds_alternative () const noexcept |
Whether the variant alphabet currently holds a value of the given alternative. | |
template<size_t index> | |
constexpr auto | convert_to () const |
Convert to the specified alphabet (throws if holds_alternative() would be false). | |
template<size_t index> | |
constexpr auto | convert_unsafely_to () const noexcept |
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false). | |
Conversion (by type) | |
template<typename alternative_t > requires (is_alternative<alternative_t>()) | |
constexpr bool | holds_alternative () const noexcept |
Whether the variant alphabet currently holds a value of the given alternative. | |
template<typename alternative_t > requires (is_alternative<alternative_t>()) | |
constexpr alternative_t | convert_to () const |
Convert to the specified alphabet (throws if holds_alternative() would be false). | |
template<typename alternative_t > requires (is_alternative<alternative_t>()) | |
constexpr alternative_t | convert_unsafely_to () const noexcept |
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false). | |
![]() | |
constexpr | alphabet_base () noexcept=default |
Defaulted. | |
constexpr | alphabet_base (alphabet_base const &) noexcept=default |
Defaulted. | |
constexpr | alphabet_base (alphabet_base &&) noexcept=default |
Defaulted. | |
constexpr alphabet_base & | operator= (alphabet_base const &) noexcept=default |
Defaulted. | |
constexpr alphabet_base & | operator= (alphabet_base &&) noexcept=default |
Defaulted. | |
~alphabet_base () noexcept=default | |
Defaulted. | |
constexpr char_type | to_char () const noexcept |
Return the letter as a character of char_type. | |
constexpr rank_type | to_rank () const noexcept |
Return the letter's numeric value (rank in the alphabet). | |
constexpr alphabet_variant< alternative_types... > & | assign_char (char_type const chr) noexcept |
Assign from a character, implicitly converts invalid characters. | |
constexpr alphabet_variant< alternative_types... > & | assign_rank (rank_type const c) noexcept |
Assign from a numeric value. | |
Static Public Member Functions | |
static constexpr bool | char_is_valid (char_type const chr) noexcept |
Validate whether a character is valid in the combined alphabet. | |
template<typename alternative_t > | |
static constexpr bool | is_alternative () noexcept |
Returns true if alternative_t is one of the given alternative types. | |
Friends | |
Comparison operators (against indirect alternatives) | |
Defines comparison against types that are not subject to implicit construction/conversion but are comparable against alternatives, e.g. | |
template<typename alphabet_variant_t , typename indirect_alternative_type > requires (!detail::is_span<alphabet_variant_t>::value) && (detail::variant_comparison_guard<alphabet_variant_t, indirect_alternative_type, false, alternative_types...>) | |
constexpr bool | operator== (alphabet_variant_t const lhs, indirect_alternative_type const rhs) noexcept |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant. | |
template<typename alphabet_variant_t , typename indirect_alternative_type > requires (!detail::is_span<alphabet_variant_t>::value) && (detail::variant_comparison_guard<alphabet_variant_t, indirect_alternative_type, false, alternative_types...>) | |
constexpr bool | operator!= (alphabet_variant_t const lhs, indirect_alternative_type const rhs) noexcept |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant. | |
template<typename alphabet_variant_t , typename indirect_alternative_type , typename = void> requires (!detail::is_span<alphabet_variant_t>::value) && (detail::variant_comparison_guard<alphabet_variant_t, indirect_alternative_type, true, alternative_types...>) | |
constexpr bool | operator== (indirect_alternative_type const lhs, alphabet_variant_t const rhs) noexcept |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant. | |
template<typename alphabet_variant_t , typename indirect_alternative_type , typename = void> requires (!detail::is_span<alphabet_variant_t>::value) && (detail::variant_comparison_guard<alphabet_variant_t, indirect_alternative_type, true, alternative_types...>) | |
constexpr bool | operator!= (indirect_alternative_type const lhs, alphabet_variant_t const rhs) noexcept |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant. | |
Comparison operators |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
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()). | |
A combined alphabet that can hold values of either of its alternatives.
.
...alternative_types | Types of possible values (at least 2); all must model seqan3::writable_alphabet, std::regular and must be unique; all required functions for seqan3::writable_alphabet need to be callable in a constexpr -context. |
The alphabet_variant represents the union of two or more alternative alphabets (e.g. the four letter DNA alternative + the gap alternative). It behaves similar to a variant or std::variant, but it preserves the seqan3::alphabet.
Short description:
char
representation of an alphabet_variantPart of the seqan3::alphabet concept requires that the alphabet_variant provides a char representation in addition to the rank representation. For an object of seqan3::alphabet_variant, the to_char()
member function will always return the same character as if invoked on the respective alternative. In contrast, the assign_char()
member function might be ambiguous between the alternative alphabets in a variant.
For example, assigning a '!' to seqan3::dna15 resolves to an object of rank 8 with char representation 'N' while assigning '!' to seqan3::gap always resolves to rank 0, the gap symbol itself ('-'_gap). We tackle this ambiguousness by defaulting unknown characters to the representation of the first alternative (e.g. ‘alphabet_variant<dna15, gap>{}.assign_char(’!')resolves to rank 8, representing
N`_dna15).
On the other hand, two alternative alphabets might have the same char representation (e.g if you combine dna4 with dna5, 'A', 'C', 'G' and 'T' are ambiguous). We tackle this ambiguousness by always choosing the first valid char representation (e.g. ‘alphabet_variant<dna4, dna5>{}.assign_char('A’)resolves to rank 0, representing an
A`_dna4).
To explicitly assign via the character representation of a specific alphabet, assign to that type first and then assign to the variant, e.g.
|
inlineconstexprnoexcept |
Construction via the value of an alternative.
alternative_t | One of the alternative types. |
alternative | The value of a alternative that should be assigned. |
|
inlineconstexprnoexcept |
Constructor for arguments implicitly convertible to an alternative.
indirect_alternative_t | A type that is implicitly convertible to an alternative type. |
rhs | The value that should be assigned. |
This constructor is preferred over the explicit version.
{}
considers implicit and explicit conversions.=
considers only implicit conversions (but that is sufficient here).
|
inlineexplicitconstexprnoexcept |
Constructor for arguments explicitly (but not implicitly) convertible to an alternative.
indirect_alternative_t | A type that is explicitly (but not implicitly) convertible to an alternative type. |
rhs | The value that should be assigned. |
{}
considers implicit and explicit conversions so this works.=
considers only implicit conversions so it does not work.
|
inlinestaticconstexprnoexcept |
Validate whether a character is valid in the combined alphabet.
|
inlineconstexpr |
Convert to the specified alphabet (throws if holds_alternative() would be false).
index | Index of the alternative to check for. |
std::bad_variant_access | If the variant_alphabet currently holds the value of a different alternative. |
|
inlineconstexpr |
Convert to the specified alphabet (throws if holds_alternative() would be false).
alternative_t | The type of the alternative that you wish to check for. |
std::bad_variant_access | If the variant_alphabet currently holds the value of a different alternative. |
|
inlineconstexprnoexcept |
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false).
index | Index of the alternative to check for. |
|
inlineconstexprnoexcept |
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false).
alternative_t | The type of the alternative that you wish to check for. |
|
inlineconstexprnoexcept |
Whether the variant alphabet currently holds a value of the given alternative.
index | Index of the alternative to check for. |
|
inlineconstexprnoexcept |
Whether the variant alphabet currently holds a value of the given alternative.
alternative_t | The type of the alternative that you wish to check for. |
|
inlinestaticconstexprnoexcept |
Returns true if alternative_t is one of the given alternative types.
alternative_t | The type to check. |
|
inlineconstexprnoexcept |
Assignment for arguments assignable to an alternative.
indirect_alternative_t | A type that one of the alternatives is assignable from. |
rhs | The value of an alternative. |
Most assignments happen through implicit conversion and the default assignment operator. This assignment operator is for the rest.
|
friend |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant.
alphabet_variant_t | The type of the variant; given as template parameter to prevent conversion. |
indirect_alternative_type | Must be comparable with an alternative's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality, it is first deduced which alternative the argument is comparable with. It is then checked if the variant currently is in that alternative's state and if yes whether the values compare to true
; else false
is returned.
|
friend |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant.
alphabet_variant_t | The type of the variant; given as template parameter to prevent conversion. |
indirect_alternative_type | Must be comparable with an alternative's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality, it is first deduced which alternative the argument is comparable with. It is then checked if the variant currently is in that alternative's state and if yes whether the values compare to true
; else false
is returned.
|
friend |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant.
alphabet_variant_t | The type of the variant; given as template parameter to prevent conversion. |
indirect_alternative_type | Must be comparable with an alternative's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality, it is first deduced which alternative the argument is comparable with. It is then checked if the variant currently is in that alternative's state and if yes whether the values compare to true
; else false
is returned.
|
friend |
(In-)Equality comparison against types comparable with alternatives but not convertible to the variant.
alphabet_variant_t | The type of the variant; given as template parameter to prevent conversion. |
indirect_alternative_type | Must be comparable with an alternative's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality, it is first deduced which alternative the argument is comparable with. It is then checked if the variant currently is in that alternative's state and if yes whether the values compare to true
; else false
is returned.