Loading...
Searching...
No Matches
traits.hpp File Reference

Provides various traits for template packs. More...

`#include <type_traits>`
`#include <utility>`
`#include <seqan3/utility/type_list/type_list.hpp>`
Include dependency graph for type_pack/traits.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Namespaces

namespace | seqan3
| The main SeqAn3 namespace.
namespace | seqan3::pack_traits
| Namespace containing traits for working on type packs.

## Typedefs

Type pack traits (return a single type)
template<ptrdiff_t idx, typename... pack_t>
using | seqan3::pack_traits::at = typename decltype(detail::at<idx, pack_t...>())::type
| Return the type at given index from the type pack.
template<typename... pack_t>
using | seqan3::pack_traits::back = typename decltype((std::type_identity<pack_t>{}, ...))::type
| Return the last type from the type pack.
template<typename... pack_t>
using | seqan3::pack_traits::front = typename decltype(detail::front<pack_t...>())::type
| Return the first type from the type pack.
Type pack traits (return a type list)
template<ptrdiff_t i, typename... pack_t>
using | seqan3::pack_traits::drop = typename decltype(detail::split_after<i, pack_t...>(type_list<>{}))::second_type
| Return a seqan3::type_list of the types in the type pack, except the first n.
template<typename... pack_t>
using | seqan3::pack_traits::drop_front = typename decltype(detail::drop_front<pack_t...>())::type
| Return a seqan3::type_list of all the types in the type pack, except the first.
template<ptrdiff_t i, typename... pack_t>
using | seqan3::pack_traits::drop_last = take<size<pack_t...> - i, pack_t...>
| Return a seqan3::type_list of the types the type pack, except the last n.
template<typename replace_t, std::ptrdiff_t i, typename... pack_t>
using | seqan3::pack_traits::replace_at = decltype(detail::replace_at<replace_t, i, pack_t...>(std::make_index_sequence<size<pack_t...>>{}))
| Replace the type at the given index with the given type.
template<ptrdiff_t i, typename... pack_t>
using | seqan3::pack_traits::split_after = decltype(detail::split_after<i, pack_t...>(type_list<>{}))
| Split a type pack into two parts returned as a pair of seqan3::type_list.
template<ptrdiff_t i, typename... pack_t>
using | seqan3::pack_traits::take = typename decltype(detail::split_after<i, pack_t...>(type_list<>{}))::first_type
| Return a seqan3::type_list of the first n types in the type pack.
template<ptrdiff_t i, typename... pack_t>
using | seqan3::pack_traits::take_last = drop<size<pack_t...> - i, pack_t...>
| Return a seqan3::type_list of the last n types in the type pack.
template<template< typename > typename trait_t, typename... pack_t>
using | seqan3::pack_traits::transform = seqan3::type_list<trait_t<pack_t>...>
| Apply a transformation trait to every type in the pack and return a seqan3::type_list of the results.

## Functions

template<ptrdiff_t idx, typename head_t, typename... tail_t>
auto | seqan3::pack_traits::detail::at ()
| Implementation for seqan3::pack_traits::at.
template<typename head_t, typename... tail_t>
type_list< tail_t... > | seqan3::pack_traits::detail::drop_front ()
| Implementation for seqan3::pack_traits::drop_front.
template<typename query_t, typename... pack_t>
constexpr ptrdiff_t | seqan3::pack_traits::detail::find ()
| Implementation for seqan3::pack_traits::find.
template<template< typename > typename pred_t, typename... pack_t>
constexpr ptrdiff_t | seqan3::pack_traits::detail::find_if ()
| Implementation for seqan3::pack_traits::find_if.
template<typename head_t, typename... tail_t>
std::type_identity< head_t > | seqan3::pack_traits::detail::front ()
| Implementation for seqan3::pack_traits::front.
template<typename replace_t, ptrdiff_t idx, typename... pack_t, size_t... i>
auto | seqan3::pack_traits::detail::replace_at (std::index_sequence< i... >) -> type_list< std::conditional_t< i==idx, replace_t, pack_t >... >
| Implementation for seqan3::pack_traits::replace_at.
template<ptrdiff_t idx, typename head_t, typename... pack2_t, typename... pack1_t>
auto | seqan3::pack_traits::detail::split_after (type_list< pack1_t... >)
| Implementation for seqan3::pack_traits::split_after.

## Variables

Type pack traits (return a value)
template<typename query_t, typename... pack_t>
constexpr bool | seqan3::pack_traits::contains = (find<query_t, pack_t...> != -1)
| Whether a type occurs in a pack or not.
template<typename query_t, typename... pack_t>
constexpr ptrdiff_t | seqan3::pack_traits::count = (std::is_same_v<query_t, pack_t> + ... + 0)
| Count the occurrences of a type in a pack.
template<typename query_t, typename... pack_t>
constexpr ptrdiff_t | seqan3::pack_traits::find = seqan3::pack_traits::detail::find<query_t, pack_t...>()
| Get the index of the first occurrence of a type in a pack.
template<template< typename > typename pred_t, typename... pack_t>
constexpr ptrdiff_t | seqan3::pack_traits::find_if = seqan3::pack_traits::detail::find_if<pred_t, pack_t...>()
| Get the index of the first type in a pack that satisfies the given predicate.
template<typename... pack_t>
constexpr size_t | seqan3::pack_traits::size = sizeof...(pack_t)
| The size of a type pack.

## Detailed Description

Provides various traits for template packs.

Author
  Rene Rahn <rene.rahn AT fu-berlin.de>

Hide me