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