concepts.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. // -*- C++ -*-
  2. //===----------------------------------------------------------------------===//
  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. #ifndef _LIBCPP___ITERATOR_CONCEPTS_H
  10. #define _LIBCPP___ITERATOR_CONCEPTS_H
  11. #include <__config>
  12. #include <__iterator/incrementable_traits.h>
  13. #include <__iterator/iter_move.h>
  14. #include <__iterator/iterator_traits.h>
  15. #include <__iterator/readable_traits.h>
  16. #include <__memory/pointer_traits.h>
  17. #include <__utility/forward.h>
  18. #include <concepts>
  19. #include <type_traits>
  20. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  21. # pragma GCC system_header
  22. #endif
  23. _LIBCPP_BEGIN_NAMESPACE_STD
  24. #if !defined(_LIBCPP_HAS_NO_CONCEPTS)
  25. // [iterator.concept.readable]
  26. template<class _In>
  27. concept __indirectly_readable_impl =
  28. requires(const _In __i) {
  29. typename iter_value_t<_In>;
  30. typename iter_reference_t<_In>;
  31. typename iter_rvalue_reference_t<_In>;
  32. { *__i } -> same_as<iter_reference_t<_In>>;
  33. { ranges::iter_move(__i) } -> same_as<iter_rvalue_reference_t<_In>>;
  34. } &&
  35. common_reference_with<iter_reference_t<_In>&&, iter_value_t<_In>&> &&
  36. common_reference_with<iter_reference_t<_In>&&, iter_rvalue_reference_t<_In>&&> &&
  37. common_reference_with<iter_rvalue_reference_t<_In>&&, const iter_value_t<_In>&>;
  38. template<class _In>
  39. concept indirectly_readable = __indirectly_readable_impl<remove_cvref_t<_In>>;
  40. template<indirectly_readable _Tp>
  41. using iter_common_reference_t = common_reference_t<iter_reference_t<_Tp>, iter_value_t<_Tp>&>;
  42. // [iterator.concept.writable]
  43. template<class _Out, class _Tp>
  44. concept indirectly_writable =
  45. requires(_Out&& __o, _Tp&& __t) {
  46. *__o = _VSTD::forward<_Tp>(__t); // not required to be equality-preserving
  47. *_VSTD::forward<_Out>(__o) = _VSTD::forward<_Tp>(__t); // not required to be equality-preserving
  48. const_cast<const iter_reference_t<_Out>&&>(*__o) = _VSTD::forward<_Tp>(__t); // not required to be equality-preserving
  49. const_cast<const iter_reference_t<_Out>&&>(*_VSTD::forward<_Out>(__o)) = _VSTD::forward<_Tp>(__t); // not required to be equality-preserving
  50. };
  51. // [iterator.concept.winc]
  52. template<class _Tp>
  53. concept __integer_like = integral<_Tp> && !same_as<_Tp, bool>;
  54. template<class _Tp>
  55. concept __signed_integer_like = signed_integral<_Tp>;
  56. template<class _Ip>
  57. concept weakly_incrementable =
  58. // TODO: remove this once the clang bug is fixed (bugs.llvm.org/PR48173).
  59. !same_as<_Ip, bool> && // Currently, clang does not handle bool correctly.
  60. movable<_Ip> &&
  61. requires(_Ip __i) {
  62. typename iter_difference_t<_Ip>;
  63. requires __signed_integer_like<iter_difference_t<_Ip>>;
  64. { ++__i } -> same_as<_Ip&>; // not required to be equality-preserving
  65. __i++; // not required to be equality-preserving
  66. };
  67. // [iterator.concept.inc]
  68. template<class _Ip>
  69. concept incrementable =
  70. regular<_Ip> &&
  71. weakly_incrementable<_Ip> &&
  72. requires(_Ip __i) {
  73. { __i++ } -> same_as<_Ip>;
  74. };
  75. // [iterator.concept.iterator]
  76. template<class _Ip>
  77. concept input_or_output_iterator =
  78. requires(_Ip __i) {
  79. { *__i } -> __can_reference;
  80. } &&
  81. weakly_incrementable<_Ip>;
  82. // [iterator.concept.sentinel]
  83. template<class _Sp, class _Ip>
  84. concept sentinel_for =
  85. semiregular<_Sp> &&
  86. input_or_output_iterator<_Ip> &&
  87. __weakly_equality_comparable_with<_Sp, _Ip>;
  88. template<class, class>
  89. inline constexpr bool disable_sized_sentinel_for = false;
  90. template<class _Sp, class _Ip>
  91. concept sized_sentinel_for =
  92. sentinel_for<_Sp, _Ip> &&
  93. !disable_sized_sentinel_for<remove_cv_t<_Sp>, remove_cv_t<_Ip>> &&
  94. requires(const _Ip& __i, const _Sp& __s) {
  95. { __s - __i } -> same_as<iter_difference_t<_Ip>>;
  96. { __i - __s } -> same_as<iter_difference_t<_Ip>>;
  97. };
  98. // [iterator.concept.input]
  99. template<class _Ip>
  100. concept input_iterator =
  101. input_or_output_iterator<_Ip> &&
  102. indirectly_readable<_Ip> &&
  103. requires { typename _ITER_CONCEPT<_Ip>; } &&
  104. derived_from<_ITER_CONCEPT<_Ip>, input_iterator_tag>;
  105. // [iterator.concept.output]
  106. template<class _Ip, class _Tp>
  107. concept output_iterator =
  108. input_or_output_iterator<_Ip> &&
  109. indirectly_writable<_Ip, _Tp> &&
  110. requires (_Ip __it, _Tp&& __t) {
  111. *__it++ = _VSTD::forward<_Tp>(__t); // not required to be equality-preserving
  112. };
  113. // [iterator.concept.forward]
  114. template<class _Ip>
  115. concept forward_iterator =
  116. input_iterator<_Ip> &&
  117. derived_from<_ITER_CONCEPT<_Ip>, forward_iterator_tag> &&
  118. incrementable<_Ip> &&
  119. sentinel_for<_Ip, _Ip>;
  120. // [iterator.concept.bidir]
  121. template<class _Ip>
  122. concept bidirectional_iterator =
  123. forward_iterator<_Ip> &&
  124. derived_from<_ITER_CONCEPT<_Ip>, bidirectional_iterator_tag> &&
  125. requires(_Ip __i) {
  126. { --__i } -> same_as<_Ip&>;
  127. { __i-- } -> same_as<_Ip>;
  128. };
  129. template<class _Ip>
  130. concept random_access_iterator =
  131. bidirectional_iterator<_Ip> &&
  132. derived_from<_ITER_CONCEPT<_Ip>, random_access_iterator_tag> &&
  133. totally_ordered<_Ip> &&
  134. sized_sentinel_for<_Ip, _Ip> &&
  135. requires(_Ip __i, const _Ip __j, const iter_difference_t<_Ip> __n) {
  136. { __i += __n } -> same_as<_Ip&>;
  137. { __j + __n } -> same_as<_Ip>;
  138. { __n + __j } -> same_as<_Ip>;
  139. { __i -= __n } -> same_as<_Ip&>;
  140. { __j - __n } -> same_as<_Ip>;
  141. { __j[__n] } -> same_as<iter_reference_t<_Ip>>;
  142. };
  143. template<class _Ip>
  144. concept contiguous_iterator =
  145. random_access_iterator<_Ip> &&
  146. derived_from<_ITER_CONCEPT<_Ip>, contiguous_iterator_tag> &&
  147. is_lvalue_reference_v<iter_reference_t<_Ip>> &&
  148. same_as<iter_value_t<_Ip>, remove_cvref_t<iter_reference_t<_Ip>>> &&
  149. requires(const _Ip& __i) {
  150. { _VSTD::to_address(__i) } -> same_as<add_pointer_t<iter_reference_t<_Ip>>>;
  151. };
  152. template<class _Ip>
  153. concept __has_arrow = input_iterator<_Ip> && (is_pointer_v<_Ip> || requires(_Ip __i) { __i.operator->(); });
  154. // [indirectcallable.indirectinvocable]
  155. template<class _Fp, class _It>
  156. concept indirectly_unary_invocable =
  157. indirectly_readable<_It> &&
  158. copy_constructible<_Fp> &&
  159. invocable<_Fp&, iter_value_t<_It>&> &&
  160. invocable<_Fp&, iter_reference_t<_It>> &&
  161. invocable<_Fp&, iter_common_reference_t<_It>> &&
  162. common_reference_with<
  163. invoke_result_t<_Fp&, iter_value_t<_It>&>,
  164. invoke_result_t<_Fp&, iter_reference_t<_It>>>;
  165. template<class _Fp, class _It>
  166. concept indirectly_regular_unary_invocable =
  167. indirectly_readable<_It> &&
  168. copy_constructible<_Fp> &&
  169. regular_invocable<_Fp&, iter_value_t<_It>&> &&
  170. regular_invocable<_Fp&, iter_reference_t<_It>> &&
  171. regular_invocable<_Fp&, iter_common_reference_t<_It>> &&
  172. common_reference_with<
  173. invoke_result_t<_Fp&, iter_value_t<_It>&>,
  174. invoke_result_t<_Fp&, iter_reference_t<_It>>>;
  175. template<class _Fp, class _It>
  176. concept indirect_unary_predicate =
  177. indirectly_readable<_It> &&
  178. copy_constructible<_Fp> &&
  179. predicate<_Fp&, iter_value_t<_It>&> &&
  180. predicate<_Fp&, iter_reference_t<_It>> &&
  181. predicate<_Fp&, iter_common_reference_t<_It>>;
  182. template<class _Fp, class _It1, class _It2>
  183. concept indirect_binary_predicate =
  184. indirectly_readable<_It1> && indirectly_readable<_It2> &&
  185. copy_constructible<_Fp> &&
  186. predicate<_Fp&, iter_value_t<_It1>&, iter_value_t<_It2>&> &&
  187. predicate<_Fp&, iter_value_t<_It1>&, iter_reference_t<_It2>> &&
  188. predicate<_Fp&, iter_reference_t<_It1>, iter_value_t<_It2>&> &&
  189. predicate<_Fp&, iter_reference_t<_It1>, iter_reference_t<_It2>> &&
  190. predicate<_Fp&, iter_common_reference_t<_It1>, iter_common_reference_t<_It2>>;
  191. template<class _Fp, class _It1, class _It2 = _It1>
  192. concept indirect_equivalence_relation =
  193. indirectly_readable<_It1> && indirectly_readable<_It2> &&
  194. copy_constructible<_Fp> &&
  195. equivalence_relation<_Fp&, iter_value_t<_It1>&, iter_value_t<_It2>&> &&
  196. equivalence_relation<_Fp&, iter_value_t<_It1>&, iter_reference_t<_It2>> &&
  197. equivalence_relation<_Fp&, iter_reference_t<_It1>, iter_value_t<_It2>&> &&
  198. equivalence_relation<_Fp&, iter_reference_t<_It1>, iter_reference_t<_It2>> &&
  199. equivalence_relation<_Fp&, iter_common_reference_t<_It1>, iter_common_reference_t<_It2>>;
  200. template<class _Fp, class _It1, class _It2 = _It1>
  201. concept indirect_strict_weak_order =
  202. indirectly_readable<_It1> && indirectly_readable<_It2> &&
  203. copy_constructible<_Fp> &&
  204. strict_weak_order<_Fp&, iter_value_t<_It1>&, iter_value_t<_It2>&> &&
  205. strict_weak_order<_Fp&, iter_value_t<_It1>&, iter_reference_t<_It2>> &&
  206. strict_weak_order<_Fp&, iter_reference_t<_It1>, iter_value_t<_It2>&> &&
  207. strict_weak_order<_Fp&, iter_reference_t<_It1>, iter_reference_t<_It2>> &&
  208. strict_weak_order<_Fp&, iter_common_reference_t<_It1>, iter_common_reference_t<_It2>>;
  209. template<class _Fp, class... _Its>
  210. requires (indirectly_readable<_Its> && ...) && invocable<_Fp, iter_reference_t<_Its>...>
  211. using indirect_result_t = invoke_result_t<_Fp, iter_reference_t<_Its>...>;
  212. template<class _In, class _Out>
  213. concept indirectly_movable =
  214. indirectly_readable<_In> &&
  215. indirectly_writable<_Out, iter_rvalue_reference_t<_In>>;
  216. template<class _In, class _Out>
  217. concept indirectly_movable_storable =
  218. indirectly_movable<_In, _Out> &&
  219. indirectly_writable<_Out, iter_value_t<_In>> &&
  220. movable<iter_value_t<_In>> &&
  221. constructible_from<iter_value_t<_In>, iter_rvalue_reference_t<_In>> &&
  222. assignable_from<iter_value_t<_In>&, iter_rvalue_reference_t<_In>>;
  223. template<class _In, class _Out>
  224. concept indirectly_copyable =
  225. indirectly_readable<_In> &&
  226. indirectly_writable<_Out, iter_reference_t<_In>>;
  227. template<class _In, class _Out>
  228. concept indirectly_copyable_storable =
  229. indirectly_copyable<_In, _Out> &&
  230. indirectly_writable<_Out, iter_value_t<_In>&> &&
  231. indirectly_writable<_Out, const iter_value_t<_In>&> &&
  232. indirectly_writable<_Out, iter_value_t<_In>&&> &&
  233. indirectly_writable<_Out, const iter_value_t<_In>&&> &&
  234. copyable<iter_value_t<_In>> &&
  235. constructible_from<iter_value_t<_In>, iter_reference_t<_In>> &&
  236. assignable_from<iter_value_t<_In>&, iter_reference_t<_In>>;
  237. // Note: indirectly_swappable is located in iter_swap.h to prevent a dependency cycle
  238. // (both iter_swap and indirectly_swappable require indirectly_readable).
  239. #endif // !defined(_LIBCPP_HAS_NO_CONCEPTS)
  240. _LIBCPP_END_NAMESPACE_STD
  241. #endif // _LIBCPP___ITERATOR_CONCEPTS_H