Utility

Provides additional utility functionality used by multiple modules. More...

Collaboration diagram for Utility:

Modules
	Concept
	Builtin Character Operations
	Provides various operations on character types.
	Parallel
	This module contains types and utilities for concurrent execution of algorithms in SeqAn.
	Tuple
	Additional helper utilities for "tuple" types like std::tuple, std::pair, seqan3::pod_tuple that are not specific to a SeqAn module.
	Type List
	Provides seqan3::type_list and metaprogramming utilities for working on type lists.
	Type Pack
	Provides metaprogramming utilities for working on template parameter packs.
	Type Traits
	Provides various type traits and their shortcuts.

Classes
interface	pair_like
	Whether a type behaves like a tuple with exactly two elements. 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...

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...

Detailed Descriptionno-api

Provides additional utility functionality used by multiple modules.

The utility module contains concepts, functions, traits and classes that are independent of the remaining modules in SeqAn. These implementations are considered external functionality, i.e. they could have been outsourced into their own libraries.

The utility module has no dependency to any other module except the Core module.

Function Documentation

tuple_pop_front()

template<tuple_like tuple_t>

constexpr auto seqan3::tuple_pop_front ( tuple_t &&  t )

no-apiconstexpr

Removes the first element of a tuple.

Parameters

[in]

t

The original tuple.

Returns

A new tuple without the first element of t.

Note, that the tuple must contain at least one element and must support empty tuple types, i.e. std::pair cannot be used.

Complexity

Linear in the number of elements.

Thread safety

Concurrent invocations of this functions are thread safe.

tuple_split() [1/2]

template<typename pivot_t , tuple_like tuple_t>

constexpr auto seqan3::tuple_split ( tuple_t &&  t )

no-apiconstexpr

Splits a tuple like data structure at the first position of the given type.

Template Parameters

pivot_t

A template type specifying the split position.

Parameters

[in]

t

The original tuple to split.

Returns

A new tuple of tuples with the left side of the split and the right side of the 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.

example

#include <seqan3/utility/tuple/split.hpp>
 
int main()
{
    // Split at position 2.
    std::tuple<int, char, float, std::string> t{1, 'c', 0.3, "hello"};
    auto [left, right] = seqan3::tuple_split<2>(t);
    // decltype(left) -> std::tuple<int, char>; decltype(right) -> std::tuple<float, std::string>;
 
    // Split at position 0.
    auto [left1, right1] = seqan3::tuple_split<0>(t);
    // decltype(left1) -> std::tuple<>; decltype(right1) -> std::tuple<int, char, float, std::string>;
 
    // Split at position 4.
    auto [left2, right2] = seqan3::tuple_split<4>(t);
    // decltype(left2) -> std::tuple<int, char, float, std::string>; decltype(right2) -> std::tuple<>;
}

Complexity

Linear in the number of elements.

Thread safety

Concurrent invocations of this functions are thread safe.

tuple_split() [2/2]

template<size_t pivot_c, template< typename ... > typename tuple_t, typename ... ts>

constexpr auto seqan3::tuple_split ( tuple_t< ts... > const &  t )

no-apiconstexpr

Splits a tuple like data structure at the given position.

Template Parameters

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.

Parameters

[in]

t

The original tuple to split.

Returns

A new tuple of tuples with the left side of the split and the right side of the 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.

example

#include <seqan3/utility/tuple/split.hpp>
 
int main()
{
    // Split at position 2.
    std::tuple<int, char, float, std::string> t{1, 'c', 0.3, "hello"};
    auto [left, right] = seqan3::tuple_split<2>(t);
    // decltype(left) -> std::tuple<int, char>; decltype(right) -> std::tuple<float, std::string>;
 
    // Split at position 0.
    auto [left1, right1] = seqan3::tuple_split<0>(t);
    // decltype(left1) -> std::tuple<>; decltype(right1) -> std::tuple<int, char, float, std::string>;
 
    // Split at position 4.
    auto [left2, right2] = seqan3::tuple_split<4>(t);
    // decltype(left2) -> std::tuple<int, char, float, std::string>; decltype(right2) -> std::tuple<>;
}

Complexity

Linear in the number of elements.

Thread safety

Concurrent invocations of this functions are thread safe.