28namespace seqan3::detail
31#if SEQAN3_WORKAROUND_GCC7_AND_8_CONCEPT_ISSUES
33SEQAN3_CONCEPT variant_guard_pseudoalphabet =
requires {
requires seqan3::alphabet_size<t> > 0; };
37template <
typename other_t,
typename ... alternative_types>
38inline constexpr bool variant_general_guard =
39 (!std::same_as<other_t, alphabet_variant<alternative_types...>>) &&
41 (!(std::same_as<other_t, alternative_types> || ...)) &&
43#if SEQAN3_WORKAROUND_GCC7_AND_8_CONCEPT_ISSUES
44 && variant_guard_pseudoalphabet<other_t>
49template <
typename lhs_t,
typename rhs_t,
bool lhs_rhs_switched,
typename ... alternative_types>
50inline constexpr bool variant_comparison_guard =
51 (instantiate_if_v<lazy<weakly_equality_comparable_with_trait, rhs_t, alternative_types>,
52 (std::same_as<lhs_t, alphabet_variant<alternative_types...>>) &&
53 (variant_general_guard<rhs_t, alternative_types...>) &&
54 !(lhs_rhs_switched && is_type_specialisation_of_v<rhs_t, alphabet_variant>)
120template <
typename ...alternative_types>
122 requires (detail::writable_constexpr_alphabet<alternative_types> && ...) &&
123 (std::regular<alternative_types> && ...) &&
124 (
sizeof...(alternative_types) >= 2)
127 (static_cast<size_t>(alphabet_size<alternative_types>) + ...),
133 (
static_cast<size_t>(alphabet_size<alternative_types>) + ...),
136 static_assert((std::is_same_v<alphabet_char_t<alternative_types>,
char> && ...),
137 "The alphabet_variant is currently only tested for alphabets with char_type char. "
138 "Contact us on GitHub if you have a different use case: https://github.com/seqan/seqan3 .");
146 static_assert(((seqan3::list_traits::count<alternative_types, alternatives> == 1) && ... &&
true),
147 "All types in a alphabet_variant must be distinct.");
168 using seqan3_recursive_required_types =
170 detail::transformation_trait_or_t<detail::recursive_required_types<alternative_types>,
180 template <
typename alternative_t>
204 template <typename alternative_t>
209 detail::transformation_trait_or_t<detail::recursive_required_types<alternative_t>,
type_list<>>>) &&
235 template <
typename indirect_alternative_t>
237 requires ((detail::instantiate_if_v<
238 detail::lazy<std::is_convertible, indirect_alternative_t, alternative_types>,
239 detail::variant_general_guard<indirect_alternative_t, alternative_types...>> || ...))
243 using alternative_predicate = detail::implicitly_convertible_from<indirect_alternative_t>;
266 template <
typename indirect_alternative_t>
268 requires ((!(detail::instantiate_if_v<
269 detail::lazy<std::is_convertible, indirect_alternative_t, alternative_types>,
270 detail::variant_general_guard<indirect_alternative_t, alternative_types...>> || ...)) &&
271 (detail::instantiate_if_v<
272 detail::lazy<std::is_constructible, alternative_types, indirect_alternative_t>,
273 detail::variant_general_guard<indirect_alternative_t, alternative_types...>> || ...))
277 using alternative_predicate = detail::constructible_from<indirect_alternative_t>;
295 template <
typename indirect_alternative_t>
297 requires (detail::variant_general_guard<indirect_alternative_t, alternative_types...> &&
302 using alternative_predicate = detail::assignable_from<indirect_alternative_t>;
306 alternative_t alternative{};
322 template <
size_t index>
325 static_assert(index <
alphabet_size,
"The alphabet_variant contains less alternatives than you are checking.");
326 return (
to_rank() >= partial_sum_sizes[index]) && (
to_rank() < partial_sum_sizes[index + 1]);
335 template <
size_t index>
338 return convert_impl<index, true>();
346 template <
size_t index>
349 return convert_impl<index, false>();
361 template <
typename alternative_t>
367 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
368 return holds_alternative<index>();
377 template <
typename alternative_t>
383 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
384 return convert_impl<index, true>();
392 template <
typename alternative_t>
398 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
399 return convert_impl<index, false>();
425 template <
typename alphabet_variant_t,
typename indirect_alternative_type>
426 friend constexpr auto operator==(alphabet_variant_t
const lhs, indirect_alternative_type
const rhs)
noexcept
428 indirect_alternative_type,
430 alternative_types...>,
433 using alternative_predicate = detail::weakly_equality_comparable_with_<indirect_alternative_type>;
437 return lhs.template holds_alternative<alternative_t>() && (lhs.template convert_unsafely_to<alternative_t>() == rhs);
441 template <
typename alphabet_variant_t,
typename indirect_alternative_type>
442 friend constexpr auto operator!=(alphabet_variant_t
const lhs, indirect_alternative_type
const rhs)
noexcept
444 indirect_alternative_type,
446 alternative_types...>,
449 return !(lhs == rhs);
453 template <
typename alphabet_variant_t,
typename indirect_alternative_type,
typename =
void>
454 friend constexpr auto operator==(indirect_alternative_type
const lhs, alphabet_variant_t
const rhs)
noexcept
456 indirect_alternative_type,
458 alternative_types...>,
465 template <
typename alphabet_variant_t,
typename indirect_alternative_type,
typename =
void>
466 friend constexpr auto operator!=(indirect_alternative_type
const lhs, alphabet_variant_t
const rhs)
noexcept
468 indirect_alternative_type,
470 alternative_types...>,
484 return first_valid_char_table[
static_cast<index_t
>(chr)] <
sizeof...(alternative_types);
494 template <
size_t index,
bool throws>
495 constexpr auto convert_impl() const noexcept(!throws) ->
seqan3::list_traits::
at<index, alternatives>
497 static_assert(index <
alphabet_size,
"The alphabet_variant contains less alternatives than you are checking.");
500 if constexpr (
throws)
502 if (!holds_alternative<index>())
518 static constexpr std::array<
rank_type,
sizeof...(alternative_types) + 1> partial_sum_sizes = []()
constexpr
520 constexpr size_t N =
sizeof...(alternative_types) + 1;
523 for (
size_t i = 1u; i < N; ++i)
524 partial_sum[i] += partial_sum[i-1];
535 auto assign_rank_to_char = [](
auto alternative,
size_t rank)
constexpr
540 auto assign_value_to_char = [assign_rank_to_char] (
auto alternative,
auto & value_to_char,
auto & value)
constexpr
542 using alternative_t =
std::decay_t<
decltype(alternative)>;
543 for (
size_t i = 0u; i < seqan3::alphabet_size<alternative_t>; ++i, ++value)
544 value_to_char[value] = assign_rank_to_char(alternative, i);
554 ((assign_value_to_char(alternative_types{}, value_to_char, value)),...);
556 return value_to_char;
563 template <
size_t index,
typename alternative_t>
565 requires (is_alternative<alternative_t>())
567 static constexpr rank_type rank_by_index_(alternative_t
const & alternative)
noexcept
576 template <
typename alternative_t>
578 requires (is_alternative<alternative_t>())
580 static constexpr rank_type rank_by_type_(alternative_t
const & alternative)
noexcept
582 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
583 return rank_by_index_<index>(alternative);
589 static constexpr auto first_valid_char_table
593 constexpr size_t alternative_size =
sizeof...(alternative_types);
594 constexpr size_t table_size = detail::size_in_values_v<char_type>;
595 using first_alphabet_t = detail::min_viable_uint_t<alternative_size>;
599 for (
size_t i = 0u; i < table_size; ++i)
605#if defined(__cpp_lib_constexpr_algorithms) && __cpp_lib_constexpr_algorithms >= 201806L
607 auto found_it =
std::find(valid_chars.begin(), valid_chars.end(),
true);
608 lookup_table[i] = found_it - valid_chars.begin();
610 size_t found_index = 0u;
611 for (; found_index < valid_chars.size() && !valid_chars[found_index]; ++found_index);
612 lookup_table[i] = found_index;
623 constexpr size_t alternative_size =
sizeof...(alternative_types);
624 constexpr size_t table_size = detail::size_in_values_v<char_type>;
628 for (
size_t i = 0u; i < table_size; ++i)
635 char_to_rank[i] = first_valid_char_table[i] < alternative_size ? ranks[first_valid_char_table[i]] : 0;
649 return rank_to_char_table[rank];
661 return char_to_rank_table[
static_cast<index_t
>(chr)];
Provides seqan3::alphabet_base.
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:57
constexpr char_type to_char() const noexcept
Return the letter as a character of char_type.
Definition: alphabet_base.hpp:115
constexpr rank_type to_rank() const noexcept
Return the letter's numeric value (rank in the alphabet).
Definition: alphabet_base.hpp:139
detail::min_viable_uint_t< size - 1 > rank_type
The type of the alphabet when represented as a number (e.g. via to_rank()).
Definition: alphabet_base.hpp:80
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.
Definition: alphabet_base.hpp:203
std::conditional_t< std::same_as< char, void >, char, char > char_type
The char representation; conditional needed to make semi alphabet definitions legal.
Definition: alphabet_base.hpp:72
constexpr alphabet_variant< alternative_types... > & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:191
A combined alphabet that can hold values of either of its alternatives..
Definition: alphabet_variant.hpp:129
static constexpr bool char_is_valid(char_type const chr) noexcept
Validate whether a character is valid in the combined alphabet.
Definition: alphabet_variant.hpp:481
static constexpr bool is_alternative() noexcept
Returns true if alternative_t is one of the given alternative types.
Definition: alphabet_variant.hpp:181
constexpr bool holds_alternative() const noexcept
Whether the variant alphabet currently holds a value of the given alternative.
Definition: alphabet_variant.hpp:323
constexpr friend auto operator==(alphabet_variant_t const lhs, indirect_alternative_type const rhs) noexcept -> std::enable_if_t< detail::variant_comparison_guard< alphabet_variant_t, indirect_alternative_type, false, alternative_types... >, bool >
(In-)Equality comparison against types comparable with alternatives but not convertible to the varian...
Definition: alphabet_variant.hpp:426
constexpr friend auto operator!=(indirect_alternative_type const lhs, alphabet_variant_t const rhs) noexcept -> std::enable_if_t< detail::variant_comparison_guard< alphabet_variant_t, indirect_alternative_type, true, alternative_types... >, bool >
(In-)Equality comparison against types comparable with alternatives but not convertible to the varian...
Definition: alphabet_variant.hpp:466
constexpr alphabet_variant(indirect_alternative_t const rhs) noexcept
Constructor for arguments implicitly convertible to an alternative.
Definition: alphabet_variant.hpp:241
constexpr friend auto operator==(indirect_alternative_type const lhs, alphabet_variant_t const rhs) noexcept -> std::enable_if_t< detail::variant_comparison_guard< alphabet_variant_t, indirect_alternative_type, true, alternative_types... >, bool >
(In-)Equality comparison against types comparable with alternatives but not convertible to the varian...
Definition: alphabet_variant.hpp:454
constexpr auto convert_to() const
Convert to the specified alphabet (throws if holds_alternative() would be false).
Definition: alphabet_variant.hpp:336
constexpr friend auto operator!=(alphabet_variant_t const lhs, indirect_alternative_type const rhs) noexcept -> std::enable_if_t< detail::variant_comparison_guard< alphabet_variant_t, indirect_alternative_type, false, alternative_types... >, bool >
(In-)Equality comparison against types comparable with alternatives but not convertible to the varian...
Definition: alphabet_variant.hpp:442
constexpr alphabet_variant() noexcept=default
Defaulted.
constexpr alternative_t convert_to() const
Convert to the specified alphabet (throws if holds_alternative() would be false).
Definition: alphabet_variant.hpp:378
constexpr auto convert_unsafely_to() const noexcept
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false).
Definition: alphabet_variant.hpp:347
constexpr alternative_t convert_unsafely_to() const noexcept
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false).
Definition: alphabet_variant.hpp:393
constexpr auto assign_char_to
Assign a character to an alphabet object.
Definition: concept.hpp:526
constexpr auto to_char
Return the char representation of an alphabet object.
Definition: concept.hpp:387
constexpr auto assign_rank_to
Assign a rank to an alphabet object.
Definition: concept.hpp:294
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition: concept.hpp:155
decltype(detail::concat(lists_t{}...)) concat
Join two seqan3::type_list s into one.
Definition: traits.hpp:329
constexpr bool contains
Whether a type occurs in a type list or not.
Definition: traits.hpp:231
typename decltype(detail::at< idx >(list_t{}))::type at
Return the type at given index from the type list.
Definition: traits.hpp:260
constexpr ptrdiff_t find_if
Get the index of the first type in a pack that satisfies the given predicate.
Definition: traits.hpp:210
constexpr bool contains
Whether a type occurs in a pack or not.
Definition: traits.hpp:228
Resolves to std::is_assignable_v<t>.
Provides lazy template instantiation traits.
The main SeqAn3 namespace.
Definition: cigar_operation_table.hpp:2
SeqAn specific customisations in the standard namespace.
Type that contains multiple types.
Definition: type_list.hpp:29
Provides traits for seqan3::type_list.