SeqAn3  3.1.0
The Modern C++ library for sequence analysis.
type_traits.hpp
Go to the documentation of this file.
1 // -----------------------------------------------------------------------------------------------------
2 // Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
3 // Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
4 // This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5 // shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6 // -----------------------------------------------------------------------------------------------------
7 
13 #pragma once
14 
15 #include <seqan3/std/iterator>
16 #include <seqan3/std/ranges>
17 #include <type_traits>
18 
20 #include <seqan3/core/platform.hpp>
22 
23 // TODO(h-2): add innermost_reference instead of or addition to range_innermost_value?
24 
25 //NOTE(h-2): for the range overloads we explicitly forbid that the type is iteratoer
26 // because some types are actually both (e.g. std::directory_iterator)
27 
28 namespace seqan3::detail
29 {
30 
32 template <typename t>
33 SEQAN3_CONCEPT has_range_value_type = requires { typename std::ranges::range_value_t<std::remove_cvref_t<t>>; };
35 
38 template <bool const_range, typename range_t>
40 
43 template <bool const_range, typename range_t>
44 using maybe_const_iterator_t = std::ranges::iterator_t<maybe_const_range_t<const_range, range_t>>;
45 
48 template <bool const_v, typename range_t>
49 using maybe_const_sentinel_t = std::ranges::sentinel_t<maybe_const_range_t<const_v, range_t>>;
50 } // namespace seqan3::detail
51 
52 namespace seqan3
53 {
54 
55 // ----------------------------------------------------------------------------
56 // range_innermost_value
57 // ----------------------------------------------------------------------------
58 
69 template <typename t>
71  requires detail::has_range_value_type<t>
74 {
76  using type = std::ranges::range_value_t<std::remove_cvref_t<t>>;
77 };
78 
80 template <typename t>
81  requires detail::has_range_value_type<t> && detail::has_range_value_type<std::ranges::range_value_t<std::remove_cvref_t<t>>>
82 struct range_innermost_value<t>
83 {
85 };
87 
91 template <typename t>
93 
94 // ----------------------------------------------------------------------------
95 // range_dimension_v
96 // ----------------------------------------------------------------------------
97 
107 template <typename t>
109  requires detail::has_range_value_type<t>
111 constexpr size_t range_dimension_v = 1;
112 
114 template <typename t>
115  requires detail::has_range_value_type<t> && detail::has_range_value_type<std::ranges::range_value_t<std::remove_cvref_t<t>>>
116 constexpr size_t range_dimension_v<t> = range_dimension_v<std::ranges::range_value_t<std::remove_cvref_t<t>>> + 1;
118 
119 } // namespace seqan3
Provides various type traits on generic types.
constexpr size_t range_dimension_v
Returns the number of times you can call seqan3::value_type_t recursively on t (type trait).
Definition: type_traits.hpp:111
typename range_innermost_value< t >::type range_innermost_value_t
Shortcut for seqan3::range_innermost_value (transformation_trait shortcut).
Definition: type_traits.hpp:92
Provides various transformation traits for use on iterators.
The <iterator> header from C++20's standard library.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Provides platform and dependency checks.
The <ranges> header from C++20's standard library.
Recursively determines the value_type on containers and/or iterators.
Definition: type_traits.hpp:74
std::ranges::range_value_t< std::remove_cvref_t< t > > type
The return type (recursion not shown).
Definition: type_traits.hpp:76