iterator_concepts.h 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981
  1. // Concepts and traits for use with iterators -*- C++ -*-
  2. // Copyright (C) 2019-2021 Free Software Foundation, Inc.
  3. //
  4. // This file is part of the GNU ISO C++ Library. This library is free
  5. // software; you can redistribute it and/or modify it under the
  6. // terms of the GNU General Public License as published by the
  7. // Free Software Foundation; either version 3, or (at your option)
  8. // any later version.
  9. // This library is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU General Public License for more details.
  13. // Under Section 7 of GPL version 3, you are granted additional
  14. // permissions described in the GCC Runtime Library Exception, version
  15. // 3.1, as published by the Free Software Foundation.
  16. // You should have received a copy of the GNU General Public License and
  17. // a copy of the GCC Runtime Library Exception along with this program;
  18. // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
  19. // <http://www.gnu.org/licenses/>.
  20. /** @file bits/iterator_concepts.h
  21. * This is an internal header file, included by other library headers.
  22. * Do not attempt to use it directly. @headername{iterator}
  23. */
  24. #ifndef _ITERATOR_CONCEPTS_H
  25. #define _ITERATOR_CONCEPTS_H 1
  26. #pragma GCC system_header
  27. #include <concepts>
  28. #include <bits/ptr_traits.h> // to_address
  29. #include <bits/ranges_cmp.h> // identity, ranges::less
  30. #if __cpp_lib_concepts
  31. namespace std _GLIBCXX_VISIBILITY(default)
  32. {
  33. _GLIBCXX_BEGIN_NAMESPACE_VERSION
  34. struct input_iterator_tag;
  35. struct output_iterator_tag;
  36. struct forward_iterator_tag;
  37. struct bidirectional_iterator_tag;
  38. struct random_access_iterator_tag;
  39. struct contiguous_iterator_tag;
  40. template<typename _Iterator>
  41. struct iterator_traits;
  42. template<typename _Tp> requires is_object_v<_Tp>
  43. struct iterator_traits<_Tp*>;
  44. template<typename _Iterator, typename>
  45. struct __iterator_traits;
  46. namespace __detail
  47. {
  48. template<typename _Tp>
  49. using __with_ref = _Tp&;
  50. template<typename _Tp>
  51. concept __can_reference = requires { typename __with_ref<_Tp>; };
  52. template<typename _Tp>
  53. concept __dereferenceable = requires(_Tp& __t)
  54. {
  55. { *__t } -> __can_reference;
  56. };
  57. } // namespace __detail
  58. template<__detail::__dereferenceable _Tp>
  59. using iter_reference_t = decltype(*std::declval<_Tp&>());
  60. namespace ranges
  61. {
  62. namespace __cust_imove
  63. {
  64. void iter_move();
  65. template<typename _Tp>
  66. concept __adl_imove
  67. = (std::__detail::__class_or_enum<remove_reference_t<_Tp>>)
  68. && requires(_Tp&& __t) { iter_move(static_cast<_Tp&&>(__t)); };
  69. struct _IMove
  70. {
  71. private:
  72. template<typename _Tp>
  73. struct __result
  74. { using type = iter_reference_t<_Tp>; };
  75. template<typename _Tp>
  76. requires __adl_imove<_Tp>
  77. struct __result<_Tp>
  78. { using type = decltype(iter_move(std::declval<_Tp>())); };
  79. template<typename _Tp>
  80. requires (!__adl_imove<_Tp>)
  81. && is_lvalue_reference_v<iter_reference_t<_Tp>>
  82. struct __result<_Tp>
  83. { using type = remove_reference_t<iter_reference_t<_Tp>>&&; };
  84. template<typename _Tp>
  85. static constexpr bool
  86. _S_noexcept()
  87. {
  88. if constexpr (__adl_imove<_Tp>)
  89. return noexcept(iter_move(std::declval<_Tp>()));
  90. else
  91. return noexcept(*std::declval<_Tp>());
  92. }
  93. public:
  94. // The result type of iter_move(std::declval<_Tp>())
  95. template<std::__detail::__dereferenceable _Tp>
  96. using __type = typename __result<_Tp>::type;
  97. template<std::__detail::__dereferenceable _Tp>
  98. constexpr __type<_Tp>
  99. operator()(_Tp&& __e) const
  100. noexcept(_S_noexcept<_Tp>())
  101. {
  102. if constexpr (__adl_imove<_Tp>)
  103. return iter_move(static_cast<_Tp&&>(__e));
  104. else if constexpr (is_lvalue_reference_v<iter_reference_t<_Tp>>)
  105. return static_cast<__type<_Tp>>(*__e);
  106. else
  107. return *__e;
  108. }
  109. };
  110. } // namespace __cust_imove
  111. inline namespace __cust
  112. {
  113. inline constexpr __cust_imove::_IMove iter_move{};
  114. } // inline namespace __cust
  115. } // namespace ranges
  116. template<__detail::__dereferenceable _Tp>
  117. requires __detail::
  118. __can_reference<ranges::__cust_imove::_IMove::__type<_Tp&>>
  119. using iter_rvalue_reference_t
  120. = ranges::__cust_imove::_IMove::__type<_Tp&>;
  121. template<typename> struct incrementable_traits { };
  122. template<typename _Tp> requires is_object_v<_Tp>
  123. struct incrementable_traits<_Tp*>
  124. { using difference_type = ptrdiff_t; };
  125. template<typename _Iter>
  126. struct incrementable_traits<const _Iter>
  127. : incrementable_traits<_Iter> { };
  128. template<typename _Tp> requires requires { typename _Tp::difference_type; }
  129. struct incrementable_traits<_Tp>
  130. { using difference_type = typename _Tp::difference_type; };
  131. template<typename _Tp>
  132. requires (!requires { typename _Tp::difference_type; }
  133. && requires(const _Tp& __a, const _Tp& __b)
  134. { { __a - __b } -> integral; })
  135. struct incrementable_traits<_Tp>
  136. {
  137. using difference_type
  138. = make_signed_t<decltype(std::declval<_Tp>() - std::declval<_Tp>())>;
  139. };
  140. #if defined __STRICT_ANSI__ && defined __SIZEOF_INT128__
  141. // __int128 is incrementable even if !integral<__int128>
  142. template<>
  143. struct incrementable_traits<__int128>
  144. { using difference_type = __int128; };
  145. template<>
  146. struct incrementable_traits<unsigned __int128>
  147. { using difference_type = __int128; };
  148. #endif
  149. namespace __detail
  150. {
  151. // An iterator such that iterator_traits<_Iter> names a specialization
  152. // generated from the primary template.
  153. template<typename _Iter>
  154. concept __primary_traits_iter
  155. = __is_base_of(__iterator_traits<_Iter, void>, iterator_traits<_Iter>);
  156. template<typename _Iter, typename _Tp>
  157. struct __iter_traits_impl
  158. { using type = iterator_traits<_Iter>; };
  159. template<typename _Iter, typename _Tp>
  160. requires __primary_traits_iter<_Iter>
  161. struct __iter_traits_impl<_Iter, _Tp>
  162. { using type = _Tp; };
  163. // ITER_TRAITS
  164. template<typename _Iter, typename _Tp = _Iter>
  165. using __iter_traits = typename __iter_traits_impl<_Iter, _Tp>::type;
  166. template<typename _Tp>
  167. using __iter_diff_t = typename
  168. __iter_traits<_Tp, incrementable_traits<_Tp>>::difference_type;
  169. } // namespace __detail
  170. template<typename _Tp>
  171. using iter_difference_t = __detail::__iter_diff_t<remove_cvref_t<_Tp>>;
  172. namespace __detail
  173. {
  174. template<typename> struct __cond_value_type { };
  175. template<typename _Tp> requires is_object_v<_Tp>
  176. struct __cond_value_type<_Tp>
  177. { using value_type = remove_cv_t<_Tp>; };
  178. template<typename _Tp>
  179. concept __has_member_value_type
  180. = requires { typename _Tp::value_type; };
  181. template<typename _Tp>
  182. concept __has_member_element_type
  183. = requires { typename _Tp::element_type; };
  184. } // namespace __detail
  185. template<typename> struct indirectly_readable_traits { };
  186. template<typename _Tp>
  187. struct indirectly_readable_traits<_Tp*>
  188. : __detail::__cond_value_type<_Tp>
  189. { };
  190. template<typename _Iter> requires is_array_v<_Iter>
  191. struct indirectly_readable_traits<_Iter>
  192. { using value_type = remove_cv_t<remove_extent_t<_Iter>>; };
  193. template<typename _Iter>
  194. struct indirectly_readable_traits<const _Iter>
  195. : indirectly_readable_traits<_Iter>
  196. { };
  197. template<__detail::__has_member_value_type _Tp>
  198. struct indirectly_readable_traits<_Tp>
  199. : __detail::__cond_value_type<typename _Tp::value_type>
  200. { };
  201. template<__detail::__has_member_element_type _Tp>
  202. struct indirectly_readable_traits<_Tp>
  203. : __detail::__cond_value_type<typename _Tp::element_type>
  204. { };
  205. // _GLIBCXX_RESOLVE_LIB_DEFECTS
  206. // 3446. indirectly_readable_traits ambiguity for types with both [...]
  207. template<__detail::__has_member_value_type _Tp>
  208. requires __detail::__has_member_element_type<_Tp>
  209. && same_as<remove_cv_t<typename _Tp::element_type>,
  210. remove_cv_t<typename _Tp::value_type>>
  211. struct indirectly_readable_traits<_Tp>
  212. : __detail::__cond_value_type<typename _Tp::value_type>
  213. { };
  214. // LWG 3446 doesn't add this, but it's needed for the case where
  215. // value_type and element_type are both present, but not the same type.
  216. template<__detail::__has_member_value_type _Tp>
  217. requires __detail::__has_member_element_type<_Tp>
  218. struct indirectly_readable_traits<_Tp>
  219. { };
  220. namespace __detail
  221. {
  222. template<typename _Tp>
  223. using __iter_value_t = typename
  224. __iter_traits<_Tp, indirectly_readable_traits<_Tp>>::value_type;
  225. } // namespace __detail
  226. template<typename _Tp>
  227. using iter_value_t = __detail::__iter_value_t<remove_cvref_t<_Tp>>;
  228. namespace __detail
  229. {
  230. // _GLIBCXX_RESOLVE_LIB_DEFECTS
  231. // 3420. cpp17-iterator should check [type] looks like an iterator first
  232. template<typename _Iter>
  233. concept __cpp17_iterator = requires(_Iter __it)
  234. {
  235. { *__it } -> __can_reference;
  236. { ++__it } -> same_as<_Iter&>;
  237. { *__it++ } -> __can_reference;
  238. } && copyable<_Iter>;
  239. template<typename _Iter>
  240. concept __cpp17_input_iterator = __cpp17_iterator<_Iter>
  241. && equality_comparable<_Iter>
  242. && requires(_Iter __it)
  243. {
  244. typename incrementable_traits<_Iter>::difference_type;
  245. typename indirectly_readable_traits<_Iter>::value_type;
  246. typename common_reference_t<iter_reference_t<_Iter>&&,
  247. typename indirectly_readable_traits<_Iter>::value_type&>;
  248. typename common_reference_t<decltype(*__it++)&&,
  249. typename indirectly_readable_traits<_Iter>::value_type&>;
  250. requires signed_integral<
  251. typename incrementable_traits<_Iter>::difference_type>;
  252. };
  253. template<typename _Iter>
  254. concept __cpp17_fwd_iterator = __cpp17_input_iterator<_Iter>
  255. && constructible_from<_Iter>
  256. && is_lvalue_reference_v<iter_reference_t<_Iter>>
  257. && same_as<remove_cvref_t<iter_reference_t<_Iter>>,
  258. typename indirectly_readable_traits<_Iter>::value_type>
  259. && requires(_Iter __it)
  260. {
  261. { __it++ } -> convertible_to<const _Iter&>;
  262. { *__it++ } -> same_as<iter_reference_t<_Iter>>;
  263. };
  264. template<typename _Iter>
  265. concept __cpp17_bidi_iterator = __cpp17_fwd_iterator<_Iter>
  266. && requires(_Iter __it)
  267. {
  268. { --__it } -> same_as<_Iter&>;
  269. { __it-- } -> convertible_to<const _Iter&>;
  270. { *__it-- } -> same_as<iter_reference_t<_Iter>>;
  271. };
  272. template<typename _Iter>
  273. concept __cpp17_randacc_iterator = __cpp17_bidi_iterator<_Iter>
  274. && totally_ordered<_Iter>
  275. && requires(_Iter __it,
  276. typename incrementable_traits<_Iter>::difference_type __n)
  277. {
  278. { __it += __n } -> same_as<_Iter&>;
  279. { __it -= __n } -> same_as<_Iter&>;
  280. { __it + __n } -> same_as<_Iter>;
  281. { __n + __it } -> same_as<_Iter>;
  282. { __it - __n } -> same_as<_Iter>;
  283. { __it - __it } -> same_as<decltype(__n)>;
  284. { __it[__n] } -> convertible_to<iter_reference_t<_Iter>>;
  285. };
  286. template<typename _Iter>
  287. concept __iter_with_nested_types = requires {
  288. typename _Iter::iterator_category;
  289. typename _Iter::value_type;
  290. typename _Iter::difference_type;
  291. typename _Iter::reference;
  292. };
  293. template<typename _Iter>
  294. concept __iter_without_nested_types = !__iter_with_nested_types<_Iter>;
  295. template<typename _Iter>
  296. concept __iter_without_category
  297. = !requires { typename _Iter::iterator_category; };
  298. } // namespace __detail
  299. template<typename _Iterator>
  300. requires __detail::__iter_with_nested_types<_Iterator>
  301. struct __iterator_traits<_Iterator, void>
  302. {
  303. private:
  304. template<typename _Iter>
  305. struct __ptr
  306. { using type = void; };
  307. template<typename _Iter> requires requires { typename _Iter::pointer; }
  308. struct __ptr<_Iter>
  309. { using type = typename _Iter::pointer; };
  310. public:
  311. using iterator_category = typename _Iterator::iterator_category;
  312. using value_type = typename _Iterator::value_type;
  313. using difference_type = typename _Iterator::difference_type;
  314. using pointer = typename __ptr<_Iterator>::type;
  315. using reference = typename _Iterator::reference;
  316. };
  317. template<typename _Iterator>
  318. requires __detail::__iter_without_nested_types<_Iterator>
  319. && __detail::__cpp17_input_iterator<_Iterator>
  320. struct __iterator_traits<_Iterator, void>
  321. {
  322. private:
  323. template<typename _Iter>
  324. struct __cat
  325. { using type = input_iterator_tag; };
  326. template<typename _Iter>
  327. requires requires { typename _Iter::iterator_category; }
  328. struct __cat<_Iter>
  329. { using type = typename _Iter::iterator_category; };
  330. template<typename _Iter>
  331. requires __detail::__iter_without_category<_Iter>
  332. && __detail::__cpp17_randacc_iterator<_Iter>
  333. struct __cat<_Iter>
  334. { using type = random_access_iterator_tag; };
  335. template<typename _Iter>
  336. requires __detail::__iter_without_category<_Iter>
  337. && __detail::__cpp17_bidi_iterator<_Iter>
  338. struct __cat<_Iter>
  339. { using type = bidirectional_iterator_tag; };
  340. template<typename _Iter>
  341. requires __detail::__iter_without_category<_Iter>
  342. && __detail::__cpp17_fwd_iterator<_Iter>
  343. struct __cat<_Iter>
  344. { using type = forward_iterator_tag; };
  345. template<typename _Iter>
  346. struct __ptr
  347. { using type = void; };
  348. template<typename _Iter> requires requires { typename _Iter::pointer; }
  349. struct __ptr<_Iter>
  350. { using type = typename _Iter::pointer; };
  351. template<typename _Iter>
  352. requires (!requires { typename _Iter::pointer; }
  353. && requires(_Iter& __it) { __it.operator->(); })
  354. struct __ptr<_Iter>
  355. { using type = decltype(std::declval<_Iter&>().operator->()); };
  356. template<typename _Iter>
  357. struct __ref
  358. { using type = iter_reference_t<_Iter>; };
  359. template<typename _Iter> requires requires { typename _Iter::reference; }
  360. struct __ref<_Iter>
  361. { using type = typename _Iter::reference; };
  362. public:
  363. using iterator_category = typename __cat<_Iterator>::type;
  364. using value_type
  365. = typename indirectly_readable_traits<_Iterator>::value_type;
  366. using difference_type
  367. = typename incrementable_traits<_Iterator>::difference_type;
  368. using pointer = typename __ptr<_Iterator>::type;
  369. using reference = typename __ref<_Iterator>::type;
  370. };
  371. template<typename _Iterator>
  372. requires __detail::__iter_without_nested_types<_Iterator>
  373. && __detail::__cpp17_iterator<_Iterator>
  374. struct __iterator_traits<_Iterator, void>
  375. {
  376. private:
  377. template<typename _Iter>
  378. struct __diff
  379. { using type = void; };
  380. template<typename _Iter>
  381. requires requires
  382. { typename incrementable_traits<_Iter>::difference_type; }
  383. struct __diff<_Iter>
  384. {
  385. using type = typename incrementable_traits<_Iter>::difference_type;
  386. };
  387. public:
  388. using iterator_category = output_iterator_tag;
  389. using value_type = void;
  390. using difference_type = typename __diff<_Iterator>::type;
  391. using pointer = void;
  392. using reference = void;
  393. };
  394. namespace __detail
  395. {
  396. template<typename _Iter>
  397. struct __iter_concept_impl;
  398. // ITER_CONCEPT(I) is ITER_TRAITS(I)::iterator_concept if that is valid.
  399. template<typename _Iter>
  400. requires requires { typename __iter_traits<_Iter>::iterator_concept; }
  401. struct __iter_concept_impl<_Iter>
  402. { using type = typename __iter_traits<_Iter>::iterator_concept; };
  403. // Otherwise, ITER_TRAITS(I)::iterator_category if that is valid.
  404. template<typename _Iter>
  405. requires (!requires { typename __iter_traits<_Iter>::iterator_concept; }
  406. && requires { typename __iter_traits<_Iter>::iterator_category; })
  407. struct __iter_concept_impl<_Iter>
  408. { using type = typename __iter_traits<_Iter>::iterator_category; };
  409. // Otherwise, random_access_tag if iterator_traits<I> is not specialized.
  410. template<typename _Iter>
  411. requires (!requires { typename __iter_traits<_Iter>::iterator_concept; }
  412. && !requires { typename __iter_traits<_Iter>::iterator_category; }
  413. && __primary_traits_iter<_Iter>)
  414. struct __iter_concept_impl<_Iter>
  415. { using type = random_access_iterator_tag; };
  416. // Otherwise, there is no ITER_CONCEPT(I) type.
  417. template<typename _Iter>
  418. struct __iter_concept_impl
  419. { };
  420. // ITER_CONCEPT
  421. template<typename _Iter>
  422. using __iter_concept = typename __iter_concept_impl<_Iter>::type;
  423. template<typename _In>
  424. concept __indirectly_readable_impl = requires
  425. {
  426. typename iter_value_t<_In>;
  427. typename iter_reference_t<_In>;
  428. typename iter_rvalue_reference_t<_In>;
  429. requires same_as<iter_reference_t<const _In>,
  430. iter_reference_t<_In>>;
  431. requires same_as<iter_rvalue_reference_t<const _In>,
  432. iter_rvalue_reference_t<_In>>;
  433. }
  434. && common_reference_with<iter_reference_t<_In>&&, iter_value_t<_In>&>
  435. && common_reference_with<iter_reference_t<_In>&&,
  436. iter_rvalue_reference_t<_In>&&>
  437. && common_reference_with<iter_rvalue_reference_t<_In>&&,
  438. const iter_value_t<_In>&>;
  439. } // namespace __detail
  440. /// Requirements for types that are readable by applying operator*.
  441. template<typename _In>
  442. concept indirectly_readable
  443. = __detail::__indirectly_readable_impl<remove_cvref_t<_In>>;
  444. template<indirectly_readable _Tp>
  445. using iter_common_reference_t
  446. = common_reference_t<iter_reference_t<_Tp>, iter_value_t<_Tp>&>;
  447. /// Requirements for writing a value into an iterator's referenced object.
  448. template<typename _Out, typename _Tp>
  449. concept indirectly_writable = requires(_Out&& __o, _Tp&& __t)
  450. {
  451. *__o = std::forward<_Tp>(__t);
  452. *std::forward<_Out>(__o) = std::forward<_Tp>(__t);
  453. const_cast<const iter_reference_t<_Out>&&>(*__o)
  454. = std::forward<_Tp>(__t);
  455. const_cast<const iter_reference_t<_Out>&&>(*std::forward<_Out>(__o))
  456. = std::forward<_Tp>(__t);
  457. };
  458. namespace ranges::__detail
  459. {
  460. class __max_diff_type;
  461. class __max_size_type;
  462. template<typename _Tp>
  463. concept __is_signed_int128
  464. #if __SIZEOF_INT128__
  465. = same_as<_Tp, __int128>;
  466. #else
  467. = false;
  468. #endif
  469. template<typename _Tp>
  470. concept __is_unsigned_int128
  471. #if __SIZEOF_INT128__
  472. = same_as<_Tp, unsigned __int128>;
  473. #else
  474. = false;
  475. #endif
  476. template<typename _Tp>
  477. concept __cv_bool = same_as<const volatile _Tp, const volatile bool>;
  478. template<typename _Tp>
  479. concept __integral_nonbool = integral<_Tp> && !__cv_bool<_Tp>;
  480. template<typename _Tp>
  481. concept __is_int128 = __is_signed_int128<_Tp> || __is_unsigned_int128<_Tp>;
  482. template<typename _Tp>
  483. concept __is_integer_like = __integral_nonbool<_Tp>
  484. || __is_int128<_Tp>
  485. || same_as<_Tp, __max_diff_type> || same_as<_Tp, __max_size_type>;
  486. template<typename _Tp>
  487. concept __is_signed_integer_like = signed_integral<_Tp>
  488. || __is_signed_int128<_Tp>
  489. || same_as<_Tp, __max_diff_type>;
  490. } // namespace ranges::__detail
  491. namespace __detail { using ranges::__detail::__is_signed_integer_like; }
  492. /// Requirements on types that can be incremented with ++.
  493. template<typename _Iter>
  494. concept weakly_incrementable = default_initializable<_Iter>
  495. && movable<_Iter>
  496. && requires(_Iter __i)
  497. {
  498. typename iter_difference_t<_Iter>;
  499. requires __detail::__is_signed_integer_like<iter_difference_t<_Iter>>;
  500. { ++__i } -> same_as<_Iter&>;
  501. __i++;
  502. };
  503. template<typename _Iter>
  504. concept incrementable = regular<_Iter> && weakly_incrementable<_Iter>
  505. && requires(_Iter __i) { { __i++ } -> same_as<_Iter>; };
  506. template<typename _Iter>
  507. concept input_or_output_iterator
  508. = requires(_Iter __i) { { *__i } -> __detail::__can_reference; }
  509. && weakly_incrementable<_Iter>;
  510. template<typename _Sent, typename _Iter>
  511. concept sentinel_for = semiregular<_Sent>
  512. && input_or_output_iterator<_Iter>
  513. && __detail::__weakly_eq_cmp_with<_Sent, _Iter>;
  514. template<typename _Sent, typename _Iter>
  515. inline constexpr bool disable_sized_sentinel_for = false;
  516. template<typename _Sent, typename _Iter>
  517. concept sized_sentinel_for = sentinel_for<_Sent, _Iter>
  518. && !disable_sized_sentinel_for<remove_cv_t<_Sent>, remove_cv_t<_Iter>>
  519. && requires(const _Iter& __i, const _Sent& __s)
  520. {
  521. { __s - __i } -> same_as<iter_difference_t<_Iter>>;
  522. { __i - __s } -> same_as<iter_difference_t<_Iter>>;
  523. };
  524. template<typename _Iter>
  525. concept input_iterator = input_or_output_iterator<_Iter>
  526. && indirectly_readable<_Iter>
  527. && requires { typename __detail::__iter_concept<_Iter>; }
  528. && derived_from<__detail::__iter_concept<_Iter>, input_iterator_tag>;
  529. template<typename _Iter, typename _Tp>
  530. concept output_iterator = input_or_output_iterator<_Iter>
  531. && indirectly_writable<_Iter, _Tp>
  532. && requires(_Iter __i, _Tp&& __t) { *__i++ = std::forward<_Tp>(__t); };
  533. template<typename _Iter>
  534. concept forward_iterator = input_iterator<_Iter>
  535. && derived_from<__detail::__iter_concept<_Iter>, forward_iterator_tag>
  536. && incrementable<_Iter> && sentinel_for<_Iter, _Iter>;
  537. template<typename _Iter>
  538. concept bidirectional_iterator = forward_iterator<_Iter>
  539. && derived_from<__detail::__iter_concept<_Iter>,
  540. bidirectional_iterator_tag>
  541. && requires(_Iter __i)
  542. {
  543. { --__i } -> same_as<_Iter&>;
  544. { __i-- } -> same_as<_Iter>;
  545. };
  546. template<typename _Iter>
  547. concept random_access_iterator = bidirectional_iterator<_Iter>
  548. && derived_from<__detail::__iter_concept<_Iter>,
  549. random_access_iterator_tag>
  550. && totally_ordered<_Iter> && sized_sentinel_for<_Iter, _Iter>
  551. && requires(_Iter __i, const _Iter __j,
  552. const iter_difference_t<_Iter> __n)
  553. {
  554. { __i += __n } -> same_as<_Iter&>;
  555. { __j + __n } -> same_as<_Iter>;
  556. { __n + __j } -> same_as<_Iter>;
  557. { __i -= __n } -> same_as<_Iter&>;
  558. { __j - __n } -> same_as<_Iter>;
  559. { __j[__n] } -> same_as<iter_reference_t<_Iter>>;
  560. };
  561. template<typename _Iter>
  562. concept contiguous_iterator = random_access_iterator<_Iter>
  563. && derived_from<__detail::__iter_concept<_Iter>, contiguous_iterator_tag>
  564. && is_lvalue_reference_v<iter_reference_t<_Iter>>
  565. && same_as<iter_value_t<_Iter>, remove_cvref_t<iter_reference_t<_Iter>>>
  566. && requires(const _Iter& __i)
  567. {
  568. { std::to_address(__i) }
  569. -> same_as<add_pointer_t<iter_reference_t<_Iter>>>;
  570. };
  571. // [indirectcallable], indirect callable requirements
  572. // [indirectcallable.indirectinvocable], indirect callables
  573. template<typename _Fn, typename _Iter>
  574. concept indirectly_unary_invocable = indirectly_readable<_Iter>
  575. && copy_constructible<_Fn> && invocable<_Fn&, iter_value_t<_Iter>&>
  576. && invocable<_Fn&, iter_reference_t<_Iter>>
  577. && invocable<_Fn&, iter_common_reference_t<_Iter>>
  578. && common_reference_with<invoke_result_t<_Fn&, iter_value_t<_Iter>&>,
  579. invoke_result_t<_Fn&, iter_reference_t<_Iter>>>;
  580. template<typename _Fn, typename _Iter>
  581. concept indirectly_regular_unary_invocable = indirectly_readable<_Iter>
  582. && copy_constructible<_Fn>
  583. && regular_invocable<_Fn&, iter_value_t<_Iter>&>
  584. && regular_invocable<_Fn&, iter_reference_t<_Iter>>
  585. && regular_invocable<_Fn&, iter_common_reference_t<_Iter>>
  586. && common_reference_with<invoke_result_t<_Fn&, iter_value_t<_Iter>&>,
  587. invoke_result_t<_Fn&, iter_reference_t<_Iter>>>;
  588. template<typename _Fn, typename _Iter>
  589. concept indirect_unary_predicate = indirectly_readable<_Iter>
  590. && copy_constructible<_Fn> && predicate<_Fn&, iter_value_t<_Iter>&>
  591. && predicate<_Fn&, iter_reference_t<_Iter>>
  592. && predicate<_Fn&, iter_common_reference_t<_Iter>>;
  593. template<typename _Fn, typename _I1, typename _I2>
  594. concept indirect_binary_predicate
  595. = indirectly_readable<_I1> && indirectly_readable<_I2>
  596. && copy_constructible<_Fn>
  597. && predicate<_Fn&, iter_value_t<_I1>&, iter_value_t<_I2>&>
  598. && predicate<_Fn&, iter_value_t<_I1>&, iter_reference_t<_I2>>
  599. && predicate<_Fn&, iter_reference_t<_I1>, iter_value_t<_I2>&>
  600. && predicate<_Fn&, iter_reference_t<_I1>, iter_reference_t<_I2>>
  601. && predicate<_Fn&, iter_common_reference_t<_I1>,
  602. iter_common_reference_t<_I2>>;
  603. template<typename _Fn, typename _I1, typename _I2 = _I1>
  604. concept indirect_equivalence_relation
  605. = indirectly_readable<_I1> && indirectly_readable<_I2>
  606. && copy_constructible<_Fn>
  607. && equivalence_relation<_Fn&, iter_value_t<_I1>&, iter_value_t<_I2>&>
  608. && equivalence_relation<_Fn&, iter_value_t<_I1>&, iter_reference_t<_I2>>
  609. && equivalence_relation<_Fn&, iter_reference_t<_I1>, iter_value_t<_I2>&>
  610. && equivalence_relation<_Fn&, iter_reference_t<_I1>,
  611. iter_reference_t<_I2>>
  612. && equivalence_relation<_Fn&, iter_common_reference_t<_I1>,
  613. iter_common_reference_t<_I2>>;
  614. template<typename _Fn, typename _I1, typename _I2 = _I1>
  615. concept indirect_strict_weak_order
  616. = indirectly_readable<_I1> && indirectly_readable<_I2>
  617. && copy_constructible<_Fn>
  618. && strict_weak_order<_Fn&, iter_value_t<_I1>&, iter_value_t<_I2>&>
  619. && strict_weak_order<_Fn&, iter_value_t<_I1>&, iter_reference_t<_I2>>
  620. && strict_weak_order<_Fn&, iter_reference_t<_I1>, iter_value_t<_I2>&>
  621. && strict_weak_order<_Fn&, iter_reference_t<_I1>, iter_reference_t<_I2>>
  622. && strict_weak_order<_Fn&, iter_common_reference_t<_I1>,
  623. iter_common_reference_t<_I2>>;
  624. template<typename _Fn, typename... _Is>
  625. requires (indirectly_readable<_Is> && ...)
  626. && invocable<_Fn, iter_reference_t<_Is>...>
  627. using indirect_result_t = invoke_result_t<_Fn, iter_reference_t<_Is>...>;
  628. /// [projected], projected
  629. template<indirectly_readable _Iter,
  630. indirectly_regular_unary_invocable<_Iter> _Proj>
  631. struct projected
  632. {
  633. using value_type = remove_cvref_t<indirect_result_t<_Proj&, _Iter>>;
  634. indirect_result_t<_Proj&, _Iter> operator*() const; // not defined
  635. };
  636. template<weakly_incrementable _Iter, typename _Proj>
  637. struct incrementable_traits<projected<_Iter, _Proj>>
  638. { using difference_type = iter_difference_t<_Iter>; };
  639. // [alg.req], common algorithm requirements
  640. /// [alg.req.ind.move], concept `indirectly_movable`
  641. template<typename _In, typename _Out>
  642. concept indirectly_movable = indirectly_readable<_In>
  643. && indirectly_writable<_Out, iter_rvalue_reference_t<_In>>;
  644. template<typename _In, typename _Out>
  645. concept indirectly_movable_storable = indirectly_movable<_In, _Out>
  646. && indirectly_writable<_Out, iter_value_t<_In>>
  647. && movable<iter_value_t<_In>>
  648. && constructible_from<iter_value_t<_In>, iter_rvalue_reference_t<_In>>
  649. && assignable_from<iter_value_t<_In>&, iter_rvalue_reference_t<_In>>;
  650. /// [alg.req.ind.copy], concept `indirectly_copyable`
  651. template<typename _In, typename _Out>
  652. concept indirectly_copyable = indirectly_readable<_In>
  653. && indirectly_writable<_Out, iter_reference_t<_In>>;
  654. template<typename _In, typename _Out>
  655. concept indirectly_copyable_storable = indirectly_copyable<_In, _Out>
  656. && indirectly_writable<_Out, iter_value_t<_In>&>
  657. && indirectly_writable<_Out, const iter_value_t<_In>&>
  658. && indirectly_writable<_Out, iter_value_t<_In>&&>
  659. && indirectly_writable<_Out, const iter_value_t<_In>&&>
  660. && copyable<iter_value_t<_In>>
  661. && constructible_from<iter_value_t<_In>, iter_reference_t<_In>>
  662. && assignable_from<iter_value_t<_In>&, iter_reference_t<_In>>;
  663. namespace ranges
  664. {
  665. namespace __cust_iswap
  666. {
  667. template<typename _It1, typename _It2>
  668. void iter_swap(_It1, _It2) = delete;
  669. template<typename _Tp, typename _Up>
  670. concept __adl_iswap
  671. = (std::__detail::__class_or_enum<remove_reference_t<_Tp>>
  672. || std::__detail::__class_or_enum<remove_reference_t<_Up>>)
  673. && requires(_Tp&& __t, _Up&& __u) {
  674. iter_swap(static_cast<_Tp&&>(__t), static_cast<_Up&&>(__u));
  675. };
  676. template<typename _Xp, typename _Yp>
  677. constexpr iter_value_t<_Xp>
  678. __iter_exchange_move(_Xp&& __x, _Yp&& __y)
  679. noexcept(noexcept(iter_value_t<_Xp>(iter_move(__x)))
  680. && noexcept(*__x = iter_move(__y)))
  681. {
  682. iter_value_t<_Xp> __old_value(iter_move(__x));
  683. *__x = iter_move(__y);
  684. return __old_value;
  685. }
  686. struct _IterSwap
  687. {
  688. private:
  689. template<typename _Tp, typename _Up>
  690. static constexpr bool
  691. _S_noexcept()
  692. {
  693. if constexpr (__adl_iswap<_Tp, _Up>)
  694. return noexcept(iter_swap(std::declval<_Tp>(),
  695. std::declval<_Up>()));
  696. else if constexpr (indirectly_readable<_Tp>
  697. && indirectly_readable<_Up>
  698. && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
  699. return noexcept(ranges::swap(*std::declval<_Tp>(),
  700. *std::declval<_Up>()));
  701. else
  702. return noexcept(*std::declval<_Tp>()
  703. = __iter_exchange_move(std::declval<_Up>(),
  704. std::declval<_Tp>()));
  705. }
  706. public:
  707. template<typename _Tp, typename _Up>
  708. requires __adl_iswap<_Tp, _Up>
  709. || (indirectly_readable<remove_reference_t<_Tp>>
  710. && indirectly_readable<remove_reference_t<_Up>>
  711. && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
  712. || (indirectly_movable_storable<_Tp, _Up>
  713. && indirectly_movable_storable<_Up, _Tp>)
  714. constexpr void
  715. operator()(_Tp&& __e1, _Up&& __e2) const
  716. noexcept(_S_noexcept<_Tp, _Up>())
  717. {
  718. if constexpr (__adl_iswap<_Tp, _Up>)
  719. iter_swap(static_cast<_Tp&&>(__e1), static_cast<_Up&&>(__e2));
  720. else if constexpr (indirectly_readable<_Tp>
  721. && indirectly_readable<_Up>
  722. && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
  723. ranges::swap(*__e1, *__e2);
  724. else
  725. *__e1 = __iter_exchange_move(__e2, __e1);
  726. }
  727. };
  728. } // namespace __cust_iswap
  729. inline namespace __cust
  730. {
  731. inline constexpr __cust_iswap::_IterSwap iter_swap{};
  732. } // inline namespace __cust
  733. } // namespace ranges
  734. /// [alg.req.ind.swap], concept `indirectly_swappable`
  735. template<typename _I1, typename _I2 = _I1>
  736. concept indirectly_swappable
  737. = indirectly_readable<_I1> && indirectly_readable<_I2>
  738. && requires(const _I1 __i1, const _I2 __i2)
  739. {
  740. ranges::iter_swap(__i1, __i1);
  741. ranges::iter_swap(__i2, __i2);
  742. ranges::iter_swap(__i1, __i2);
  743. ranges::iter_swap(__i2, __i1);
  744. };
  745. /// [alg.req.ind.cmp], concept `indirectly_comparable`
  746. template<typename _I1, typename _I2, typename _Rel, typename _P1 = identity,
  747. typename _P2 = identity>
  748. concept indirectly_comparable
  749. = indirect_binary_predicate<_Rel, projected<_I1, _P1>,
  750. projected<_I2, _P2>>;
  751. /// [alg.req.permutable], concept `permutable`
  752. template<typename _Iter>
  753. concept permutable = forward_iterator<_Iter>
  754. && indirectly_movable_storable<_Iter, _Iter>
  755. && indirectly_swappable<_Iter, _Iter>;
  756. /// [alg.req.mergeable], concept `mergeable`
  757. template<typename _I1, typename _I2, typename _Out,
  758. typename _Rel = ranges::less, typename _P1 = identity,
  759. typename _P2 = identity>
  760. concept mergeable = input_iterator<_I1> && input_iterator<_I2>
  761. && weakly_incrementable<_Out> && indirectly_copyable<_I1, _Out>
  762. && indirectly_copyable<_I2, _Out>
  763. && indirect_strict_weak_order<_Rel, projected<_I1, _P1>,
  764. projected<_I2, _P2>>;
  765. /// [alg.req.sortable], concept `sortable`
  766. template<typename _Iter, typename _Rel = ranges::less,
  767. typename _Proj = identity>
  768. concept sortable = permutable<_Iter>
  769. && indirect_strict_weak_order<_Rel, projected<_Iter, _Proj>>;
  770. struct unreachable_sentinel_t
  771. {
  772. template<weakly_incrementable _It>
  773. friend constexpr bool
  774. operator==(unreachable_sentinel_t, const _It&) noexcept
  775. { return false; }
  776. };
  777. inline constexpr unreachable_sentinel_t unreachable_sentinel{};
  778. struct default_sentinel_t { };
  779. inline constexpr default_sentinel_t default_sentinel{};
  780. namespace __detail
  781. {
  782. template<typename _Tp>
  783. constexpr decay_t<_Tp>
  784. __decay_copy(_Tp&& __t)
  785. noexcept(is_nothrow_convertible_v<_Tp, decay_t<_Tp>>)
  786. { return std::forward<_Tp>(__t); }
  787. template<typename _Tp>
  788. concept __member_begin = requires(_Tp& __t)
  789. {
  790. { __detail::__decay_copy(__t.begin()) } -> input_or_output_iterator;
  791. };
  792. void begin(auto&) = delete;
  793. void begin(const auto&) = delete;
  794. template<typename _Tp>
  795. concept __adl_begin = __class_or_enum<remove_reference_t<_Tp>>
  796. && requires(_Tp& __t)
  797. {
  798. { __detail::__decay_copy(begin(__t)) } -> input_or_output_iterator;
  799. };
  800. // Simplified version of std::ranges::begin that only supports lvalues,
  801. // for use by __range_iter_t below.
  802. template<typename _Tp>
  803. requires is_array_v<_Tp> || __member_begin<_Tp&> || __adl_begin<_Tp&>
  804. auto
  805. __ranges_begin(_Tp& __t)
  806. {
  807. if constexpr (is_array_v<_Tp>)
  808. {
  809. static_assert(sizeof(remove_all_extents_t<_Tp>) != 0,
  810. "not array of incomplete type");
  811. return __t + 0;
  812. }
  813. else if constexpr (__member_begin<_Tp&>)
  814. return __t.begin();
  815. else
  816. return begin(__t);
  817. }
  818. // Implementation of std::ranges::iterator_t, without using ranges::begin.
  819. template<typename _Tp>
  820. using __range_iter_t
  821. = decltype(__detail::__ranges_begin(std::declval<_Tp&>()));
  822. } // namespace __detail
  823. _GLIBCXX_END_NAMESPACE_VERSION
  824. } // namespace std
  825. #endif // C++20 library concepts
  826. #endif // _ITERATOR_CONCEPTS_H