35template <
typename tuple_derived_t,
typename rhs_t,
typename ... component_types>
37 (!std::same_as<rhs_t, tuple_derived_t>) &&
39 (!std::is_base_of_v<tuple_derived_t, rhs_t>) &&
40 (!(std::same_as<rhs_t, component_types> || ...)) &&
45template <
typename lhs_t,
typename tuple_derived_t,
typename rhs_t,
typename ... component_types>
47 (instantiate_if_v<lazy<weakly_equality_comparable_with_trait, rhs_t, component_types>,
48 std::same_as<lhs_t, tuple_derived_t> &&
53template <
typename lhs_t,
typename tuple_derived_t,
typename rhs_t,
typename ... component_types>
55 (instantiate_if_v<lazy<weakly_ordered_with_trait, rhs_t, component_types>,
56 std::same_as<lhs_t, tuple_derived_t> &&
113template <
typename derived_type,
114 typename ...component_types>
116 requires (detail::writable_constexpr_semialphabet<component_types> && ...) &&
117 (std::regular<component_types> && ...)
121 (1 * ... * alphabet_size<component_types>),
127 (1 * ... * alphabet_size<component_types>),
134 template <
typename type>
135 static constexpr bool is_component = seqan3::list_traits::contains<type, component_list>;
138 template <
typename type>
142 template <
typename alphabet_type,
size_t index>
155 using base_t::base_t;
207 template <
typename component_type>
209 requires (!std::is_base_of_v<alphabet_tuple_base, component_type>) &&
210 is_unique_component<component_type>
214 get<component_type>(*
this) = alph;
232 template <
typename indirect_component_type>
234 requires ((detail::instantiate_if_v<
235 detail::lazy<std::is_convertible, indirect_component_type, component_types>,
244 component_type tmp(alph);
245 get<component_type>(*
this) = tmp;
249 template <
typename indirect_component_type>
250 requires ((!(detail::instantiate_if_v<
251 detail::lazy<std::is_convertible, indirect_component_type, component_types>,
253 (detail::instantiate_if_v<
254 detail::lazy<std::is_constructible, component_types, indirect_component_type>,
255 detail::tuple_general_guard<derived_type, indirect_component_type, component_types...>> || ...))
258 using component_predicate = detail::constructible_from<indirect_component_type>;
262 component_type tmp(alph);
263 get<component_type>(*
this) = tmp;
277 template <
typename component_type>
279 requires (!std::derived_from<component_type, alphabet_tuple_base>) &&
280 is_unique_component<component_type>
284 get<component_type>(*
this) = alph;
299 template <
typename indirect_component_type>
301 requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) &&
302 (!is_unique_component<indirect_component_type>) &&
303 (std::assignable_from<component_types, indirect_component_type> || ...))
305 constexpr derived_type &
operator=(indirect_component_type
const alph)
noexcept
311 get<component_type>(*
this) = alph;
316 template <
typename indirect_component_type>
317 requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) &&
318 (!is_unique_component<indirect_component_type>) &&
319 (!(std::assignable_from<component_types, indirect_component_type> || ...)) &&
320 (std::convertible_to<indirect_component_type, component_types> || ...))
321 constexpr derived_type &
operator=(indirect_component_type
const alph)
noexcept
327 component_type tmp(alph);
328 get<component_type>(*
this) = tmp;
332 template <
typename indirect_component_type>
333 requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) &&
334 (!is_unique_component<indirect_component_type>) &&
335 (!(std::assignable_from<component_types, indirect_component_type> || ...)) &&
336 (!(std::convertible_to<indirect_component_type, component_types> || ...)) &&
337 (std::constructible_from<component_types, indirect_component_type> || ...))
338 constexpr derived_type &
operator=(indirect_component_type
const alph)
noexcept
340 using component_predicate = detail::constructible_from<indirect_component_type>;
344 component_type tmp(alph);
345 get<component_type>(*
this) = tmp;
361 template <
size_t index>
364 static_assert(index <
sizeof...(component_types),
"Index out of range.");
380 template <
typename type>
383 requires is_unique_component<type>
386 return get<seqan3::list_traits::find<type, component_list>>(l);
395 template <
size_t index>
398 static_assert(index <
sizeof...(component_types),
"Index out of range.");
411 template <
typename type>
414 requires is_unique_component<type>
417 return get<seqan3::list_traits::find<type, component_list>>(l);
424 template <
typename type>
425 constexpr operator type() const noexcept
430 return get<type>(*
this);
451 template <
typename derived_type_t,
typename indirect_component_type>
452 friend constexpr auto operator==(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
460 return get<component_type>(lhs) == rhs;
464 template <
typename derived_type_t,
typename indirect_component_type>
465 friend constexpr auto operator==(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
473 template <
typename derived_type_t,
typename indirect_component_type>
474 friend constexpr auto operator!=(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
482 return get<component_type>(lhs) != rhs;
486 template <
typename derived_type_t,
typename indirect_component_type>
487 friend constexpr auto operator!=(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
495 template <
typename derived_type_t,
typename indirect_component_type>
496 friend constexpr auto operator<(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
504 return get<component_type>(lhs) < rhs;
508 template <
typename derived_type_t,
typename indirect_component_type>
509 friend constexpr auto operator<(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
517 template <
typename derived_type_t,
typename indirect_component_type>
518 friend constexpr auto operator<=(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
526 return get<component_type>(lhs) <= rhs;
530 template <
typename derived_type_t,
typename indirect_component_type>
531 friend constexpr auto operator<=(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
539 template <
typename derived_type_t,
typename indirect_component_type>
540 friend constexpr auto operator>(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
548 return get<component_type>(lhs) > rhs;
552 template <
typename derived_type_t,
typename indirect_component_type>
553 friend constexpr auto operator>(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
561 template <
typename derived_type_t,
typename indirect_component_type>
562 friend constexpr auto operator>=(derived_type_t
const lhs, indirect_component_type
const rhs)
noexcept
570 return get<component_type>(lhs) >= rhs;
574 template <
typename derived_type_t,
typename indirect_component_type>
575 friend constexpr auto operator>=(indirect_component_type
const lhs, derived_type_t
const rhs)
noexcept
585 template <
size_t index>
590 return rank_to_component_rank[index][
to_rank()];
600 template <
size_t index>
604 ((r -
static_cast<ptrdiff_t
>(to_component_rank<index>())) *
617 using reverse_list_t =
decltype(seqan3::list_traits::detail::reverse(
component_list{}));
618 seqan3::detail::for_each<reverse_list_t>([&] (
auto alphabet_type_identity)
constexpr
620 using alphabet_t =
typename decltype(alphabet_type_identity)::type;
645 list_traits::size<component_list>> rank_to_component_rank
650 list_traits::size<component_list>> ret{};
656 for (
size_t i = 0; i < list_traits::size<component_list>; ++i)
657 for (
size_t j = 0; j < static_cast<size_t>(
alphabet_size); ++j)
672template <
typename derived_type,
typename ...component_types>
674 requires (detail::writable_constexpr_semialphabet<component_types> && ...) &&
675 (std::regular<component_types> && ...)
677template <
typename alphabet_type,
size_t index>
697 using base_t::operator=;
729 return get<index>(lhs) ==
static_cast<alphabet_type
>(rhs);
741 return get<index>(lhs) !=
static_cast<alphabet_type
>(rhs);
753 return get<index>(lhs) <
static_cast<alphabet_type
>(rhs);
765 return get<index>(lhs) <=
static_cast<alphabet_type
>(rhs);
777 return get<index>(lhs) >
static_cast<alphabet_type
>(rhs);
789 return get<index>(lhs) >=
static_cast<alphabet_type
>(rhs);
812template <std::
size_t i, seqan3::detail::alphabet_tuple_like tuple_t>
813struct tuple_element<i, tuple_t>
826template <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:67
Specialisation of seqan3::alphabet_proxy that updates the rank of the alphabet_tuple_base.
Definition: alphabet_tuple_base.hpp:679
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:745
~component_proxy()=default
Defaulted.
constexpr void on_update() noexcept
The implementation updates the rank in the parent object.
Definition: alphabet_tuple_base.hpp:690
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:763
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:769
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:751
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:787
alphabet_tuple_base * parent
Store a pointer to the parent object so we can update it.
Definition: alphabet_tuple_base.hpp:687
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:727
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:757
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:711
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:739
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:781
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:733
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:775
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:793
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:684
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:123
~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:362
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:465
constexpr rank_type to_component_rank() const noexcept
Return the rank of the i-th component.
Definition: alphabet_tuple_base.hpp:586
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:638
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:562
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:531
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:496
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:553
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:238
static constexpr bool seqan3_alphabet_tuple_like
Make specialisations of this template identifiable in metapgrogramming contexts.
Definition: alphabet_tuple_base.hpp:182
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:540
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:139
constexpr alphabet_tuple_base() noexcept
Defaulted.
Definition: alphabet_tuple_base.hpp:148
constexpr alphabet_tuple_base(component_types ... components) noexcept
Construction from initialiser-list.
Definition: alphabet_tuple_base.hpp:192
seqan3::type_list< component_types... > component_list
A seqan3::type_list The types of each component in the composite.
Definition: alphabet_tuple_base.hpp:131
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:509
friend constexpr type get(alphabet_tuple_base const &l) noexcept
Tuple-like access to the contained components.
Definition: alphabet_tuple_base.hpp:412
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:575
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:179
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:474
static constexpr std::array< rank_type, component_list::size()> cummulative_alph_sizes
The cumulative alphabet size products are cached.
Definition: alphabet_tuple_base.hpp:610
static constexpr bool is_component
Is set to true if the type is contained in the type list.
Definition: alphabet_tuple_base.hpp:135
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:601
constexpr alphabet_tuple_base(component_type const alph) noexcept
Construction via a value of one of the components.
Definition: alphabet_tuple_base.hpp:212
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:487
friend derived_type
Befriend the derived type so that it can instantiate.
Definition: alphabet_tuple_base.hpp:160
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:452
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:518
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:396
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:36
constexpr bool tuple_eq_guard
Prevents wrong instantiations of seqan3::alphabet_tuple_base's equality comparison operators.
Definition: alphabet_tuple_base.hpp:46
constexpr bool tuple_order_guard
Prevents wrong instantiations of seqan3::alphabet_tuple_base's ordered comparison operators.
Definition: alphabet_tuple_base.hpp:54
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 ass...
Definition: detail.hpp:164
'Callable' helper class that is invokable by meta::invoke.Returns a std::true_type if the T is implic...
Definition: detail.hpp:152
'Callable' helper class that is invokable by meta::invoke.Returns a std::true_type if the type is wea...
Definition: detail.hpp:176
'Callable' helper class that is invokable by meta::invoke.Returns a std::true_type if the type is com...
Definition: detail.hpp:188
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:816
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.