Additional helper utilities for "tuple" types like std::tuple, std::pair, seqan3::pod_tuple that are not specific to a SeqAn module. More...
Classes | |
interface | pair_like |
Whether a type behaves like a tuple with exactly two elements. More... | |
struct | seqan3::pod_tuple< type0 > |
Recursion anchor for seqan3::pod_tuple. More... | |
struct | seqan3::pod_tuple< type0, types... > |
Behaves like std::tuple but is an aggregate PODType. More... | |
interface | tuple_like |
Whether a type behaves like a tuple. More... | |
Typedefs | |
using | seqan3::common_pair = ::ranges::common_pair |
A common pair type that behaves like a regular std::pair, but can be used as a reference type proxy for output iterators. More... | |
using | seqan3::common_tuple = ::ranges::common_tuple |
A common tuple type that behaves like a regular std::tuple, but can be used as a reference type proxy for output iterators. More... | |
Functions | |
template<tuple_like tuple_t> | |
constexpr auto | seqan3::tuple_pop_front (tuple_t &&t) |
Removes the first element of a tuple. More... | |
template<typename pivot_t , tuple_like tuple_t> | |
constexpr auto | seqan3::tuple_split (tuple_t &&t) |
Splits a tuple like data structure at the first position of the given type. More... | |
template<size_t pivot_c, template< typename ... > typename tuple_t, typename ... ts> | |
constexpr auto | seqan3::tuple_split (tuple_t< ts... > const &t) |
Splits a tuple like data structure at the given position. More... | |
Additional helper utilities for "tuple" types like std::tuple, std::pair, seqan3::pod_tuple that are not specific to a SeqAn module.
using seqan3::common_pair = typedef ::ranges::common_pair |
A common pair type that behaves like a regular std::pair, but can be used as a reference type proxy for output iterators.
Alias definition of the ranges::common_pair.
using seqan3::common_tuple = typedef ::ranges::common_tuple |
A common tuple type that behaves like a regular std::tuple, but can be used as a reference type proxy for output iterators.
Alias definition of the ranges::common_tuple.
|
constexpr |
Removes the first element of a tuple.
[in] | t | The original tuple. |
t
.Note, that the tuple must contain at least one element and must support empty tuple types, i.e. std::pair cannot be used.
Linear in the number of elements.
Concurrent invocations of this functions are thread safe.
|
constexpr |
Splits a tuple like data structure at the first position of the given type.
pivot_t | A template type specifying the split position. |
[in] | t | The original tuple to split. |
Splits a tuple into two tuples, while the element at the split position will be contained in the second tuple. Note, that the returned tuples can be empty. For this reason it is not possible to use tuple like objects, that cannot be empty, i.e. std::pair. Using such an object will emit an compiler error.
Linear in the number of elements.
Concurrent invocations of this functions are thread safe.
|
constexpr |
Splits a tuple like data structure at the given position.
pivot_c | A template value specifying the split position. |
tuple_t | A template alias for a tuple like object. |
...ts | Types tuple_t is specified with. |
[in] | t | The original tuple to split. |
Splits a tuple into two tuples, while the element at the split position will be contained in the second tuple. Note, that the returned tuples can be empty. For this reason it is not possible to use tuple like objects, that cannot be empty, i.e. std::pair. Using such an object will emit an compiler error.
Linear in the number of elements.
Concurrent invocations of this functions are thread safe.