36template <
typename tuple_derived_t,
typename rhs_t,
typename ... component_types>
38 (!std::same_as<rhs_t, tuple_derived_t>) &&
40 (!std::is_base_of_v<tuple_derived_t, rhs_t>) &&
41 (!(std::same_as<rhs_t, component_types> || ...)) &&
46template <
typename lhs_t,
typename tuple_derived_t,
typename rhs_t,
typename ... component_types>
48 (instantiate_if_v<lazy<weakly_equality_comparable_with_trait, rhs_t, component_types>,
49 std::same_as<lhs_t, tuple_derived_t> &&
54template <
typename lhs_t,
typename tuple_derived_t,
typename rhs_t,
typename ... component_types>
56 (instantiate_if_v<lazy<weakly_ordered_with_trait, rhs_t, component_types>,
57 std::same_as<lhs_t, tuple_derived_t> &&
114template <
typename derived_type,
115 typename ...component_types>
117 requires (detail::writable_constexpr_semialphabet<component_types> && ...) &&
118 (std::regular<component_types> && ...)
122 (1 * ... * alphabet_size<component_types>),
128 (1 * ... * alphabet_size<component_types>),
135 template <
typename type>
136 static constexpr bool is_component = seqan3::list_traits::contains<type, component_list>;
139 template <
typename type>
143 template <
typename alphabet_type,
size_t index>
156 using base_t::base_t;
208 template <
typename component_type>
210 requires (!std::is_base_of_v<alphabet_tuple_base, component_type>) &&
211 is_unique_component<component_type>
215 get<component_type>(*
this) = alph;
233 template <
typename indirect_component_type>
235 requires ((detail::instantiate_if_v<
236 detail::lazy<std::is_convertible, indirect_component_type, component_types>,
245 component_type tmp(alph);
246 get<component_type>(*
this) = tmp;
250 template <
typename indirect_component_type>
251 requires ((!(detail::instantiate_if_v<
252 detail::lazy<std::is_convertible, indirect_component_type, component_types>,
254 (detail::instantiate_if_v<
255 detail::lazy<std::is_constructible, component_types, indirect_component_type>,
256 detail::tuple_general_guard<derived_type, indirect_component_type, component_types...>> || ...))
259 using component_predicate = detail::constructible_from<indirect_component_type>;
263 component_type tmp(alph);
264 get<component_type>(*
this) = tmp;
278 template <
typename component_type>
280 requires (!std::derived_from<component_type, alphabet_tuple_base>) &&
281 is_unique_component<component_type>
285 get<component_type>(*
this) = alph;
300 template <
typename indirect_component_type>
302 requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) &&
303 (!is_unique_component<indirect_component_type>) &&
304 (std::assignable_from<component_types, indirect_component_type> || ...))
306 constexpr derived_type &
operator=(indirect_component_type
const alph)
noexcept
312 get<component_type>(*
this) = alph;
317 template <
typename indirect_component_type>
318 requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) &&
319 (!is_unique_component<indirect_component_type>) &&
320 (!(std::assignable_from<component_types, indirect_component_type> || ...)) &&
321 (std::convertible_to<indirect_component_type, component_types> || ...))
322 constexpr derived_type &
operator=(indirect_component_type
const alph)
noexcept
328 component_type tmp(alph);
329 get<component_type>(*
this) = tmp;
333 template <
typename indirect_component_type>
334 requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) &&
335 (!is_unique_component<indirect_component_type>) &&
336 (!(std::assignable_from<component_types, indirect_component_type> || ...)) &&
337 (!(std::convertible_to<indirect_component_type, component_types> || ...)) &&
338 (std::constructible_from<component_types, indirect_component_type> || ...))
339 constexpr derived_type &
operator=(indirect_component_type
const alph)
noexcept
341 using component_predicate = detail::constructible_from<indirect_component_type>;
345 component_type tmp(alph);
346 get<component_type>(*
this) = tmp;
362 template <
size_t index>
365 static_assert(index <
sizeof...(component_types),
"Index out of range.");
381 template <
typename type>
384 requires is_unique_component<type>
387 return get<seqan3::list_traits::find<type, component_list>>(l);
396 template <
size_t index>
399 static_assert(index <
sizeof...(component_types),
"Index out of range.");
412 template <
typename type>
415 requires is_unique_component<type>
418 return get<seqan3::list_traits::find<type, component_list>>(l);
425 template <
typename type>
426 constexpr operator type() const noexcept
431 return get<type>(*
this);
452 template <
typename derived_type_t,
typename indirect_component_type>
453 friend constexpr auto operator==(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
461 return get<component_type>(lhs) == rhs;
465 template <
typename derived_type_t,
typename indirect_component_type>
466 friend constexpr auto operator==(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
474 template <
typename derived_type_t,
typename indirect_component_type>
475 friend constexpr auto operator!=(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
483 return get<component_type>(lhs) != rhs;
487 template <
typename derived_type_t,
typename indirect_component_type>
488 friend constexpr auto operator!=(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
496 template <
typename derived_type_t,
typename indirect_component_type>
497 friend constexpr auto operator<(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
505 return get<component_type>(lhs) < rhs;
509 template <
typename derived_type_t,
typename indirect_component_type>
510 friend constexpr auto operator<(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
518 template <
typename derived_type_t,
typename indirect_component_type>
519 friend constexpr auto operator<=(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
527 return get<component_type>(lhs) <= rhs;
531 template <
typename derived_type_t,
typename indirect_component_type>
532 friend constexpr auto operator<=(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
540 template <
typename derived_type_t,
typename indirect_component_type>
541 friend constexpr auto operator>(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
549 return get<component_type>(lhs) > rhs;
553 template <
typename derived_type_t,
typename indirect_component_type>
554 friend constexpr auto operator>(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
562 template <
typename derived_type_t,
typename indirect_component_type>
563 friend constexpr auto operator>=(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
571 return get<component_type>(lhs) >= rhs;
575 template <
typename derived_type_t,
typename indirect_component_type>
576 friend constexpr auto operator>=(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
586 template <
size_t index>
591 return rank_to_component_rank[index][
to_rank()];
601 template <
size_t index>
605 ((r -
static_cast<ptrdiff_t
>(to_component_rank<index>())) *
618 using reverse_list_t =
decltype(seqan3::list_traits::detail::reverse(
component_list{}));
619 seqan3::detail::for_each<reverse_list_t>([&] (
auto alphabet_type_identity)
constexpr
621 using alphabet_t =
typename decltype(alphabet_type_identity)::type;
646 list_traits::size<component_list>> rank_to_component_rank
651 list_traits::size<component_list>> ret{};
657 for (
size_t i = 0; i < list_traits::size<component_list>; ++i)
658 for (
size_t j = 0; j < static_cast<size_t>(
alphabet_size); ++j)
673template <
typename derived_type,
typename ...component_types>
675 requires (detail::writable_constexpr_semialphabet<component_types> && ...) &&
676 (std::regular<component_types> && ...)
678template <
typename alphabet_type,
size_t index>
698 using base_t::operator=;
730 return get<index>(lhs) ==
static_cast<alphabet_type
>(rhs);
742 return get<index>(lhs) !=
static_cast<alphabet_type
>(rhs);
754 return get<index>(lhs) <
static_cast<alphabet_type
>(rhs);
766 return get<index>(lhs) <=
static_cast<alphabet_type
>(rhs);
778 return get<index>(lhs) >
static_cast<alphabet_type
>(rhs);
790 return get<index>(lhs) >=
static_cast<alphabet_type
>(rhs);
813template <std::
size_t i, seqan3::detail::alphabet_tuple_like tuple_t>
814struct tuple_element<i, tuple_t>
827template <seqan3::detail::alphabet_tuple_like tuple_t>
Provides implementation detail for seqan3::alphabet_variant and seqan3::alphabet_tuple_base.
Core alphabet concept and free function/type trait wrappers.
Provides seqan3::alphabet_base.
Provides seqan3::alphabet_proxy.
A CRTP-base that makes defining a custom alphabet easier.
Definition: alphabet_base.hpp:57
static detail::min_viable_uint_t< size > constexpr alphabet_size
The size of the alphabet, i.e. the number of different values it can take.
Definition: alphabet_base.hpp:203
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
constexpr derived_type & assign_rank(rank_type const c) noexcept
Assign from a numeric value.
Definition: alphabet_base.hpp:191
A CRTP-base that eases the definition of proxy types returned in place of regular alphabets.
Definition: alphabet_proxy.hpp:66
Specialisation of seqan3::alphabet_proxy that updates the rank of the alphabet_tuple_base.
Definition: alphabet_tuple_base.hpp:680
friend constexpr bool operator!=(component_proxy< alphabet_type, index > const lhs, derived_type const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:746
~component_proxy()=default
Defaulted.
constexpr void on_update() noexcept
The implementation updates the rank in the parent object.
Definition: alphabet_tuple_base.hpp:691
constexpr component_proxy(component_proxy const &)=default
Defaulted.
friend constexpr bool operator<=(derived_type const lhs, component_proxy const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:764
friend constexpr bool operator<=(component_proxy< alphabet_type, index > const lhs, derived_type const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:770
constexpr component_proxy & operator=(component_proxy &&)=default
Defaulted.
constexpr component_proxy & operator=(component_proxy const &)=default
Defaulted.
friend constexpr bool operator<(derived_type const lhs, component_proxy const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:752
friend constexpr bool operator>=(derived_type const lhs, component_proxy const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:788
alphabet_tuple_base * parent
Store a pointer to the parent object so we can update it.
Definition: alphabet_tuple_base.hpp:688
friend constexpr bool operator==(derived_type const lhs, component_proxy const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:728
friend constexpr bool operator<(component_proxy< alphabet_type, index > const lhs, derived_type const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:758
constexpr component_proxy(alphabet_type const l, alphabet_tuple_base &p)
Construct from an alphabet letter and reference to the parent object.
Definition: alphabet_tuple_base.hpp:712
friend constexpr bool operator!=(derived_type const lhs, component_proxy const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:740
friend constexpr bool operator>(component_proxy< alphabet_type, index > const lhs, derived_type const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:782
friend constexpr bool operator==(component_proxy< alphabet_type, index > const lhs, derived_type const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:734
friend constexpr bool operator>(derived_type const lhs, component_proxy const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:776
friend constexpr bool operator>=(component_proxy< alphabet_type, index > const lhs, derived_type const rhs) noexcept
Comparison against the alphabet tuple by casting self and tuple to the emulated type.
Definition: alphabet_tuple_base.hpp:794
friend base_t
Befriend the base type so it can call our seqan3::alphabet_tuple_base::component_proxy::on_update().
Definition: alphabet_tuple_base.hpp:685
constexpr component_proxy(component_proxy &&)=default
Defaulted.
component_proxy()=delete
Deleted, because using this proxy without parent would be undefined behaviour.
The CRTP base for a combined alphabet that contains multiple values of different alphabets at the sam...
Definition: alphabet_tuple_base.hpp:124
~alphabet_tuple_base()=default
Defaulted.
friend constexpr auto get(alphabet_tuple_base &l) noexcept
Tuple-like access to the contained components.
Definition: alphabet_tuple_base.hpp:363
friend constexpr auto operator==(indirect_component_type const lhs, derived_type_t const rhs) noexcept -> std::enable_if_t< detail::tuple_eq_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:466
constexpr rank_type to_component_rank() const noexcept
Return the rank of the i-th component.
Definition: alphabet_tuple_base.hpp:587
static constexpr rank_type rank_sum_helper(component_types ... components, std::index_sequence< idx... > const &) noexcept
For the given components, compute the combined rank.
Definition: alphabet_tuple_base.hpp:639
friend constexpr auto operator>=(derived_type_t const lhs, indirect_component_type const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:563
friend constexpr auto operator<=(indirect_component_type const lhs, derived_type_t const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:532
friend constexpr auto operator<(derived_type_t const lhs, indirect_component_type const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:497
friend constexpr auto operator>(indirect_component_type const lhs, derived_type_t const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:554
constexpr alphabet_tuple_base(indirect_component_type const alph) noexcept
Construction via a value of a subtype that is assignable to one of the components.
Definition: alphabet_tuple_base.hpp:239
static constexpr bool seqan3_alphabet_tuple_like
Make specialisations of this template identifiable in metapgrogramming contexts.
Definition: alphabet_tuple_base.hpp:183
constexpr alphabet_tuple_base(alphabet_tuple_base const &)=default
Defaulted.
friend constexpr auto operator>(derived_type_t const lhs, indirect_component_type const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:541
constexpr alphabet_tuple_base(alphabet_tuple_base &&)=default
Defaulted.
static constexpr bool is_unique_component
Is set to true if the type is uniquely contained in the type list.
Definition: alphabet_tuple_base.hpp:140
constexpr alphabet_tuple_base() noexcept
Defaulted.
Definition: alphabet_tuple_base.hpp:149
constexpr alphabet_tuple_base(component_types ... components) noexcept
Construction from initialiser-list.
Definition: alphabet_tuple_base.hpp:193
seqan3::type_list< component_types... > component_list
A seqan3::type_list The types of each component in the composite.
Definition: alphabet_tuple_base.hpp:132
friend constexpr auto operator<(indirect_component_type const lhs, derived_type_t const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:510
friend constexpr type get(alphabet_tuple_base const &l) noexcept
Tuple-like access to the contained components.
Definition: alphabet_tuple_base.hpp:413
friend constexpr auto operator>=(indirect_component_type const lhs, derived_type_t const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:576
list_traits::concat< component_list, detail::transformation_trait_or_t< detail::recursive_required_types< component_types >, seqan3::type_list<> >... > seqan3_recursive_required_types
Export this type's components and possibly the components' components in a visible manner.
Definition: alphabet_tuple_base.hpp:180
friend constexpr auto operator!=(derived_type_t const lhs, indirect_component_type const rhs) noexcept -> std::enable_if_t< detail::tuple_eq_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:475
static constexpr std::array< rank_type, component_list::size()> cummulative_alph_sizes
The cumulative alphabet size products are cached.
Definition: alphabet_tuple_base.hpp:611
static constexpr bool is_component
Is set to true if the type is contained in the type list.
Definition: alphabet_tuple_base.hpp:136
constexpr void assign_component_rank(ptrdiff_t const r) noexcept
Assign via the rank of i-th component (does not update other components' state).
Definition: alphabet_tuple_base.hpp:602
constexpr alphabet_tuple_base(component_type const alph) noexcept
Construction via a value of one of the components.
Definition: alphabet_tuple_base.hpp:213
friend constexpr auto operator!=(indirect_component_type const lhs, derived_type_t const rhs) noexcept -> std::enable_if_t< detail::tuple_eq_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:488
friend derived_type
Befriend the derived type so that it can instantiate.
Definition: alphabet_tuple_base.hpp:161
friend constexpr auto operator==(derived_type_t const lhs, indirect_component_type const rhs) noexcept -> std::enable_if_t< detail::tuple_eq_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:453
constexpr alphabet_tuple_base & operator=(alphabet_tuple_base &&)=default
Defaulted.
friend constexpr auto operator<=(derived_type_t const lhs, indirect_component_type const rhs) noexcept -> std::enable_if_t< detail::tuple_order_guard< derived_type_t, derived_type, indirect_component_type, component_types... >, bool >
Comparison against types comparable with components.
Definition: alphabet_tuple_base.hpp:519
constexpr alphabet_tuple_base & operator=(alphabet_tuple_base const &)=default
Defaulted.
friend constexpr auto get(alphabet_tuple_base const &l) noexcept
Tuple-like access to the contained components.
Definition: alphabet_tuple_base.hpp:397
The <concepts> header from C++20's standard library.
Provides concepts for core language types and relations that don't have concepts in C++20 (yet).
constexpr auto alphabet_size
A type trait that holds the size of a (semi-)alphabet.
Definition: concept.hpp:846
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:353
constexpr bool contains
Whether a type occurs in a type list or not.
Definition: traits.hpp:255
typename decltype(detail::at< idx >(list_t{}))::type at
Return the type at given index from the type list.
Definition: traits.hpp:284
constexpr ptrdiff_t count
Count the occurrences of a type in a pack.
Definition: traits.hpp:169
typename decltype(detail::at< idx, pack_t... >())::type at
Return the type at given index from the type pack.
Definition: traits.hpp:256
constexpr ptrdiff_t find_if
Get the index of the first type in a pack that satisfies the given predicate.
Definition: traits.hpp:210
typename transformation_trait_or< type_t, default_t >::type transformation_trait_or_t
Helper type of seqan3::detail::transformation_trait_or (transformation_trait shortcut).
Definition: transformation_trait_or.hpp:51
Provides metaprogramming utilities for integer types.
Subconcept definition for seqan3::tuple_like to test for std::tuple_size-interface.
The internal SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
constexpr bool tuple_general_guard
Prevents wrong instantiations of seqan3::alphabet_tuple_base's equality comparison operators.
Definition: alphabet_tuple_base.hpp:37
constexpr bool tuple_eq_guard
Prevents wrong instantiations of seqan3::alphabet_tuple_base's equality comparison operators.
Definition: alphabet_tuple_base.hpp:47
constexpr bool tuple_order_guard
Prevents wrong instantiations of seqan3::alphabet_tuple_base's ordered comparison operators.
Definition: alphabet_tuple_base.hpp:55
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
constexpr auto const & get(configuration< configs_t... > const &config) noexcept
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: configuration.hpp:429
SeqAn specific customisations in the standard namespace.
'Callable' helper class that is invokable by meta::invoke. Returns a std::true_type if the type is as...
Definition: detail.hpp:160
'Callable' helper class that is invokable by meta::invoke. Returns a std::true_type if the T is impli...
Definition: detail.hpp:149
'Callable' helper class that is invokable by meta::invoke. Returns a std::true_type if the type is we...
Definition: detail.hpp:171
'Callable' helper class that is invokable by meta::invoke. Returns a std::true_type if the type is co...
Definition: detail.hpp:182
Type that contains multiple types.
Definition: type_list.hpp:29
static constexpr size_t size() noexcept
The number of types contained in the type list.
Definition: type_list.hpp:34
seqan3::list_traits::at< i, typename tuple_t::seqan3_required_types > type
Element type.
Definition: alphabet_tuple_base.hpp:817
Provides traits for seqan3::type_list.
Provides seqan3::type_list.
Provides algorithms for meta programming, parameter packs and seqan3::type_list.
Provides various traits for template packs.
Provides seqan3::tuple_like.