SeqAn3  3.1.0-rc.1
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 
68 template <typename t>
70  requires detail::has_range_value_type<t>
73 {
75  using type = std::ranges::range_value_t<std::remove_cvref_t<t>>;
76 };
77 
79 template <typename t>
80  requires detail::has_range_value_type<t> && detail::has_range_value_type<std::ranges::range_value_t<std::remove_cvref_t<t>>>
81 struct range_innermost_value<t>
82 {
84 };
86 
90 template <typename t>
92 
93 // ----------------------------------------------------------------------------
94 // range_dimension_v
95 // ----------------------------------------------------------------------------
96 
106 template <typename t>
108  requires detail::has_range_value_type<t>
110 constexpr size_t range_dimension_v = 1;
111 
113 template <typename t>
114  requires detail::has_range_value_type<t> && detail::has_range_value_type<std::ranges::range_value_t<std::remove_cvref_t<t>>>
115 constexpr size_t range_dimension_v<t> = range_dimension_v<std::ranges::range_value_t<std::remove_cvref_t<t>>> + 1;
117 
118 } // namespace seqan3
Provides various type traits on generic types.
std::ranges::sentinel_t< maybe_const_range_t< const_v, range_t > > maybe_const_sentinel_t
Returns the const sentinel of range_t if const_range is true; otherwise the non-const sentinel.
Definition: type_traits.hpp:49
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:110
std::ranges::iterator_t< maybe_const_range_t< const_range, range_t > > maybe_const_iterator_t
Returns the const iterator of range_t if const_range is true; otherwise the non-const iterator.
Definition: type_traits.hpp:44
typename range_innermost_value< t >::type range_innermost_value_t
Shortcut for seqan3::range_innermost_value (transformation_trait shortcut).
Definition: type_traits.hpp:91
Provides various transformation traits for use on iterators.
Provides C++20 additions to the <iterator> header.
The internal SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Provides platform and dependency checks.
Adaptations of concepts from the Ranges TS.
Recursively determines the value_type on containers and/or iterators.
Definition: type_traits.hpp:73
std::ranges::range_value_t< std::remove_cvref_t< t > > type
The return type (recursion not shown).
Definition: type_traits.hpp:75