xref: /freebsd-src/contrib/llvm-project/libcxx/include/__ranges/concepts.h (revision 4824e7fd18a1223177218d4aec1b3c6c5c4a444e)
1fe6060f1SDimitry Andric // -*- C++ -*-
2349cc55cSDimitry Andric //===----------------------------------------------------------------------===//
3fe6060f1SDimitry Andric //
4fe6060f1SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5fe6060f1SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
6fe6060f1SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7fe6060f1SDimitry Andric //
8fe6060f1SDimitry Andric //===----------------------------------------------------------------------===//
9fe6060f1SDimitry Andric #ifndef _LIBCPP___RANGES_CONCEPTS_H
10fe6060f1SDimitry Andric #define _LIBCPP___RANGES_CONCEPTS_H
11fe6060f1SDimitry Andric 
12fe6060f1SDimitry Andric #include <__config>
13fe6060f1SDimitry Andric #include <__iterator/concepts.h>
14fe6060f1SDimitry Andric #include <__iterator/incrementable_traits.h>
15fe6060f1SDimitry Andric #include <__iterator/iter_move.h>
16fe6060f1SDimitry Andric #include <__iterator/iterator_traits.h>
17fe6060f1SDimitry Andric #include <__iterator/readable_traits.h>
18fe6060f1SDimitry Andric #include <__ranges/access.h>
19fe6060f1SDimitry Andric #include <__ranges/data.h>
20*4824e7fdSDimitry Andric #include <__ranges/enable_borrowed_range.h>
21fe6060f1SDimitry Andric #include <__ranges/enable_view.h>
22fe6060f1SDimitry Andric #include <__ranges/size.h>
23fe6060f1SDimitry Andric #include <concepts>
24fe6060f1SDimitry Andric #include <type_traits>
25fe6060f1SDimitry Andric 
26fe6060f1SDimitry Andric #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
27fe6060f1SDimitry Andric #pragma GCC system_header
28fe6060f1SDimitry Andric #endif
29fe6060f1SDimitry Andric 
30fe6060f1SDimitry Andric _LIBCPP_BEGIN_NAMESPACE_STD
31fe6060f1SDimitry Andric 
32fe6060f1SDimitry Andric // clang-format off
33fe6060f1SDimitry Andric 
34fe6060f1SDimitry Andric #if !defined(_LIBCPP_HAS_NO_RANGES)
35fe6060f1SDimitry Andric 
36fe6060f1SDimitry Andric namespace ranges {
37fe6060f1SDimitry Andric   // [range.range]
38fe6060f1SDimitry Andric   template <class _Tp>
39fe6060f1SDimitry Andric   concept range = requires(_Tp& __t) {
40fe6060f1SDimitry Andric     ranges::begin(__t); // sometimes equality-preserving
41fe6060f1SDimitry Andric     ranges::end(__t);
42fe6060f1SDimitry Andric   };
43fe6060f1SDimitry Andric 
44fe6060f1SDimitry Andric   template<class _Range>
45fe6060f1SDimitry Andric   concept borrowed_range = range<_Range> &&
46fe6060f1SDimitry Andric     (is_lvalue_reference_v<_Range> || enable_borrowed_range<remove_cvref_t<_Range>>);
47fe6060f1SDimitry Andric 
48fe6060f1SDimitry Andric   // `iterator_t` defined in <__ranges/access.h>
49fe6060f1SDimitry Andric 
50fe6060f1SDimitry Andric   template <range _Rp>
51fe6060f1SDimitry Andric   using sentinel_t = decltype(ranges::end(declval<_Rp&>()));
52fe6060f1SDimitry Andric 
53fe6060f1SDimitry Andric   template <range _Rp>
54fe6060f1SDimitry Andric   using range_difference_t = iter_difference_t<iterator_t<_Rp>>;
55fe6060f1SDimitry Andric 
56fe6060f1SDimitry Andric   template <range _Rp>
57fe6060f1SDimitry Andric   using range_value_t = iter_value_t<iterator_t<_Rp>>;
58fe6060f1SDimitry Andric 
59fe6060f1SDimitry Andric   template <range _Rp>
60fe6060f1SDimitry Andric   using range_reference_t = iter_reference_t<iterator_t<_Rp>>;
61fe6060f1SDimitry Andric 
62fe6060f1SDimitry Andric   template <range _Rp>
63fe6060f1SDimitry Andric   using range_rvalue_reference_t = iter_rvalue_reference_t<iterator_t<_Rp>>;
64fe6060f1SDimitry Andric 
65fe6060f1SDimitry Andric   // [range.sized]
66fe6060f1SDimitry Andric   template <class _Tp>
67fe6060f1SDimitry Andric   concept sized_range = range<_Tp> && requires(_Tp& __t) { ranges::size(__t); };
68fe6060f1SDimitry Andric 
69fe6060f1SDimitry Andric   template<sized_range _Rp>
70fe6060f1SDimitry Andric   using range_size_t = decltype(ranges::size(declval<_Rp&>()));
71fe6060f1SDimitry Andric 
72fe6060f1SDimitry Andric   // `disable_sized_range` defined in `<__ranges/size.h>`
73fe6060f1SDimitry Andric 
74fe6060f1SDimitry Andric   // [range.view], views
75fe6060f1SDimitry Andric 
76fe6060f1SDimitry Andric   // `enable_view` defined in <__ranges/enable_view.h>
77fe6060f1SDimitry Andric   // `view_base` defined in <__ranges/enable_view.h>
78fe6060f1SDimitry Andric 
79fe6060f1SDimitry Andric   template <class _Tp>
80fe6060f1SDimitry Andric   concept view =
81fe6060f1SDimitry Andric     range<_Tp> &&
82fe6060f1SDimitry Andric     movable<_Tp> &&
83fe6060f1SDimitry Andric     enable_view<_Tp>;
84fe6060f1SDimitry Andric 
85fe6060f1SDimitry Andric   template<class _Range>
86fe6060f1SDimitry Andric   concept __simple_view =
87fe6060f1SDimitry Andric     view<_Range> && range<const _Range> &&
88fe6060f1SDimitry Andric     same_as<iterator_t<_Range>, iterator_t<const _Range>> &&
89fe6060f1SDimitry Andric     same_as<sentinel_t<_Range>, iterator_t<const _Range>>;
90fe6060f1SDimitry Andric 
91fe6060f1SDimitry Andric   // [range.refinements], other range refinements
92fe6060f1SDimitry Andric   template <class _Rp, class _Tp>
93fe6060f1SDimitry Andric   concept output_range = range<_Rp> && output_iterator<iterator_t<_Rp>, _Tp>;
94fe6060f1SDimitry Andric 
95fe6060f1SDimitry Andric   template <class _Tp>
96fe6060f1SDimitry Andric   concept input_range = range<_Tp> && input_iterator<iterator_t<_Tp>>;
97fe6060f1SDimitry Andric 
98fe6060f1SDimitry Andric   template <class _Tp>
99fe6060f1SDimitry Andric   concept forward_range = input_range<_Tp> && forward_iterator<iterator_t<_Tp>>;
100fe6060f1SDimitry Andric 
101fe6060f1SDimitry Andric   template <class _Tp>
102fe6060f1SDimitry Andric   concept bidirectional_range = forward_range<_Tp> && bidirectional_iterator<iterator_t<_Tp>>;
103fe6060f1SDimitry Andric 
104fe6060f1SDimitry Andric   template <class _Tp>
105fe6060f1SDimitry Andric   concept random_access_range =
106fe6060f1SDimitry Andric       bidirectional_range<_Tp> && random_access_iterator<iterator_t<_Tp>>;
107fe6060f1SDimitry Andric 
108fe6060f1SDimitry Andric   template<class _Tp>
109fe6060f1SDimitry Andric   concept contiguous_range =
110fe6060f1SDimitry Andric     random_access_range<_Tp> &&
111fe6060f1SDimitry Andric     contiguous_iterator<iterator_t<_Tp>> &&
112fe6060f1SDimitry Andric     requires(_Tp& __t) {
113fe6060f1SDimitry Andric       { ranges::data(__t) } -> same_as<add_pointer_t<range_reference_t<_Tp>>>;
114fe6060f1SDimitry Andric     };
115fe6060f1SDimitry Andric 
116fe6060f1SDimitry Andric   template <class _Tp>
117fe6060f1SDimitry Andric   concept common_range = range<_Tp> && same_as<iterator_t<_Tp>, sentinel_t<_Tp>>;
118fe6060f1SDimitry Andric 
119fe6060f1SDimitry Andric   template<class _Tp>
120fe6060f1SDimitry Andric   concept viewable_range =
121fe6060f1SDimitry Andric     range<_Tp> && (
122fe6060f1SDimitry Andric       (view<remove_cvref_t<_Tp>> && constructible_from<remove_cvref_t<_Tp>, _Tp>) ||
123fe6060f1SDimitry Andric       (!view<remove_cvref_t<_Tp>> && borrowed_range<_Tp>)
124fe6060f1SDimitry Andric     );
125fe6060f1SDimitry Andric } // namespace ranges
126fe6060f1SDimitry Andric 
127fe6060f1SDimitry Andric #endif // !defined(_LIBCPP_HAS_NO_RANGES)
128fe6060f1SDimitry Andric 
129fe6060f1SDimitry Andric // clang-format on
130fe6060f1SDimitry Andric 
131fe6060f1SDimitry Andric _LIBCPP_END_NAMESPACE_STD
132fe6060f1SDimitry Andric 
133fe6060f1SDimitry Andric #endif // _LIBCPP___RANGES_CONCEPTS_H
134