xref: /freebsd/contrib/llvm-project/libcxx/include/__ranges/concepts.h (revision 81ad626541db97eb356e2c1d4a20eb2a26a766ab)
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 
1204eeddc0SDimitry Andric #include <__concepts/constructible.h>
1304eeddc0SDimitry Andric #include <__concepts/movable.h>
1404eeddc0SDimitry Andric #include <__concepts/same_as.h>
15fe6060f1SDimitry Andric #include <__config>
16fe6060f1SDimitry Andric #include <__iterator/concepts.h>
17fe6060f1SDimitry Andric #include <__iterator/incrementable_traits.h>
18fe6060f1SDimitry Andric #include <__iterator/iter_move.h>
19fe6060f1SDimitry Andric #include <__iterator/iterator_traits.h>
20fe6060f1SDimitry Andric #include <__iterator/readable_traits.h>
21fe6060f1SDimitry Andric #include <__ranges/access.h>
22fe6060f1SDimitry Andric #include <__ranges/data.h>
234824e7fdSDimitry Andric #include <__ranges/enable_borrowed_range.h>
24fe6060f1SDimitry Andric #include <__ranges/enable_view.h>
25fe6060f1SDimitry Andric #include <__ranges/size.h>
2604eeddc0SDimitry Andric #include <initializer_list>
27fe6060f1SDimitry Andric #include <type_traits>
28fe6060f1SDimitry Andric 
29fe6060f1SDimitry Andric #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
30fe6060f1SDimitry Andric #  pragma GCC system_header
31fe6060f1SDimitry Andric #endif
32fe6060f1SDimitry Andric 
33fe6060f1SDimitry Andric _LIBCPP_BEGIN_NAMESPACE_STD
34fe6060f1SDimitry Andric 
35*81ad6265SDimitry Andric #if _LIBCPP_STD_VER > 17
36fe6060f1SDimitry Andric 
37fe6060f1SDimitry Andric namespace ranges {
38d56accc7SDimitry Andric 
39fe6060f1SDimitry Andric   // [range.range]
40d56accc7SDimitry Andric 
41fe6060f1SDimitry Andric   template <class _Tp>
42fe6060f1SDimitry Andric   concept range = requires(_Tp& __t) {
43fe6060f1SDimitry Andric     ranges::begin(__t); // sometimes equality-preserving
44fe6060f1SDimitry Andric     ranges::end(__t);
45fe6060f1SDimitry Andric   };
46fe6060f1SDimitry Andric 
47d56accc7SDimitry Andric   template <class _Tp>
48d56accc7SDimitry Andric   concept input_range = range<_Tp> && input_iterator<iterator_t<_Tp>>;
49d56accc7SDimitry Andric 
50fe6060f1SDimitry Andric   template<class _Range>
51fe6060f1SDimitry Andric   concept borrowed_range = range<_Range> &&
52fe6060f1SDimitry Andric     (is_lvalue_reference_v<_Range> || enable_borrowed_range<remove_cvref_t<_Range>>);
53fe6060f1SDimitry Andric 
54fe6060f1SDimitry Andric   // `iterator_t` defined in <__ranges/access.h>
55fe6060f1SDimitry Andric 
56fe6060f1SDimitry Andric   template <range _Rp>
57fe6060f1SDimitry Andric   using sentinel_t = decltype(ranges::end(declval<_Rp&>()));
58fe6060f1SDimitry Andric 
59fe6060f1SDimitry Andric   template <range _Rp>
60fe6060f1SDimitry Andric   using range_difference_t = iter_difference_t<iterator_t<_Rp>>;
61fe6060f1SDimitry Andric 
62fe6060f1SDimitry Andric   template <range _Rp>
63fe6060f1SDimitry Andric   using range_value_t = iter_value_t<iterator_t<_Rp>>;
64fe6060f1SDimitry Andric 
65fe6060f1SDimitry Andric   template <range _Rp>
66fe6060f1SDimitry Andric   using range_reference_t = iter_reference_t<iterator_t<_Rp>>;
67fe6060f1SDimitry Andric 
68fe6060f1SDimitry Andric   template <range _Rp>
69fe6060f1SDimitry Andric   using range_rvalue_reference_t = iter_rvalue_reference_t<iterator_t<_Rp>>;
70fe6060f1SDimitry Andric 
71fe6060f1SDimitry Andric   // [range.sized]
72fe6060f1SDimitry Andric   template <class _Tp>
73fe6060f1SDimitry Andric   concept sized_range = range<_Tp> && requires(_Tp& __t) { ranges::size(__t); };
74fe6060f1SDimitry Andric 
75fe6060f1SDimitry Andric   template<sized_range _Rp>
76fe6060f1SDimitry Andric   using range_size_t = decltype(ranges::size(declval<_Rp&>()));
77fe6060f1SDimitry Andric 
78fe6060f1SDimitry Andric   // `disable_sized_range` defined in `<__ranges/size.h>`
79fe6060f1SDimitry Andric 
80fe6060f1SDimitry Andric   // [range.view], views
81fe6060f1SDimitry Andric 
82fe6060f1SDimitry Andric   // `enable_view` defined in <__ranges/enable_view.h>
83fe6060f1SDimitry Andric   // `view_base` defined in <__ranges/enable_view.h>
84fe6060f1SDimitry Andric 
85fe6060f1SDimitry Andric   template <class _Tp>
86fe6060f1SDimitry Andric   concept view =
87fe6060f1SDimitry Andric     range<_Tp> &&
88fe6060f1SDimitry Andric     movable<_Tp> &&
89fe6060f1SDimitry Andric     enable_view<_Tp>;
90fe6060f1SDimitry Andric 
91fe6060f1SDimitry Andric   template <class _Range>
92fe6060f1SDimitry Andric   concept __simple_view =
93fe6060f1SDimitry Andric     view<_Range> && range<const _Range> &&
94fe6060f1SDimitry Andric     same_as<iterator_t<_Range>, iterator_t<const _Range>> &&
9504eeddc0SDimitry Andric     same_as<sentinel_t<_Range>, sentinel_t<const _Range>>;
96fe6060f1SDimitry Andric 
97fe6060f1SDimitry Andric   // [range.refinements], other range refinements
98fe6060f1SDimitry Andric   template <class _Rp, class _Tp>
99fe6060f1SDimitry Andric   concept output_range = range<_Rp> && output_iterator<iterator_t<_Rp>, _Tp>;
100fe6060f1SDimitry Andric 
101fe6060f1SDimitry Andric   template <class _Tp>
102fe6060f1SDimitry Andric   concept forward_range = input_range<_Tp> && forward_iterator<iterator_t<_Tp>>;
103fe6060f1SDimitry Andric 
104fe6060f1SDimitry Andric   template <class _Tp>
105fe6060f1SDimitry Andric   concept bidirectional_range = forward_range<_Tp> && bidirectional_iterator<iterator_t<_Tp>>;
106fe6060f1SDimitry Andric 
107fe6060f1SDimitry Andric   template <class _Tp>
108fe6060f1SDimitry Andric   concept random_access_range =
109fe6060f1SDimitry Andric       bidirectional_range<_Tp> && random_access_iterator<iterator_t<_Tp>>;
110fe6060f1SDimitry Andric 
111fe6060f1SDimitry Andric   template<class _Tp>
112fe6060f1SDimitry Andric   concept contiguous_range =
113fe6060f1SDimitry Andric     random_access_range<_Tp> &&
114fe6060f1SDimitry Andric     contiguous_iterator<iterator_t<_Tp>> &&
115fe6060f1SDimitry Andric     requires(_Tp& __t) {
116fe6060f1SDimitry Andric       { ranges::data(__t) } -> same_as<add_pointer_t<range_reference_t<_Tp>>>;
117fe6060f1SDimitry Andric     };
118fe6060f1SDimitry Andric 
119fe6060f1SDimitry Andric   template <class _Tp>
120fe6060f1SDimitry Andric   concept common_range = range<_Tp> && same_as<iterator_t<_Tp>, sentinel_t<_Tp>>;
121fe6060f1SDimitry Andric 
122fe6060f1SDimitry Andric   template <class _Tp>
12304eeddc0SDimitry Andric   inline constexpr bool __is_std_initializer_list = false;
12404eeddc0SDimitry Andric 
12504eeddc0SDimitry Andric   template <class _Ep>
12604eeddc0SDimitry Andric   inline constexpr bool __is_std_initializer_list<initializer_list<_Ep>> = true;
12704eeddc0SDimitry Andric 
12804eeddc0SDimitry Andric   template <class _Tp>
129fe6060f1SDimitry Andric   concept viewable_range =
13004eeddc0SDimitry Andric     range<_Tp> &&
13104eeddc0SDimitry Andric     ((view<remove_cvref_t<_Tp>> && constructible_from<remove_cvref_t<_Tp>, _Tp>) ||
13204eeddc0SDimitry Andric      (!view<remove_cvref_t<_Tp>> &&
13304eeddc0SDimitry Andric       (is_lvalue_reference_v<_Tp> ||
13404eeddc0SDimitry Andric        (movable<remove_reference_t<_Tp>> && !__is_std_initializer_list<remove_cvref_t<_Tp>>))));
13504eeddc0SDimitry Andric 
136fe6060f1SDimitry Andric } // namespace ranges
137fe6060f1SDimitry Andric 
138*81ad6265SDimitry Andric #endif // _LIBCPP_STD_VER > 17
139fe6060f1SDimitry Andric 
140fe6060f1SDimitry Andric _LIBCPP_END_NAMESPACE_STD
141fe6060f1SDimitry Andric 
142fe6060f1SDimitry Andric #endif // _LIBCPP___RANGES_CONCEPTS_H
143