concepts.h 11 KB

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