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 #if defined __STRICT_ANSI__ && defined __SIZEOF_INT128__
177  // __int128 is incrementable even if !integral<__int128>
178  template<>
179  struct incrementable_traits<__int128>
180  { using difference_type = __int128; };
181 
182  template<>
183  struct incrementable_traits<unsigned __int128>
184  { using difference_type = __int128; };
185 #endif
186 
187  namespace __detail
188  {
189  // An iterator such that iterator_traits<_Iter> names a specialization
190  // generated from the primary template.
191  template<typename _Iter>
192  concept __primary_traits_iter
193  = __is_base_of(__iterator_traits<_Iter, void>, iterator_traits<_Iter>);
194 
195  template<typename _Iter, typename _Tp>
196  struct __iter_traits_impl
197  { using type = iterator_traits<_Iter>; };
198 
199  template<typename _Iter, typename _Tp>
200  requires __primary_traits_iter<_Iter>
201  struct __iter_traits_impl<_Iter, _Tp>
202  { using type = _Tp; };
203 
204  // ITER_TRAITS
205  template<typename _Iter, typename _Tp = _Iter>
206  using __iter_traits = typename __iter_traits_impl<_Iter, _Tp>::type;
207 
208  template<typename _Tp>
209  using __iter_diff_t = typename
210  __iter_traits<_Tp, incrementable_traits<_Tp>>::difference_type;
211  } // namespace __detail
212 
213  template<typename _Tp>
214  using iter_difference_t = __detail::__iter_diff_t<remove_cvref_t<_Tp>>;
215 
216  namespace __detail
217  {
218  template<typename> struct __cond_value_type { };
219 
220  template<typename _Tp> requires is_object_v<_Tp>
221  struct __cond_value_type<_Tp>
222  { using value_type = remove_cv_t<_Tp>; };
223  } // namespace __detail
224 
225  template<typename> struct indirectly_readable_traits { };
226 
227  template<typename _Tp>
228  struct indirectly_readable_traits<_Tp*>
229  : __detail::__cond_value_type<_Tp>
230  { };
231 
232  template<typename _Iter> requires is_array_v<_Iter>
233  struct indirectly_readable_traits<_Iter>
234  { using value_type = remove_cv_t<remove_extent_t<_Iter>>; };
235 
236  template<typename _Iter>
237  struct indirectly_readable_traits<const _Iter>
238  : indirectly_readable_traits<_Iter>
239  { };
240 
241  template<typename _Tp> requires requires { typename _Tp::value_type; }
242  struct indirectly_readable_traits<_Tp>
243  : __detail::__cond_value_type<typename _Tp::value_type>
244  { };
245 
246  template<typename _Tp> requires requires { typename _Tp::element_type; }
247  struct indirectly_readable_traits<_Tp>
248  : __detail::__cond_value_type<typename _Tp::element_type>
249  { };
250 
251  namespace __detail
252  {
253  template<typename _Tp>
254  using __iter_value_t = typename
255  __iter_traits<_Tp, indirectly_readable_traits<_Tp>>::value_type;
256  } // namespace __detail
257 
258  template<typename _Tp>
259  using iter_value_t = __detail::__iter_value_t<remove_cvref_t<_Tp>>;
260 
261  namespace __detail
262  {
263  // _GLIBCXX_RESOLVE_LIB_DEFECTS
264  // 3420. cpp17-iterator should check [type] looks like an iterator first
265  template<typename _Iter>
266  concept __cpp17_iterator = requires(_Iter __it)
267  {
268  { *__it } -> __can_reference;
269  { ++__it } -> same_as<_Iter&>;
270  { *__it++ } -> __can_reference;
271  } && copyable<_Iter>;
272 
273  template<typename _Iter>
274  concept __cpp17_input_iterator = __cpp17_iterator<_Iter>
275  && equality_comparable<_Iter>
276  && requires(_Iter __it)
277  {
278  typename incrementable_traits<_Iter>::difference_type;
279  typename indirectly_readable_traits<_Iter>::value_type;
280  typename common_reference_t<iter_reference_t<_Iter>&&,
281  typename indirectly_readable_traits<_Iter>::value_type&>;
282  typename common_reference_t<decltype(*__it++)&&,
283  typename indirectly_readable_traits<_Iter>::value_type&>;
284  requires signed_integral<
285  typename incrementable_traits<_Iter>::difference_type>;
286  };
287 
288  template<typename _Iter>
289  concept __cpp17_fwd_iterator = __cpp17_input_iterator<_Iter>
290  && constructible_from<_Iter>
291  && is_lvalue_reference_v<iter_reference_t<_Iter>>
292  && same_as<remove_cvref_t<iter_reference_t<_Iter>>,
293  typename indirectly_readable_traits<_Iter>::value_type>
294  && requires(_Iter __it)
295  {
296  { __it++ } -> convertible_to<const _Iter&>;
297  { *__it++ } -> same_as<iter_reference_t<_Iter>>;
298  };
299 
300  template<typename _Iter>
301  concept __cpp17_bidi_iterator = __cpp17_fwd_iterator<_Iter>
302  && requires(_Iter __it)
303  {
304  { --__it } -> same_as<_Iter&>;
305  { __it-- } -> convertible_to<const _Iter&>;
306  { *__it-- } -> same_as<iter_reference_t<_Iter>>;
307  };
308 
309  template<typename _Iter>
310  concept __cpp17_randacc_iterator = __cpp17_bidi_iterator<_Iter>
311  && totally_ordered<_Iter>
312  && requires(_Iter __it,
313  typename incrementable_traits<_Iter>::difference_type __n)
314  {
315  { __it += __n } -> same_as<_Iter&>;
316  { __it -= __n } -> same_as<_Iter&>;
317  { __it + __n } -> same_as<_Iter>;
318  { __n + __it } -> same_as<_Iter>;
319  { __it - __n } -> same_as<_Iter>;
320  { __it - __it } -> same_as<decltype(__n)>;
321  { __it[__n] } -> convertible_to<iter_reference_t<_Iter>>;
322  };
323 
324  template<typename _Iter>
325  concept __iter_with_nested_types = requires {
326  typename _Iter::iterator_category;
327  typename _Iter::value_type;
328  typename _Iter::difference_type;
329  typename _Iter::reference;
330  };
331 
332  template<typename _Iter>
333  concept __iter_without_nested_types = !__iter_with_nested_types<_Iter>;
334 
335  // FIXME: These have to be at namespace-scope because of PR 92103.
336  template<typename _Iter, bool __use_arrow = false>
337  struct __ptr
338  { using type = void; };
339 
340  template<typename _Iter> requires requires { typename _Iter::pointer; }
341  struct __ptr<_Iter, true>
342  { using type = typename _Iter::pointer; };
343 
344  template<typename _Iter> requires requires { typename _Iter::pointer; }
345  struct __ptr<_Iter, false>
346  { using type = typename _Iter::pointer; };
347 
348  template<typename _Iter>
349  requires (!requires { typename _Iter::pointer; }
350  && requires(_Iter& __it) { __it.operator->(); })
351  struct __ptr<_Iter, true>
352  { using type = decltype(std::declval<_Iter&>().operator->()); };
353 
354  template<typename _Iter>
355  struct __ref
356  { using type = iter_reference_t<_Iter>; };
357 
358  template<typename _Iter> requires requires { typename _Iter::reference; }
359  struct __ref<_Iter>
360  { using type = typename _Iter::reference; };
361 
362  template<typename _Iter>
363  struct __cat
364  { using type = input_iterator_tag; };
365 
366  template<typename _Iter>
367  requires requires { typename _Iter::iterator_category; }
368  struct __cat<_Iter>
369  { using type = typename _Iter::iterator_category; };
370 
371  template<typename _Iter>
372  requires (!requires { typename _Iter::iterator_category; }
373  && __detail::__cpp17_randacc_iterator<_Iter>)
374  struct __cat<_Iter>
375  { using type = random_access_iterator_tag; };
376 
377  template<typename _Iter>
378  requires (!requires { typename _Iter::iterator_category; }
379  && __detail::__cpp17_bidi_iterator<_Iter>)
380  struct __cat<_Iter>
381  { using type = bidirectional_iterator_tag; };
382 
383  template<typename _Iter>
384  requires (!requires { typename _Iter::iterator_category; }
385  && __detail::__cpp17_fwd_iterator<_Iter>)
386  struct __cat<_Iter>
387  { using type = forward_iterator_tag; };
388 
389  template<typename _Iter>
390  struct __diff
391  { using type = void; };
392 
393  template<typename _Iter>
394  requires requires {
395  typename incrementable_traits<_Iter>::difference_type;
396  }
397  struct __diff<_Iter>
398  {
399  using type = typename incrementable_traits<_Iter>::difference_type;
400  };
401 
402  } // namespace __detail
403 
404  template<typename _Iterator>
405  requires __detail::__iter_with_nested_types<_Iterator>
406  struct __iterator_traits<_Iterator, void>
407  {
408  using iterator_category = typename _Iterator::iterator_category;
409  using value_type = typename _Iterator::value_type;
410  using difference_type = typename _Iterator::difference_type;
411  using pointer = typename __detail::__ptr<_Iterator>::type;
412  using reference = typename _Iterator::reference;
413  };
414 
415  template<typename _Iterator>
416  requires __detail::__iter_without_nested_types<_Iterator>
417  && __detail::__cpp17_input_iterator<_Iterator>
418  struct __iterator_traits<_Iterator, void>
419  {
420  using iterator_category = typename __detail::__cat<_Iterator>::type;
421  using value_type
422  = typename indirectly_readable_traits<_Iterator>::value_type;
423  using difference_type
424  = typename incrementable_traits<_Iterator>::difference_type;
425  using pointer = typename __detail::__ptr<_Iterator, true>::type;
426  using reference = typename __detail::__ref<_Iterator>::type;
427  };
428 
429  template<typename _Iterator>
430  requires __detail::__iter_without_nested_types<_Iterator>
431  && __detail::__cpp17_iterator<_Iterator>
432  struct __iterator_traits<_Iterator, void>
433  {
434  using iterator_category = output_iterator_tag;
435  using value_type = void;
436  using difference_type = typename __detail::__diff<_Iterator>::type;
437  using pointer = void;
438  using reference = void;
439  };
440 
441  namespace __detail
442  {
443  template<typename _Iter>
444  struct __iter_concept_impl;
445 
446  // ITER_CONCEPT(I) is ITER_TRAITS(I)::iterator_concept if that is valid.
447  template<typename _Iter>
448  requires requires { typename __iter_traits<_Iter>::iterator_concept; }
449  struct __iter_concept_impl<_Iter>
450  { using type = typename __iter_traits<_Iter>::iterator_concept; };
451 
452  // Otherwise, ITER_TRAITS(I)::iterator_category if that is valid.
453  template<typename _Iter>
454  requires (!requires { typename __iter_traits<_Iter>::iterator_concept; }
455  && requires { typename __iter_traits<_Iter>::iterator_category; })
456  struct __iter_concept_impl<_Iter>
457  { using type = typename __iter_traits<_Iter>::iterator_category; };
458 
459  // Otherwise, random_access_tag if iterator_traits<I> is not specialized.
460  template<typename _Iter>
461  requires (!requires { typename __iter_traits<_Iter>::iterator_concept; }
462  && !requires { typename __iter_traits<_Iter>::iterator_category; }
463  && __primary_traits_iter<_Iter>)
464  struct __iter_concept_impl<_Iter>
465  { using type = random_access_iterator_tag; };
466 
467  // Otherwise, there is no ITER_CONCEPT(I) type.
468  template<typename _Iter>
469  struct __iter_concept_impl
470  { };
471 
472  // ITER_CONCEPT
473  template<typename _Iter>
474  using __iter_concept = typename __iter_concept_impl<_Iter>::type;
475 
476  template<typename _In>
477  concept __indirectly_readable_impl = requires(const _In __in)
478  {
479  typename iter_value_t<_In>;
480  typename iter_reference_t<_In>;
481  typename iter_rvalue_reference_t<_In>;
482  { *__in } -> same_as<iter_reference_t<_In>>;
483  { ranges::iter_move(__in) } -> same_as<iter_rvalue_reference_t<_In>>;
484  }
485  && common_reference_with<iter_reference_t<_In>&&, iter_value_t<_In>&>
486  && common_reference_with<iter_reference_t<_In>&&,
487  iter_rvalue_reference_t<_In>&&>
488  && common_reference_with<iter_rvalue_reference_t<_In>&&,
489  const iter_value_t<_In>&>;
490 
491  } // namespace __detail
492 
493  /// Requirements for types that are readable by applying operator*.
494  template<typename _In>
495  concept indirectly_readable
496  = __detail::__indirectly_readable_impl<remove_cvref_t<_In>>;
497 
498  template<indirectly_readable _Tp>
499  using iter_common_reference_t
500  = common_reference_t<iter_reference_t<_Tp>, iter_value_t<_Tp>&>;
501 
502  /// Requirements for writing a value into an iterator's referenced object.
503  template<typename _Out, typename _Tp>
504  concept indirectly_writable = requires(_Out&& __o, _Tp&& __t)
505  {
506  *__o = std::forward<_Tp>(__t);
507  *std::forward<_Out>(__o) = std::forward<_Tp>(__t);
508  const_cast<const iter_reference_t<_Out>&&>(*__o)
509  = std::forward<_Tp>(__t);
510  const_cast<const iter_reference_t<_Out>&&>(*std::forward<_Out>(__o))
511  = std::forward<_Tp>(__t);
512  };
513 
514  namespace ranges::__detail
515  {
516 #if __SIZEOF_INT128__
517  using __max_diff_type = __int128;
518  using __max_size_type = unsigned __int128;
519 #else
520  using __max_diff_type = long long;
521  using __max_size_type = unsigned long long;
522 #endif
523 
524  template<typename _Tp>
525  concept __is_integer_like = integral<_Tp>
526  || same_as<_Tp, __max_diff_type> || same_as<_Tp, __max_size_type>;
527 
528  template<typename _Tp>
529  concept __is_signed_integer_like = signed_integral<_Tp>
530  || same_as<_Tp, __max_diff_type>;
531 
532  } // namespace ranges::__detail
533 
534  namespace __detail { using ranges::__detail::__is_signed_integer_like; }
535 
536  /// Requirements on types that can be incremented with ++.
537  template<typename _Iter>
538  concept weakly_incrementable = default_initializable<_Iter>
539  && movable<_Iter>
540  && requires(_Iter __i)
541  {
542  typename iter_difference_t<_Iter>;
543  requires __detail::__is_signed_integer_like<iter_difference_t<_Iter>>;
544  { ++__i } -> same_as<_Iter&>;
545  __i++;
546  };
547 
548  template<typename _Iter>
549  concept incrementable = regular<_Iter> && weakly_incrementable<_Iter>
550  && requires(_Iter __i) { { __i++ } -> same_as<_Iter>; };
551 
552  template<typename _Iter>
553  concept input_or_output_iterator
554  = requires(_Iter __i) { { *__i } -> __detail::__can_reference; }
555  && weakly_incrementable<_Iter>;
556 
557  template<typename _Sent, typename _Iter>
558  concept sentinel_for = semiregular<_Sent>
559  && input_or_output_iterator<_Iter>
560  && __detail::__weakly_eq_cmp_with<_Sent, _Iter>;
561 
562  template<typename _Sent, typename _Iter>
563  inline constexpr bool disable_sized_sentinel_for = false;
564 
565  template<typename _Sent, typename _Iter>
566  concept sized_sentinel_for = sentinel_for<_Sent, _Iter>
567  && !disable_sized_sentinel_for<remove_cv_t<_Sent>, remove_cv_t<_Iter>>
568  && requires(const _Iter& __i, const _Sent& __s)
569  {
570  { __s - __i } -> same_as<iter_difference_t<_Iter>>;
571  { __i - __s } -> same_as<iter_difference_t<_Iter>>;
572  };
573 
574  template<typename _Iter>
575  concept input_iterator = input_or_output_iterator<_Iter>
576  && indirectly_readable<_Iter>
577  && requires { typename __detail::__iter_concept<_Iter>; }
578  && derived_from<__detail::__iter_concept<_Iter>, input_iterator_tag>;
579 
580  template<typename _Iter, typename _Tp>
581  concept output_iterator = input_or_output_iterator<_Iter>
582  && indirectly_writable<_Iter, _Tp>
583  && requires(_Iter __i, _Tp&& __t) { *__i++ = std::forward<_Tp>(__t); };
584 
585  template<typename _Iter>
586  concept forward_iterator = input_iterator<_Iter>
587  && derived_from<__detail::__iter_concept<_Iter>, forward_iterator_tag>
588  && incrementable<_Iter> && sentinel_for<_Iter, _Iter>;
589 
590  template<typename _Iter>
591  concept bidirectional_iterator = forward_iterator<_Iter>
592  && derived_from<__detail::__iter_concept<_Iter>,
593  bidirectional_iterator_tag>
594  && requires(_Iter __i)
595  {
596  { --__i } -> same_as<_Iter&>;
597  { __i-- } -> same_as<_Iter>;
598  };
599 
600  template<typename _Iter>
601  concept random_access_iterator = bidirectional_iterator<_Iter>
602  && derived_from<__detail::__iter_concept<_Iter>,
603  random_access_iterator_tag>
604  && totally_ordered<_Iter> && sized_sentinel_for<_Iter, _Iter>
605  && requires(_Iter __i, const _Iter __j,
606  const iter_difference_t<_Iter> __n)
607  {
608  { __i += __n } -> same_as<_Iter&>;
609  { __j + __n } -> same_as<_Iter>;
610  { __n + __j } -> same_as<_Iter>;
611  { __i -= __n } -> same_as<_Iter&>;
612  { __j - __n } -> same_as<_Iter>;
613  { __j[__n] } -> same_as<iter_reference_t<_Iter>>;
614  };
615 
616  template<typename _Iter>
617  concept contiguous_iterator = random_access_iterator<_Iter>
618  && derived_from<__detail::__iter_concept<_Iter>, contiguous_iterator_tag>
619  && is_lvalue_reference_v<iter_reference_t<_Iter>>
620  && same_as<iter_value_t<_Iter>, remove_cvref_t<iter_reference_t<_Iter>>>
621  && requires(const _Iter& __i)
622  {
623  { std::to_address(__i) }
624  -> same_as<add_pointer_t<iter_reference_t<_Iter>>>;
625  };
626 
627  // [indirectcallable], indirect callable requirements
628 
629  // [indirectcallable.indirectinvocable], indirect callables
630 
631  template<typename _Fn, typename _Iter>
632  concept indirectly_unary_invocable = indirectly_readable<_Iter>
633  && copy_constructible<_Fn> && invocable<_Fn&, iter_value_t<_Iter>&>
634  && invocable<_Fn&, iter_reference_t<_Iter>>
635  && invocable<_Fn&, iter_common_reference_t<_Iter>>
636  && common_reference_with<invoke_result_t<_Fn&, iter_value_t<_Iter>&>,
637  invoke_result_t<_Fn&, iter_reference_t<_Iter>>>;
638 
639  template<typename _Fn, typename _Iter>
640  concept indirectly_regular_unary_invocable = indirectly_readable<_Iter>
641  && copy_constructible<_Fn>
642  && regular_invocable<_Fn&, iter_value_t<_Iter>&>
643  && regular_invocable<_Fn&, iter_reference_t<_Iter>>
644  && regular_invocable<_Fn&, iter_common_reference_t<_Iter>>
645  && common_reference_with<invoke_result_t<_Fn&, iter_value_t<_Iter>&>,
646  invoke_result_t<_Fn&, iter_reference_t<_Iter>>>;
647 
648  template<typename _Fn, typename _Iter>
649  concept indirect_unary_predicate = indirectly_readable<_Iter>
650  && copy_constructible<_Fn> && predicate<_Fn&, iter_value_t<_Iter>&>
651  && predicate<_Fn&, iter_reference_t<_Iter>>
652  && predicate<_Fn&, iter_common_reference_t<_Iter>>;
653 
654  template<typename _Fn, typename _I1, typename _I2>
655  concept indirect_binary_predicate
656  = indirectly_readable<_I1> && indirectly_readable<_I2>
657  && copy_constructible<_Fn>
658  && predicate<_Fn&, iter_value_t<_I1>&, iter_value_t<_I2>&>
659  && predicate<_Fn&, iter_value_t<_I1>&, iter_reference_t<_I2>>
660  && predicate<_Fn&, iter_reference_t<_I1>, iter_value_t<_I2>&>
661  && predicate<_Fn&, iter_reference_t<_I1>, iter_reference_t<_I2>>
662  && predicate<_Fn&, iter_common_reference_t<_I1>,
663  iter_common_reference_t<_I2>>;
664 
665  template<typename _Fn, typename _I1, typename _I2 = _I1>
666  concept indirect_equivalence_relation
667  = indirectly_readable<_I1> && indirectly_readable<_I2>
668  && copy_constructible<_Fn>
669  && equivalence_relation<_Fn&, iter_value_t<_I1>&, iter_value_t<_I2>&>
670  && equivalence_relation<_Fn&, iter_value_t<_I1>&, iter_reference_t<_I2>>
671  && equivalence_relation<_Fn&, iter_reference_t<_I1>, iter_value_t<_I2>&>
672  && equivalence_relation<_Fn&, iter_reference_t<_I1>,
673  iter_reference_t<_I2>>
674  && equivalence_relation<_Fn&, iter_common_reference_t<_I1>,
675  iter_common_reference_t<_I2>>;
676 
677  template<typename _Fn, typename _I1, typename _I2 = _I1>
678  concept indirect_strict_weak_order
679  = indirectly_readable<_I1> && indirectly_readable<_I2>
680  && copy_constructible<_Fn>
681  && strict_weak_order<_Fn&, iter_value_t<_I1>&, iter_value_t<_I2>&>
682  && strict_weak_order<_Fn&, iter_value_t<_I1>&, iter_reference_t<_I2>>
683  && strict_weak_order<_Fn&, iter_reference_t<_I1>, iter_value_t<_I2>&>
684  && strict_weak_order<_Fn&, iter_reference_t<_I1>, iter_reference_t<_I2>>
685  && strict_weak_order<_Fn&, iter_common_reference_t<_I1>,
686  iter_common_reference_t<_I2>>;
687 
688  template<typename _Fn, typename... _Is>
689  requires (indirectly_readable<_Is> && ...)
690  && invocable<_Fn, iter_reference_t<_Is>...>
691  using indirect_result_t = invoke_result_t<_Fn, iter_reference_t<_Is>...>;
692 
693  /// [projected], projected
694  template<indirectly_readable _Iter,
695  indirectly_regular_unary_invocable<_Iter> _Proj>
696  struct projected
697  {
698  using value_type = remove_cvref_t<indirect_result_t<_Proj&, _Iter>>;
699 
700  indirect_result_t<_Proj&, _Iter> operator*() const; // not defined
701  };
702 
703  template<weakly_incrementable _Iter, typename _Proj>
704  struct incrementable_traits<projected<_Iter, _Proj>>
705  { using difference_type = iter_difference_t<_Iter>; };
706 
707  // [alg.req], common algorithm requirements
708 
709  /// [alg.req.ind.move], concept `indirectly_movable`
710 
711  template<typename _In, typename _Out>
712  concept indirectly_movable = indirectly_readable<_In>
713  && indirectly_writable<_Out, iter_rvalue_reference_t<_In>>;
714 
715  template<typename _In, typename _Out>
716  concept indirectly_movable_storable = indirectly_movable<_In, _Out>
717  && indirectly_writable<_Out, iter_value_t<_In>>
718  && movable<iter_value_t<_In>>
719  && constructible_from<iter_value_t<_In>, iter_rvalue_reference_t<_In>>
720  && assignable_from<iter_value_t<_In>&, iter_rvalue_reference_t<_In>>;
721 
722  /// [alg.req.ind.copy], concept `indirectly_copyable`
723  template<typename _In, typename _Out>
724  concept indirectly_copyable = indirectly_readable<_In>
725  && indirectly_writable<_Out, iter_reference_t<_In>>;
726 
727  template<typename _In, typename _Out>
728  concept indirectly_copyable_storable = indirectly_copyable<_In, _Out>
729  && indirectly_writable<_Out, iter_value_t<_In>&>
730  && indirectly_writable<_Out, const iter_value_t<_In>&>
731  && indirectly_writable<_Out, iter_value_t<_In>&&>
732  && indirectly_writable<_Out, const iter_value_t<_In>&&>
733  && copyable<iter_value_t<_In>>
734  && constructible_from<iter_value_t<_In>, iter_reference_t<_In>>
735  && assignable_from<iter_value_t<_In>&, iter_reference_t<_In>>;
736 
737 namespace ranges
738 {
739  namespace __cust_iswap
740  {
741  template<typename _It1, typename _It2>
742  void iter_swap(_It1, _It2) = delete;
743 
744  template<typename _Tp, typename _Up>
745  concept __adl_iswap
746  = (std::__detail::__class_or_enum<remove_reference_t<_Tp>>
747  || std::__detail::__class_or_enum<remove_reference_t<_Up>>)
748  && requires(_Tp&& __t, _Up&& __u) {
749  iter_swap(static_cast<_Tp&&>(__t), static_cast<_Up&&>(__u));
750  };
751 
752  template<typename _Xp, typename _Yp>
753  constexpr iter_value_t<_Xp>
754  __iter_exchange_move(_Xp&& __x, _Yp&& __y)
755  noexcept(noexcept(iter_value_t<_Xp>(iter_move(__x)))
756  && noexcept(*__x = iter_move(__y)))
757  {
758  iter_value_t<_Xp> __old_value(iter_move(__x));
759  *__x = iter_move(__y);
760  return __old_value;
761  }
762 
763  struct _IterSwap
764  {
765  private:
766  template<typename _Tp, typename _Up>
767  static constexpr bool
768  _S_noexcept()
769  {
770  if constexpr (__adl_iswap<_Tp, _Up>)
771  return noexcept(iter_swap(std::declval<_Tp>(),
772  std::declval<_Up>()));
773  else if constexpr (indirectly_readable<_Tp>
774  && indirectly_readable<_Up>
775  && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
776  return noexcept(ranges::swap(*std::declval<_Tp>(),
777  *std::declval<_Up>()));
778  else
779  return noexcept(*std::declval<_Tp>()
780  = __iter_exchange_move(std::declval<_Up>(),
781  std::declval<_Tp>()));
782  }
783 
784  public:
785  template<typename _Tp, typename _Up>
786  requires __adl_iswap<_Tp, _Up>
787  || (indirectly_readable<remove_reference_t<_Tp>>
788  && indirectly_readable<remove_reference_t<_Up>>
789  && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
790  || (indirectly_movable_storable<_Tp, _Up>
791  && indirectly_movable_storable<_Up, _Tp>)
792  constexpr void
793  operator()(_Tp&& __e1, _Up&& __e2) const
794  noexcept(_S_noexcept<_Tp, _Up>())
795  {
796  if constexpr (__adl_iswap<_Tp, _Up>)
797  iter_swap(static_cast<_Tp&&>(__e1), static_cast<_Up&&>(__e2));
798  else if constexpr (indirectly_readable<_Tp>
799  && indirectly_readable<_Up>
800  && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
801  ranges::swap(*__e1, *__e2);
802  else
803  *__e1 = __iter_exchange_move(__e2, __e1);
804  }
805  };
806  } // namespace __cust_iswap
807 
808  inline namespace __cust
809  {
810  inline constexpr __cust_iswap::_IterSwap iter_swap{};
811  } // inline namespace __cust
812 
813 } // namespace ranges
814 
815  /// [alg.req.ind.swap], concept `indirectly_swappable`
816  template<typename _I1, typename _I2 = _I1>
817  concept indirectly_swappable
818  = indirectly_readable<_I1> && indirectly_readable<_I2>
819  && requires(const _I1 __i1, const _I2 __i2)
820  {
821  ranges::iter_swap(__i1, __i1);
822  ranges::iter_swap(__i2, __i2);
823  ranges::iter_swap(__i1, __i2);
824  ranges::iter_swap(__i2, __i1);
825  };
826 
827  /// [alg.req.ind.cmp], concept `indirectly_comparable`
828  template<typename _I1, typename _I2, typename _Rel, typename _P1 = identity,
829  typename _P2 = identity>
830  concept indirectly_comparable
831  = indirect_binary_predicate<_Rel, projected<_I1, _P1>,
832  projected<_I2, _P2>>;
833 
834  /// [alg.req.permutable], concept `permutable`
835  template<typename _Iter>
836  concept permutable = forward_iterator<_Iter>
837  && indirectly_movable_storable<_Iter, _Iter>
838  && indirectly_swappable<_Iter, _Iter>;
839 
840  /// [alg.req.mergeable], concept `mergeable`
841  template<typename _I1, typename _I2, typename _Out,
842  typename _Rel = ranges::less, typename _P1 = identity,
843  typename _P2 = identity>
844  concept mergeable = input_iterator<_I1> && input_iterator<_I2>
845  && weakly_incrementable<_Out> && indirectly_copyable<_I1, _Out>
846  && indirectly_copyable<_I2, _Out>
847  && indirect_strict_weak_order<_Rel, projected<_I1, _P1>,
848  projected<_I2, _P2>>;
849 
850  /// [alg.req.sortable], concept `sortable`
851  template<typename _Iter, typename _Rel = ranges::less,
852  typename _Proj = identity>
853  concept sortable = permutable<_Iter>
854  && indirect_strict_weak_order<_Rel, projected<_Iter, _Proj>>;
855 
856  struct unreachable_sentinel_t
857  {
858  template<weakly_incrementable _It>
859  friend constexpr bool
860  operator==(unreachable_sentinel_t, const _It&) noexcept
861  { return false; }
862  };
863 
864  inline constexpr unreachable_sentinel_t unreachable_sentinel{};
865 
866  struct default_sentinel_t { };
867  inline constexpr default_sentinel_t default_sentinel{};
868 
869  namespace __detail
870  {
871  template<typename _Tp>
872  constexpr decay_t<_Tp>
873  __decay_copy(_Tp&& __t)
874  noexcept(is_nothrow_convertible_v<_Tp, decay_t<_Tp>>)
875  { return std::forward<_Tp>(__t); }
876 
877  template<typename _Tp>
878  concept __member_begin = requires(_Tp& __t)
879  {
880  { __detail::__decay_copy(__t.begin()) } -> input_or_output_iterator;
881  };
882 
883  void begin(auto&) = delete;
884  void begin(const auto&) = delete;
885 
886  template<typename _Tp>
887  concept __adl_begin = __class_or_enum<remove_reference_t<_Tp>>
888  && requires(_Tp& __t)
889  {
890  { __detail::__decay_copy(begin(__t)) } -> input_or_output_iterator;
891  };
892 
893  // Simplified version of std::ranges::begin that only supports lvalues,
894  // for use by __range_iter_t below.
895  template<typename _Tp>
896  requires is_array_v<_Tp> || __member_begin<_Tp&> || __adl_begin<_Tp&>
897  auto
898  __ranges_begin(_Tp& __t)
899  {
900  if constexpr (is_array_v<_Tp>)
901  {
902  static_assert(sizeof(remove_all_extents_t<_Tp>) != 0,
903  "not array of incomplete type");
904  return __t + 0;
905  }
906  else if constexpr (__member_begin<_Tp&>)
907  return __t.begin();
908  else
909  return begin(__t);
910  }
911 
912  // Implementation of std::ranges::iterator_t, without using ranges::begin.
913  template<typename _Tp>
914  using __range_iter_t
915  = decltype(__detail::__ranges_begin(std::declval<_Tp&>()));
916 
917  } // namespace __detail
918 
919 _GLIBCXX_END_NAMESPACE_VERSION
920 } // namespace std
921 #endif // C++20 library concepts
922 #endif // _ITERATOR_CONCEPTS_H
std::begin
_Tp * begin(valarray< _Tp > &__va)
Return an iterator pointing to the first element of the valarray.
Definition: valarray:1214
std::operator*
constexpr complex< _Tp > operator*(const complex< _Tp > &__x, const complex< _Tp > &__y)
Return new complex value x times y.
Definition: complex:391
std::remove_reference_t
typename remove_reference< _Tp >::type remove_reference_t
Alias template for remove_reference.
Definition: type_traits:1635
std
ISO C++ entities toplevel namespace is std.
ptr_traits.h
range_cmp.h
concepts