29namespace seqan3::detail
33template <
typename t,
size_t extent = std::dynamic_extent>
38template <
typename t,
size_t extent>
44template <
typename other_t,
typename... alternative_types>
45inline constexpr bool variant_general_guard =
46 (!std::same_as<other_t, alphabet_variant<alternative_types...>>)&&(
48 other_t>)&&(!(std::same_as<other_t, alternative_types> || ...))
49 && (!
list_traits::contains<alphabet_variant<alternative_types...>, recursive_required_types_t<other_t>>);
52template <
typename lhs_t,
typename rhs_t,
bool lhs_rhs_switched,
typename... alternative_types>
53inline constexpr bool variant_comparison_guard =
55 lazy<weakly_equality_comparable_with_trait, rhs_t, alternative_types>,
56 (std::same_as<lhs_t, alphabet_variant<alternative_types...>>)&&(
57 variant_general_guard<rhs_t, alternative_types...>)&&!(lhs_rhs_switched
58 && is_type_specialisation_of_v<rhs_t,
125template <
typename... alternative_types>
126 requires (detail::writable_constexpr_alphabet<alternative_types> && ...) && (std::regular<alternative_types> && ...)
127 && (
sizeof...(alternative_types) >= 2)
130 (static_cast<size_t>(alphabet_size<alternative_types>) + ...),
136 (
static_cast<size_t>(alphabet_size<alternative_types>) + ...),
139 static_assert((std::is_same_v<alphabet_char_t<alternative_types>,
char> && ...),
140 "The alphabet_variant is currently only tested for alphabets with char_type char. "
141 "Contact us on GitHub if you have a different use case: https://github.com/seqan/seqan3 .");
149 static_assert(((seqan3::list_traits::count<alternative_types, alternatives> == 1) && ... &&
true),
150 "All types in a alphabet_variant must be distinct.");
174 detail::transformation_trait_or_t<detail::recursive_required_types<alternative_types>,
type_list<>>...>;
183 template <
typename alternative_t>
207 template <typename alternative_t>
208 requires (!
std::same_as<alternative_t,
alphabet_variant>) && (!detail::is_span<alternative_t>::value)
210 && (!list_traits::contains<
212 detail::transformation_trait_or_t<detail::recursive_required_types<alternative_t>,
type_list<>>>)
237 template <
typename indirect_alternative_t>
238 requires (!detail::is_span<indirect_alternative_t>::value)
240 detail::instantiate_if_v<detail::lazy<std::is_convertible, indirect_alternative_t, alternative_types>,
241 detail::variant_general_guard<indirect_alternative_t, alternative_types...>>
245 using alternative_predicate = detail::implicitly_convertible_from<indirect_alternative_t>;
246 constexpr auto alternative_position =
247 seqan3::list_traits::find_if<alternative_predicate::template invoke, alternatives>;
268 template <
typename indirect_alternative_t>
270 (!(detail::instantiate_if_v<detail::lazy<std::is_convertible, indirect_alternative_t, alternative_types>,
271 detail::variant_general_guard<indirect_alternative_t, alternative_types...>>
273 && (detail::instantiate_if_v<detail::lazy<std::is_constructible, alternative_types, indirect_alternative_t>,
274 detail::variant_general_guard<indirect_alternative_t, alternative_types...>>
278 using alternative_predicate = detail::constructible_from<indirect_alternative_t>;
279 constexpr auto alternative_position =
280 seqan3::list_traits::find_if<alternative_predicate::template invoke, alternatives>;
296 template <
typename indirect_alternative_t>
297 requires (detail::variant_general_guard<indirect_alternative_t, alternative_types...>
301 using alternative_predicate = detail::assignable_from<indirect_alternative_t>;
302 constexpr auto alternative_position =
303 seqan3::list_traits::find_if<alternative_predicate::template invoke, alternatives>;
305 alternative_t alternative{};
321 template <
size_t index>
324 static_assert(index <
alphabet_size,
"The alphabet_variant contains less alternatives than you are checking.");
325 return (
to_rank() >= partial_sum_sizes[index]) && (
to_rank() < partial_sum_sizes[index + 1]);
334 template <
size_t index>
337 return convert_impl<index, true>();
345 template <
size_t index>
348 return convert_impl<index, false>();
360 template <
typename alternative_t>
364 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
365 return holds_alternative<index>();
374 template <
typename alternative_t>
378 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
379 return convert_impl<index, true>();
387 template <
typename alternative_t>
391 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
392 return convert_impl<index, false>();
418 template <
typename alphabet_variant_t,
typename indirect_alternative_type>
419 requires (!detail::is_span<alphabet_variant_t>::value)
420 && (detail::variant_comparison_guard<alphabet_variant_t,
421 indirect_alternative_type,
423 alternative_types...>)
424 friend constexpr bool operator==(alphabet_variant_t
const lhs, indirect_alternative_type
const rhs)
noexcept
426 using alternative_predicate = detail::weakly_equality_comparable_with_<indirect_alternative_type>;
427 constexpr auto alternative_position =
428 seqan3::list_traits::find_if<alternative_predicate::template invoke, alternatives>;
430 return lhs.template holds_alternative<alternative_t>()
431 && (lhs.template convert_unsafely_to<alternative_t>() == rhs);
435 template <
typename alphabet_variant_t,
typename indirect_alternative_type>
436 friend constexpr auto
438 detail::variant_comparison_guard<alphabet_variant_t, indirect_alternative_type,
false, alternative_types...>,
441 return !(lhs == rhs);
445 template <
typename alphabet_variant_t,
typename indirect_alternative_type,
typename =
void>
446 requires (!detail::is_span<alphabet_variant_t>::value)
447 && (detail::variant_comparison_guard<alphabet_variant_t,
448 indirect_alternative_type,
450 alternative_types...>)
451 friend constexpr bool operator==(indirect_alternative_type
const lhs, alphabet_variant_t
const rhs)
noexcept
457 template <
typename alphabet_variant_t,
typename indirect_alternative_type,
typename =
void>
458 friend constexpr auto operator!=(indirect_alternative_type
const lhs, alphabet_variant_t
const rhs)
noexcept
460 detail::variant_comparison_guard<alphabet_variant_t, indirect_alternative_type,
true, alternative_types...>,
474 return first_valid_char_table[
static_cast<index_t
>(chr)] <
sizeof...(alternative_types);
484 template <
size_t index,
bool throws>
485 constexpr auto convert_impl() const noexcept(!throws) ->
seqan3::list_traits::at<index, alternatives>
487 static_assert(index <
alphabet_size,
"The alphabet_variant contains less alternatives than you are checking.");
490 if constexpr (
throws)
492 if (!holds_alternative<index>())
506 template <
size_t index,
typename alternative_t>
507 requires (is_alternative<alternative_t>())
508 static constexpr rank_type rank_by_index_(alternative_t
const & alternative)
noexcept
518 template <
typename alternative_t>
519 requires (is_alternative<alternative_t>())
520 static constexpr rank_type rank_by_type_(alternative_t
const & alternative)
noexcept
522 constexpr size_t index = seqan3::list_traits::find<alternative_t, alternatives>;
523 return rank_by_index_<index>(alternative);
534 return rank_to_char_table[rank];
546 return char_to_rank_table[
static_cast<index_t
>(chr)];
560 constexpr size_t N =
sizeof...(alternative_types) + 1;
564 for (
size_t i = 1u; i < N; ++i)
565 partial_sum[i] += partial_sum[i - 1];
575 auto assign_value_to_char = [](
auto alternative,
auto & value_to_char,
auto & value)
constexpr
577 using alternative_t =
std::decay_t<
decltype(alternative)>;
578 for (
size_t i = 0u; i < seqan3::alphabet_size<alternative_t>; ++i, ++value)
589 ((assign_value_to_char(alternative_types{}, value_to_char, value)), ...);
591 return value_to_char;
598 static constexpr auto first_valid_char_table
601 constexpr size_t alternative_size =
sizeof...(alternative_types);
602 constexpr size_t table_size = detail::size_in_values_v<char_type>;
603 using first_alphabet_t = detail::min_viable_uint_t<alternative_size>;
607 for (
size_t i = 0u; i < table_size; ++i)
613 auto found_it =
std::find(valid_chars.begin(), valid_chars.end(),
true);
614 lookup_table[i] = found_it - valid_chars.begin();
625 constexpr size_t alternative_size =
sizeof...(alternative_types);
626 constexpr size_t table_size = detail::size_in_values_v<char_type>;
630 for (
size_t i = 0u; i < table_size; ++i)
637 char_to_rank[i] = first_valid_char_table[i] < alternative_size ? ranks[first_valid_char_table[i]] : 0;
Provides implementation detail for seqan3::alphabet_variant and seqan3::alphabet_tuple_base.
Provides seqan3::alphabet_base.
A CRTP-base that makes defining a custom alphabet easier.
Definition alphabet_base.hpp:57
constexpr rank_type to_rank() const noexcept
Return the letter's numeric value (rank in the alphabet).
Definition alphabet_base.hpp:137
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:199
constexpr char_type to_char() const noexcept
Return the letter as a character of char_type.
Definition alphabet_base.hpp:115
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:187
A combined alphabet that can hold values of either of its alternatives..
Definition alphabet_variant.hpp:132
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:471
static constexpr bool is_alternative() noexcept
Returns true if alternative_t is one of the given alternative types.
Definition alphabet_variant.hpp:184
constexpr alternative_t convert_to() const
Convert to the specified alphabet (throws if holds_alternative() would be false).
Definition alphabet_variant.hpp:375
constexpr bool holds_alternative() const noexcept
Whether the variant alphabet currently holds a value of the given alternative.
Definition alphabet_variant.hpp:322
constexpr alphabet_variant(indirect_alternative_t const rhs) noexcept
Constructor for arguments implicitly convertible to an alternative.
Definition alphabet_variant.hpp:243
constexpr bool holds_alternative() const noexcept
Whether the variant alphabet currently holds a value of the given alternative.
Definition alphabet_variant.hpp:361
constexpr alphabet_variant(indirect_alternative_t const rhs) noexcept
Constructor for arguments explicitly (but not implicitly) convertible to an alternative.
Definition alphabet_variant.hpp:276
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:388
friend constexpr 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:437
friend 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 varian...
Definition alphabet_variant.hpp:451
constexpr auto convert_to() const
Convert to the specified alphabet (throws if holds_alternative() would be false).
Definition alphabet_variant.hpp:335
friend 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 varian...
Definition alphabet_variant.hpp:424
constexpr alphabet_variant() noexcept=default
Defaulted.
constexpr auto convert_unsafely_to() const noexcept
Convert to the specified alphabet (undefined behaviour if holds_alternative() would be false).
Definition alphabet_variant.hpp:346
friend constexpr 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:458
constexpr auto assign_char_to
Assign a character to an alphabet object.
Definition alphabet/concept.hpp:524
constexpr auto to_char
Return the char representation of an alphabet object.
Definition alphabet/concept.hpp:386
constexpr auto assign_rank_to
Assign a rank to an alphabet object.
Definition alphabet/concept.hpp:293
constexpr auto to_rank
Return the rank representation of a (semi-)alphabet object.
Definition alphabet/concept.hpp:155
decltype(detail::concat(lists_t{}...)) concat
Join two seqan3::type_list s into one.
Definition type_list/traits.hpp:342
constexpr bool contains
Whether a type occurs in a type list or not.
Definition type_list/traits.hpp:252
typename decltype(detail::at< idx >(list_t{}))::type at
Return the type at given index from the type list.
Definition type_list/traits.hpp:279
constexpr bool contains
Whether a type occurs in a pack or not.
Definition type_pack/traits.hpp:223
Resolves to std::is_assignable_v<t>.
Provides lazy template instantiation traits.
The main SeqAn3 namespace.
Definition aligned_sequence_concept.hpp:29
SeqAn specific customisations in the standard namespace.
Type that contains multiple types.
Definition type_list.hpp:29
Provides traits for seqan3::type_list.