SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
|
The CRTP base for a combined alphabet that contains multiple values of different alphabets at the same time.. More...
#include <seqan3/alphabet/composite/alphabet_tuple_base.hpp>
Classes | |
class | component_proxy |
Specialisation of seqan3::alphabet_proxy that updates the rank of the alphabet_tuple_base. More... | |
Private Types | |
using | base_t = alphabet_base< derived_type,(1 *... *alphabet_size< component_types >), void > |
The base type of this class. | |
using | component_list = seqan3::type_list< component_types... > |
A seqan3::type_list The types of each component in the composite. | |
using | seqan3_recursive_required_types = list_traits::concat< component_list, detail::transformation_trait_or_t< detail::recursive_required_types< component_types >, seqan3::type_list<> >... > |
Export this type's components and possibly the components' components in a visible manner. | |
using | seqan3_required_types = component_list |
Export this type's components in a visible manner. | |
Private Member Functions | |
template<size_t index> | |
constexpr void | assign_component_rank (ptrdiff_t const r) noexcept |
Assign via the rank of i-th component (does not update other components' state). | |
template<size_t index> | |
constexpr rank_type | to_component_rank () const noexcept |
Return the rank of the i-th component. | |
Static Private Member Functions | |
template<std::size_t... idx> | |
static constexpr rank_type | rank_sum_helper (component_types... components, std::index_sequence< idx... > const &) noexcept |
For the given components, compute the combined rank. | |
Private Attributes | |
friend | derived_type |
Befriend the derived type so that it can instantiate. | |
Static Private Attributes | |
static constexpr std::array< rank_type, component_list::size()> | cummulative_alph_sizes |
The cumulative alphabet size products are cached. | |
template<typename type > | |
static constexpr bool | is_component = seqan3::list_traits::contains<type, component_list> |
Is set to true if the type is contained in the type list. | |
template<typename type > | |
static constexpr bool | is_unique_component = (seqan3::list_traits::count<type, component_list> == 1) |
Is set to true if the type is uniquely contained in the type list. | |
static constexpr bool | seqan3_alphabet_tuple_like = true |
Make specialisations of this template identifiable in metapgrogramming contexts. | |
Friends | |
Comparison operators (against indirect component_list) | |
These overloads enable comparison for all types that a component type is comparable with. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
template<typename derived_type_t , typename indirect_component_type > | |
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. | |
Comparison operators |
Constructors, destructor and assignment | |
| |
constexpr | alphabet_tuple_base () noexcept |
Defaulted. | |
constexpr | alphabet_tuple_base (alphabet_tuple_base const &)=default |
Defaulted. | |
constexpr | alphabet_tuple_base (alphabet_tuple_base &&)=default |
Defaulted. | |
constexpr alphabet_tuple_base & | operator= (alphabet_tuple_base const &)=default |
Defaulted. | |
constexpr alphabet_tuple_base & | operator= (alphabet_tuple_base &&)=default |
Defaulted. | |
~alphabet_tuple_base ()=default | |
Defaulted. | |
constexpr | alphabet_tuple_base (component_types... components) noexcept |
Construction from initialiser-list. | |
template<typename component_type > requires (!std::is_base_of_v<alphabet_tuple_base, component_type>) && is_unique_component<component_type> | |
constexpr | alphabet_tuple_base (component_type const alph) noexcept |
Construction via a value of one of the components. | |
template<typename indirect_component_type > requires ((detail::instantiate_if_v< detail::lazy<std::is_convertible, indirect_component_type, component_types>, detail::tuple_general_guard<derived_type, indirect_component_type, component_types...>> || ...)) | |
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. | |
template<typename component_type > requires (!std::derived_from<component_type, alphabet_tuple_base>) && is_unique_component<component_type> | |
constexpr derived_type & | operator= (component_type const alph) noexcept |
Assignment via a value of one of the components. | |
template<typename indirect_component_type > requires ((!std::derived_from<indirect_component_type, alphabet_tuple_base>) && (!is_unique_component<indirect_component_type>) && (std::assignable_from<component_types, indirect_component_type> || ...)) | |
constexpr derived_type & | operator= (indirect_component_type const alph) noexcept |
Assignment via a value of a subtype that is assignable to one of the components. | |
Read functions | |
All read operations are constant complexity. | |
template<typename type > requires is_unique_component<type> | |
constexpr | operator type () const noexcept |
Implicit cast to a single letter. Works only if the type is unique in the type list. | |
template<size_t index> | |
constexpr auto | get (alphabet_tuple_base &l) noexcept |
Tuple-like access to the contained components. | |
template<typename type > requires is_unique_component<type> | |
constexpr auto | get (alphabet_tuple_base &l) noexcept |
Tuple-like access to the contained components. | |
template<size_t index> | |
constexpr auto | get (alphabet_tuple_base const &l) noexcept |
Tuple-like access to the contained components. | |
template<typename type > requires is_unique_component<type> | |
constexpr type | get (alphabet_tuple_base const &l) noexcept |
Tuple-like access to the contained components. | |
Additional Inherited Members | |
Public Member Functions inherited from seqan3::alphabet_base< derived_type,(1 *... *alphabet_size< component_types >), void > | |
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 derived_type & | assign_char (char_type const chr) noexcept |
Assign from a character, implicitly converts invalid characters. | |
constexpr derived_type & | assign_rank (rank_type const c) noexcept |
Assign from a numeric value. | |
Static Public Attributes inherited from seqan3::alphabet_base< derived_type,(1 *... *alphabet_size< component_types >), void > | |
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. | |
Protected Types inherited from seqan3::alphabet_base< derived_type,(1 *... *alphabet_size< component_types >), void > | |
using | char_type = std::conditional_t< std::same_as< void, void >, char, void > |
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()). | |
Related Symbols inherited from semialphabet | |
template<cereal_output_archive archive_t, semialphabet alphabet_t> | |
alphabet_rank_t< alphabet_t > | save_minimal (archive_t const &, alphabet_t const &l) |
Save an alphabet letter to stream. | |
template<cereal_input_archive archive_t, typename wrapped_alphabet_t > | |
void | load_minimal (archive_t const &, wrapped_alphabet_t &&l, alphabet_rank_t< detail::strip_cereal_wrapper_t< wrapped_alphabet_t > > const &r) |
Restore an alphabet letter from a saved rank. | |
The CRTP base for a combined alphabet that contains multiple values of different alphabets at the same time.
.
component_types | Types of letters; must model seqan3::detail::writable_constexpr_semialphabet. |
This data structure is a CRTP base class for combined alphabets, where the different alphabet letters exist independently as a components, similar to a tuple.
Short description:
To make a derived class "complete", you should add at least the following:
|
inlineexplicitconstexprnoexcept |
Construction via a value of one of the components.
component_type | Must be one uniquely contained in the type list of the composite. |
alph | The value of a component that should be assigned. |
Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
inlineexplicitconstexprnoexcept |
Construction via a value of a subtype that is assignable to one of the components.
indirect_component_type | Type that models seqan3::weakly_assignable_from for one of the component types. |
alph | The value that should be assigned. |
Note that the value will be assigned to the FIRST type T that fulfils assignable_from<T, indirect_component_type>
, regardless if other types are also fit for assignment.
Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
inlineconstexprnoexcept |
Implicit cast to a single letter. Works only if the type is unique in the type list.
|
inlineconstexprnoexcept |
Assignment via a value of one of the components.
component_type | One of the component types. Must be uniquely contained in the type list of the composite. |
alph | The value of a component that should be assigned. |
Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
inlineconstexprnoexcept |
Assignment via a value of a subtype that is assignable to one of the components.
indirect_component_type | Type that models seqan3::weakly_assignable_from for one of the component types. |
alph | The value of a component that should be assigned. |
Note: Since the alphabet_tuple_base is a CRTP base class, we show the working examples with one of its derived classes (seqan3::qualified).
|
friend |
Tuple-like access to the contained components.
index | Return the i-th element. |
|
friend |
Tuple-like access to the contained components.
type | Return the element of specified type; only available if the type is unique in the set of components. |
|
friend |
Tuple-like access to the contained components.
index | Return the i-th element. |
|
friend |
Tuple-like access to the contained components.
type | Return the element of specified type; only available if the type is unique in the set of components. |
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
friend |
Comparison against types comparable with components.
indirect_component_type | Must be comparable with a component's type. |
lhs | Left-hand-side of comparison. |
rhs | Right-hand-side of comparison. |
true
or false
.To determine (in-)equality/order, it is first deduced which component the argument is comparable with. The tuple is then cast to that type and the resulting value compared with the argument.
|
staticconstexprprivate |
The cumulative alphabet size products are cached.
|
private |
Befriend the derived type so that it can instantiate.