blob: 505ade904223aeaae8be64895bbaadf3356994e6 [file] [log] [blame]
Eric Fiselierd59a0322020-04-08 18:00:13 -04001// -*- C++ -*-
2//===-------------------------- concepts ----------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_CONCEPTS
11#define _LIBCPP_CONCEPTS
12
13/*
14 concepts synopsis
15namespace std {
16 // [concepts.lang], language-related concepts
17 // [concept.same], concept same_as
18 template<class T, class U>
19 concept same_as = see below;
20
21 // [concept.derived], concept derived_from
22 template<class Derived, class Base>
23 concept derived_from = see below;
24
25 // [concept.convertible], concept convertible_to
26 template<class From, class To>
27 concept convertible_to = see below;
28
29 // [concept.commonref], concept common_reference_with
30 template<class T, class U>
31 concept common_reference_with = see below;
32
33 // [concept.common], concept common_with
34 template<class T, class U>
35 concept common_with = see below;
36
37 // [concepts.arithmetic], arithmetic concepts
38 template<class T>
39 concept integral = see below;
40 template<class T>
41 concept signed_integral = see below;
42 template<class T>
43 concept unsigned_integral = see below;
44 template<class T>
45 concept floating_point = see below;
46
47 // [concept.assignable], concept assignable_from
48 template<class LHS, class RHS>
49 concept assignable_from = see below;
50
51 // [concept.swappable], concept swappable
52 namespace ranges {
53 inline namespace unspecified {
54 inline constexpr unspecified swap = unspecified;
55 }
56 }
57 template<class T>
58 concept swappable = see below;
59 template<class T, class U>
60 concept swappable_with = see below;
61
62 // [concept.destructible], concept destructible
63 template<class T>
64 concept destructible = see below;
65
66 // [concept.constructible], concept constructible_from
67 template<class T, class... Args>
68 concept constructible_from = see below;
69
70 // [concept.defaultconstructible], concept default_constructible
71 template<class T>
72 concept default_constructible = see below;
73
74 // [concept.moveconstructible], concept move_constructible
75 template<class T>
76 concept move_constructible = see below;
77
78 // [concept.copyconstructible], concept copy_constructible
79 template<class T>
80 concept copy_constructible = see below;
81
82 // [concepts.compare], comparison concepts
83 // [concept.boolean], concept boolean
84 template<class B>
85 concept boolean = see below;
86
87 // [concept.equalitycomparable], concept equality_comparable
88 template<class T>
89 concept equality_comparable = see below;
90 template<class T, class U>
91 concept equality_comparable_with = see below;
92
93 // [concept.totallyordered], concept totally_ordered
94 template<class T>
95 concept totally_ordered = see below;
96 template<class T, class U>
97 concept totally_ordered_with = see below;
98
99 // [concepts.object], object concepts
100 template<class T>
101 concept movable = see below;
102 template<class T>
103 concept copyable = see below;
104 template<class T>
105 concept semiregular = see below;
106 template<class T>
107 concept regular = see below;
108
109 // [concepts.callable], callable concepts
110 // [concept.invocable], concept invocable
111 template<class F, class... Args>
112 concept invocable = see below;
113
114 // [concept.regularinvocable], concept regular_invocable
115 template<class F, class... Args>
116 concept regular_invocable = see below;
117
118 // [concept.predicate], concept predicate
119 template<class F, class... Args>
120 concept predicate = see below;
121
122 // [concept.relation], concept relation
123 template<class R, class T, class U>
124 concept relation = see below;
125
126 // [concept.equiv], concept equivalence_relation
127 template<class R, class T, class U>
128 concept equivalence_relation = see below;
129
130 // [concept.strictweakorder], concept strict_weak_order
131 template<class R, class T, class U>
132 concept strict_weak_order = see below;
133}
134
135*/
136
137#include <__config>
Christopher Di Bella25c8ce62021-02-08 05:08:25 +0000138#include <functional>
Eric Fiselierd59a0322020-04-08 18:00:13 -0400139#include <type_traits>
Christopher Di Bella25c8ce62021-02-08 05:08:25 +0000140#include <utility>
Eric Fiselierd59a0322020-04-08 18:00:13 -0400141#include <version>
142
143#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
144#pragma GCC system_header
145#endif
146
147_LIBCPP_PUSH_MACROS
148#include <__undef_macros>
149
150_LIBCPP_BEGIN_NAMESPACE_STD
151
Christopher Di Bella88110022021-02-19 01:54:52 +0000152#if _LIBCPP_STD_VER > 17 && !defined(_LIBCPP_HAS_NO_CONCEPTS)
Eric Fiselierd59a0322020-04-08 18:00:13 -0400153
154// [concept.same]
155
156template<class _Tp, class _Up>
157concept __same_as_impl = _VSTD::_IsSame<_Tp, _Up>::value;
158
159template<class _Tp, class _Up>
160concept same_as = __same_as_impl<_Tp, _Up> && __same_as_impl<_Up, _Tp>;
161
Christopher Di Bella2050d992021-02-04 03:41:44 +0000162// [concept.derived]
163template<class _Dp, class _Bp>
164concept derived_from =
165 is_base_of_v<_Bp, _Dp> &&
166 is_convertible_v<const volatile _Dp*, const volatile _Bp*>;
167
Christopher Di Bella16249f32021-02-04 03:19:26 +0000168// [concept.convertible]
169template<class _From, class _To>
170concept convertible_to =
171 is_convertible_v<_From, _To> &&
172 requires(add_rvalue_reference_t<_From> (&__f)()) {
173 static_cast<_To>(__f());
174 };
175
Christopher Di Bella550a5962021-03-02 13:48:06 -0800176// [concept.commonref]
177template<class _Tp, class _Up>
178concept common_reference_with =
179 same_as<common_reference_t<_Tp, _Up>, common_reference_t<_Up, _Tp>> &&
180 convertible_to<_Tp, common_reference_t<_Tp, _Up>> &&
181 convertible_to<_Up, common_reference_t<_Tp, _Up>>;
182
Christopher Di Bellaf138e262021-03-02 13:52:30 -0800183// [concept.common]
184template<class _Tp, class _Up>
185concept common_with =
186 same_as<common_type_t<_Tp, _Up>, common_type_t<_Up, _Tp>> &&
187 requires {
188 static_cast<common_type_t<_Tp, _Up>>(_VSTD::declval<_Tp>());
189 static_cast<common_type_t<_Tp, _Up>>(_VSTD::declval<_Up>());
190 } &&
191 common_reference_with<
192 add_lvalue_reference_t<const _Tp>,
193 add_lvalue_reference_t<const _Up>> &&
194 common_reference_with<
195 add_lvalue_reference_t<common_type_t<_Tp, _Up>>,
196 common_reference_t<
197 add_lvalue_reference_t<const _Tp>,
198 add_lvalue_reference_t<const _Up>>>;
199
Christopher Di Bella71812802021-01-21 02:33:04 +0000200// [concepts.arithmetic], arithmetic concepts
201template<class _Tp>
202concept integral = is_integral_v<_Tp>;
203
204template<class _Tp>
205concept signed_integral = integral<_Tp> && is_signed_v<_Tp>;
206
207template<class _Tp>
208concept unsigned_integral = integral<_Tp> && !signed_integral<_Tp>;
209
210template<class _Tp>
211concept floating_point = is_floating_point_v<_Tp>;
212
Christopher Di Bella6054b622021-03-03 22:27:21 -0800213// [concept.assignable]
214template<class _Lhs, class _Rhs>
215concept assignable_from =
216 is_lvalue_reference_v<_Lhs> &&
217 common_reference_with<const remove_reference_t<_Lhs>&, const remove_reference_t<_Rhs>&> &&
218 requires (_Lhs __lhs, _Rhs&& __rhs) {
219 { __lhs = _VSTD::forward<_Rhs>(__rhs) } -> same_as<_Lhs>;
220 };
221
Mark de Wevere9557352020-11-24 16:12:34 +0100222// [concept.destructible]
223
224template<class _Tp>
225concept destructible = _VSTD::is_nothrow_destructible_v<_Tp>;
226
Mark de Wever0582b602020-12-17 06:53:00 +0100227// [concept.constructible]
228template<class _Tp, class... _Args>
229concept constructible_from =
230 destructible<_Tp> && _VSTD::is_constructible_v<_Tp, _Args...>;
231
Mark de Wever80379212020-12-17 07:48:26 +0100232// [concept.default.init]
233
234template<class _Tp>
235concept __default_initializable = requires { ::new _Tp; };
236
237template<class _Tp>
238concept default_initializable = constructible_from<_Tp> &&
239 requires { _Tp{}; } && __default_initializable<_Tp>;
240
Christopher Di Bellae60e7db2021-02-08 02:00:42 +0000241// [concept.moveconstructible]
242template<class _Tp>
243concept move_constructible =
244 constructible_from<_Tp, _Tp> && convertible_to<_Tp, _Tp>;
245
Christopher Di Bellaab6f87a2021-02-08 03:01:27 +0000246// [concept.copyconstructible]
247template<class _Tp>
248concept copy_constructible =
249 move_constructible<_Tp> &&
250 constructible_from<_Tp, _Tp&> && convertible_to<_Tp&, _Tp> &&
251 constructible_from<_Tp, const _Tp&> && convertible_to<const _Tp&, _Tp> &&
252 constructible_from<_Tp, const _Tp> && convertible_to<const _Tp, _Tp>;
253
Christopher Di Bella25c8ce62021-02-08 05:08:25 +0000254// [concept.invocable]
255template<class _Fn, class... _Args>
256concept invocable = requires(_Fn&& __fn, _Args&&... __args) {
257 _VSTD::invoke(_VSTD::forward<_Fn>(__fn), _VSTD::forward<_Args>(__args)...); // not required to be equality preserving
258};
259
260// [concept.regular.invocable]
261template<class _Fn, class... _Args>
262concept regular_invocable = invocable<_Fn, _Args...>;
263
Christopher Di Bella88110022021-02-19 01:54:52 +0000264#endif // _LIBCPP_STD_VER > 17 && !defined(_LIBCPP_HAS_NO_CONCEPTS)
Eric Fiselierd59a0322020-04-08 18:00:13 -0400265
266_LIBCPP_END_NAMESPACE_STD
267
268_LIBCPP_POP_MACROS
269
270#endif // _LIBCPP_CONCEPTS