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-2025 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#ifdef _GLIBCXX_SYSHDR
34#pragma GCC system_header
35#endif
36
37#if __cplusplus >= 202002L
38#include <concepts>
39#include <bits/ptr_traits.h> // to_address
40#include <bits/ranges_cmp.h> // identity, ranges::less
41
42#pragma GCC diagnostic push
43#pragma GCC diagnostic ignored "-Wpedantic" // __int128
44
45namespace std _GLIBCXX_VISIBILITY(default)
46{
47_GLIBCXX_BEGIN_NAMESPACE_VERSION
48
49 /** A sentinel type that can be used to check for the end of a range.
50 *
51 * For some iterator types the past-the-end sentinel value is independent
52 * of the underlying sequence, and a default sentinel can be used with them.
53 * For example, a `std::counted_iterator` keeps a count of how many elements
54 * remain, and so checking for the past-the-end value only requires checking
55 * if that count has reached zero. A past-the-end `std::istream_iterator` is
56 * equal to the default-constructed value, which can be easily checked.
57 *
58 * Comparing iterators of these types to `std::default_sentinel` is a
59 * convenient way to check if the end has been reached.
60 *
61 * @since C++20
62 */
64
65 /// A default sentinel value.
67
68#if __cpp_lib_concepts
69 struct input_iterator_tag;
70 struct output_iterator_tag;
71 struct forward_iterator_tag;
72 struct bidirectional_iterator_tag;
73 struct random_access_iterator_tag;
74 struct contiguous_iterator_tag;
75
76 template<typename _Iterator>
77 struct iterator_traits;
78
79 template<typename _Tp> requires is_object_v<_Tp>
80 struct iterator_traits<_Tp*>;
81
82 template<typename _Iterator, typename>
83 struct __iterator_traits;
84
85 namespace __detail
86 {
87 template<typename _Tp>
88 using __with_ref = _Tp&;
89
90 template<typename _Tp>
91 concept __can_reference = requires { typename __with_ref<_Tp>; };
92
93 template<typename _Tp>
94 concept __dereferenceable = requires(_Tp& __t)
95 {
96 { *__t } -> __can_reference;
97 };
98 } // namespace __detail
99
100 template<__detail::__dereferenceable _Tp>
101 using iter_reference_t = decltype(*std::declval<_Tp&>());
102
103 namespace ranges
104 {
105 /// @cond undocumented
106 // Implementation of std::ranges::iter_move, [iterator.cust.move].
107 namespace __imove
108 {
109 void iter_move() = delete;
110
111 // Satisfied if _Tp is a class or enumeration type and iter_move
112 // can be found by argument-dependent lookup.
113 template<typename _Tp>
114 concept __adl_imove
115 = (std::__detail::__class_or_enum<remove_reference_t<_Tp>>)
116 && requires(_Tp&& __t) { iter_move(static_cast<_Tp&&>(__t)); };
117
118 struct _IterMove
119 {
120 private:
121 // The type returned by dereferencing a value of type _Tp.
122 // Unlike iter_reference_t this preserves the value category of _Tp.
123 template<typename _Tp>
124 using __iter_ref_t = decltype(*std::declval<_Tp>());
125
126 template<typename _Tp>
127 struct __result
128 { using type = __iter_ref_t<_Tp>; };
129
130 // Use iter_move(E) if that works.
131 template<typename _Tp>
132 requires __adl_imove<_Tp>
133 struct __result<_Tp>
134 { using type = decltype(iter_move(std::declval<_Tp>())); };
135
136 // Otherwise, if *E is an lvalue, use std::move(*E).
137 template<typename _Tp>
138 requires (!__adl_imove<_Tp>)
139 && is_lvalue_reference_v<__iter_ref_t<_Tp>>
140 struct __result<_Tp>
141 {
142 // Instead of decltype(std::move(*E)) we define the type as the
143 // return type of std::move, i.e. remove_reference_t<iter_ref>&&.
144 // N.B. the use of decltype(declval<X>()) instead of just X&& is
145 // needed for function reference types, see PR libstdc++/119469.
146 using type
148 };
149
150 template<typename _Tp>
151 static constexpr bool
152 _S_noexcept()
153 {
154 if constexpr (__adl_imove<_Tp>)
155 return noexcept(iter_move(std::declval<_Tp>()));
156 else
157 return noexcept(*std::declval<_Tp>());
158 }
159
160 public:
161 // The result type of iter_move(std::declval<_Tp>())
162 template<typename _Tp>
163 using __type = typename __result<_Tp>::type;
164
165 template<typename _Tp>
166 requires __adl_imove<_Tp> || requires { typename __iter_ref_t<_Tp>; }
167 [[nodiscard]]
168 constexpr __type<_Tp>
169 operator()(_Tp&& __e) const
170 noexcept(_S_noexcept<_Tp>())
171 {
172 if constexpr (__adl_imove<_Tp>)
173 return iter_move(static_cast<_Tp&&>(__e));
174 else if constexpr (is_lvalue_reference_v<__iter_ref_t<_Tp>>)
175 return std::move(*static_cast<_Tp&&>(__e));
176 else
177 return *static_cast<_Tp&&>(__e);
178 }
179 };
180 } // namespace __imove
181 /// @endcond
182
183 inline namespace _Cpo {
184 inline constexpr __imove::_IterMove iter_move{};
185 }
186 } // namespace ranges
187
188 /// The result type of ranges::iter_move(std::declval<_Tp&>())
189 template<__detail::__dereferenceable _Tp>
190 requires __detail::__can_reference<ranges::__imove::_IterMove::__type<_Tp&>>
191 using iter_rvalue_reference_t = ranges::__imove::_IterMove::__type<_Tp&>;
192
193 template<typename> struct incrementable_traits { };
194
195 template<typename _Tp> requires is_object_v<_Tp>
196 struct incrementable_traits<_Tp*>
197 { using difference_type = ptrdiff_t; };
198
199 template<typename _Iter>
200 struct incrementable_traits<const _Iter>
201 : incrementable_traits<_Iter> { };
202
203 template<typename _Tp> requires requires { typename _Tp::difference_type; }
204 struct incrementable_traits<_Tp>
205 { using difference_type = typename _Tp::difference_type; };
206
207 template<typename _Tp>
208 requires (!requires { typename _Tp::difference_type; }
209 && requires(const _Tp& __a, const _Tp& __b)
210 { { __a - __b } -> integral; })
211 struct incrementable_traits<_Tp>
212 {
213 using difference_type
215 };
216
217 namespace __detail
218 {
219 // An iterator such that iterator_traits<_Iter> names a specialization
220 // generated from the primary template.
221 template<typename _Iter>
222 concept __primary_traits_iter
223 = __is_base_of(__iterator_traits<_Iter, void>, iterator_traits<_Iter>);
224
225 template<typename _Iter, typename _Tp>
226 struct __iter_traits_impl
227 { using type = iterator_traits<_Iter>; };
228
229 template<typename _Iter, typename _Tp>
230 requires __primary_traits_iter<_Iter>
231 struct __iter_traits_impl<_Iter, _Tp>
232 { using type = _Tp; };
233
234 // ITER_TRAITS
235 template<typename _Iter, typename _Tp = _Iter>
236 using __iter_traits = typename __iter_traits_impl<_Iter, _Tp>::type;
237
238 template<typename _Tp>
239 using __iter_diff_t = typename
240 __iter_traits<_Tp, incrementable_traits<_Tp>>::difference_type;
241 } // namespace __detail
242
243 template<typename _Tp>
244 using iter_difference_t = __detail::__iter_diff_t<remove_cvref_t<_Tp>>;
245
246 namespace __detail
247 {
248 template<typename> struct __cond_value_type { };
249
250 template<typename _Tp> requires is_object_v<_Tp>
251 struct __cond_value_type<_Tp>
252 { using value_type = remove_cv_t<_Tp>; };
253
254 template<typename _Tp>
255 concept __has_member_value_type
256 = requires { typename _Tp::value_type; };
257
258 template<typename _Tp>
259 concept __has_member_element_type
260 = requires { typename _Tp::element_type; };
261
262 } // namespace __detail
263
264 template<typename> struct indirectly_readable_traits { };
265
266 template<typename _Tp>
267 struct indirectly_readable_traits<_Tp*>
268 : __detail::__cond_value_type<_Tp>
269 { };
270
271 template<typename _Iter> requires is_array_v<_Iter>
272 struct indirectly_readable_traits<_Iter>
273 { using value_type = remove_cv_t<remove_extent_t<_Iter>>; };
274
275 template<typename _Iter>
276 struct indirectly_readable_traits<const _Iter>
277 : indirectly_readable_traits<_Iter>
278 { };
279
280 template<__detail::__has_member_value_type _Tp>
281 struct indirectly_readable_traits<_Tp>
282 : __detail::__cond_value_type<typename _Tp::value_type>
283 { };
284
285 template<__detail::__has_member_element_type _Tp>
286 struct indirectly_readable_traits<_Tp>
287 : __detail::__cond_value_type<typename _Tp::element_type>
288 { };
289
290 // _GLIBCXX_RESOLVE_LIB_DEFECTS
291 // 3446. indirectly_readable_traits ambiguity for types with both [...]
292 template<__detail::__has_member_value_type _Tp>
293 requires __detail::__has_member_element_type<_Tp>
294 && same_as<remove_cv_t<typename _Tp::element_type>,
295 remove_cv_t<typename _Tp::value_type>>
296 struct indirectly_readable_traits<_Tp>
297 : __detail::__cond_value_type<typename _Tp::value_type>
298 { };
299
300 // _GLIBCXX_RESOLVE_LIB_DEFECTS
301 // 3541. indirectly_readable_traits should be SFINAE-friendly for all types
302 template<__detail::__has_member_value_type _Tp>
303 requires __detail::__has_member_element_type<_Tp>
304 struct indirectly_readable_traits<_Tp>
305 { };
306
307 namespace __detail
308 {
309 template<typename _Tp>
310 using __iter_value_t = typename
311 __iter_traits<_Tp, indirectly_readable_traits<_Tp>>::value_type;
312 } // namespace __detail
313
314 template<typename _Tp>
315 using iter_value_t = __detail::__iter_value_t<remove_cvref_t<_Tp>>;
316
317 namespace __detail
318 {
319 // _GLIBCXX_RESOLVE_LIB_DEFECTS
320 // 3420. cpp17-iterator should check [type] looks like an iterator first
321 template<typename _Iter>
322 concept __cpp17_iterator = requires(_Iter __it)
323 {
324 { *__it } -> __can_reference;
325 { ++__it } -> same_as<_Iter&>;
326 { *__it++ } -> __can_reference;
327 } && copyable<_Iter>;
328
329 template<typename _Iter>
330 concept __cpp17_input_iterator = __cpp17_iterator<_Iter>
331 && equality_comparable<_Iter>
332 && requires(_Iter __it)
333 {
334 typename incrementable_traits<_Iter>::difference_type;
335 typename indirectly_readable_traits<_Iter>::value_type;
337 typename indirectly_readable_traits<_Iter>::value_type&>;
338 typename common_reference_t<decltype(*__it++)&&,
339 typename indirectly_readable_traits<_Iter>::value_type&>;
340 requires signed_integral<
341 typename incrementable_traits<_Iter>::difference_type>;
342 };
343
344 // _GLIBCXX_RESOLVE_LIB_DEFECTS
345 // 3798. Rvalue reference and iterator_category
346 template<typename _Iter>
347 concept __cpp17_fwd_iterator = __cpp17_input_iterator<_Iter>
348 && constructible_from<_Iter>
349 && is_reference_v<iter_reference_t<_Iter>>
350 && same_as<remove_cvref_t<iter_reference_t<_Iter>>,
351 typename indirectly_readable_traits<_Iter>::value_type>
352 && requires(_Iter __it)
353 {
354 { __it++ } -> convertible_to<const _Iter&>;
355 { *__it++ } -> same_as<iter_reference_t<_Iter>>;
356 };
357
358 template<typename _Iter>
359 concept __cpp17_bidi_iterator = __cpp17_fwd_iterator<_Iter>
360 && requires(_Iter __it)
361 {
362 { --__it } -> same_as<_Iter&>;
363 { __it-- } -> convertible_to<const _Iter&>;
364 { *__it-- } -> same_as<iter_reference_t<_Iter>>;
365 };
366
367 template<typename _Iter>
368 concept __cpp17_randacc_iterator = __cpp17_bidi_iterator<_Iter>
369 && totally_ordered<_Iter>
370 && requires(_Iter __it,
371 typename incrementable_traits<_Iter>::difference_type __n)
372 {
373 { __it += __n } -> same_as<_Iter&>;
374 { __it -= __n } -> same_as<_Iter&>;
375 { __it + __n } -> same_as<_Iter>;
376 { __n + __it } -> same_as<_Iter>;
377 { __it - __n } -> same_as<_Iter>;
378 { __it - __it } -> same_as<decltype(__n)>;
379 { __it[__n] } -> convertible_to<iter_reference_t<_Iter>>;
380 };
381
382 template<typename _Iter>
383 concept __iter_with_nested_types = requires {
384 typename _Iter::iterator_category;
385 typename _Iter::value_type;
386 typename _Iter::difference_type;
387 typename _Iter::reference;
388 };
389
390 template<typename _Iter>
391 concept __iter_without_nested_types = !__iter_with_nested_types<_Iter>;
392
393 template<typename _Iter>
394 concept __iter_without_category
395 = !requires { typename _Iter::iterator_category; };
396
397 } // namespace __detail
398
399 template<typename _Iterator>
400 requires __detail::__iter_with_nested_types<_Iterator>
401 struct __iterator_traits<_Iterator, void>
402 {
403 private:
404 template<typename _Iter>
405 struct __ptr
406 { using type = void; };
407
408 template<typename _Iter> requires requires { typename _Iter::pointer; }
409 struct __ptr<_Iter>
410 { using type = typename _Iter::pointer; };
411
412 public:
413 using iterator_category = typename _Iterator::iterator_category;
414 using value_type = typename _Iterator::value_type;
415 using difference_type = typename _Iterator::difference_type;
416 using pointer = typename __ptr<_Iterator>::type;
417 using reference = typename _Iterator::reference;
418 };
419
420 template<typename _Iterator>
421 requires __detail::__iter_without_nested_types<_Iterator>
422 && __detail::__cpp17_input_iterator<_Iterator>
423 struct __iterator_traits<_Iterator, void>
424 {
425 private:
426 template<typename _Iter>
427 struct __cat
428 { using type = input_iterator_tag; };
429
430 template<typename _Iter>
431 requires requires { typename _Iter::iterator_category; }
432 struct __cat<_Iter>
433 { using type = typename _Iter::iterator_category; };
434
435 template<typename _Iter>
436 requires __detail::__iter_without_category<_Iter>
437 && __detail::__cpp17_randacc_iterator<_Iter>
438 struct __cat<_Iter>
439 { using type = random_access_iterator_tag; };
440
441 template<typename _Iter>
442 requires __detail::__iter_without_category<_Iter>
443 && __detail::__cpp17_bidi_iterator<_Iter>
444 struct __cat<_Iter>
445 { using type = bidirectional_iterator_tag; };
446
447 template<typename _Iter>
448 requires __detail::__iter_without_category<_Iter>
449 && __detail::__cpp17_fwd_iterator<_Iter>
450 struct __cat<_Iter>
451 { using type = forward_iterator_tag; };
452
453 template<typename _Iter>
454 struct __ptr
455 { using type = void; };
456
457 template<typename _Iter> requires requires { typename _Iter::pointer; }
458 struct __ptr<_Iter>
459 { using type = typename _Iter::pointer; };
460
461 template<typename _Iter>
462 requires (!requires { typename _Iter::pointer; }
463 && requires(_Iter& __it) { __it.operator->(); })
464 struct __ptr<_Iter>
465 { using type = decltype(std::declval<_Iter&>().operator->()); };
466
467 template<typename _Iter>
468 struct __ref
469 { using type = iter_reference_t<_Iter>; };
470
471 template<typename _Iter> requires requires { typename _Iter::reference; }
472 struct __ref<_Iter>
473 { using type = typename _Iter::reference; };
474
475 public:
476 using iterator_category = typename __cat<_Iterator>::type;
477 using value_type
478 = typename indirectly_readable_traits<_Iterator>::value_type;
479 using difference_type
480 = typename incrementable_traits<_Iterator>::difference_type;
481 using pointer = typename __ptr<_Iterator>::type;
482 using reference = typename __ref<_Iterator>::type;
483 };
484
485 template<typename _Iterator>
486 requires __detail::__iter_without_nested_types<_Iterator>
487 && __detail::__cpp17_iterator<_Iterator>
488 struct __iterator_traits<_Iterator, void>
489 {
490 private:
491 template<typename _Iter>
492 struct __diff
493 { using type = void; };
494
495 template<typename _Iter>
496 requires requires
497 { typename incrementable_traits<_Iter>::difference_type; }
498 struct __diff<_Iter>
499 {
500 using type = typename incrementable_traits<_Iter>::difference_type;
501 };
502
503 public:
504 using iterator_category = output_iterator_tag;
505 using value_type = void;
506 using difference_type = typename __diff<_Iterator>::type;
507 using pointer = void;
508 using reference = void;
509 };
510
511 namespace __detail
512 {
513 template<typename _Iter>
514 struct __iter_concept_impl;
515
516 // ITER_CONCEPT(I) is ITER_TRAITS(I)::iterator_concept if that is valid.
517 template<typename _Iter>
518 requires requires { typename __iter_traits<_Iter>::iterator_concept; }
519 struct __iter_concept_impl<_Iter>
520 { using type = typename __iter_traits<_Iter>::iterator_concept; };
521
522 // Otherwise, ITER_TRAITS(I)::iterator_category if that is valid.
523 template<typename _Iter>
524 requires (!requires { typename __iter_traits<_Iter>::iterator_concept; }
525 && requires { typename __iter_traits<_Iter>::iterator_category; })
526 struct __iter_concept_impl<_Iter>
527 { using type = typename __iter_traits<_Iter>::iterator_category; };
528
529 // Otherwise, random_access_tag if iterator_traits<I> is not specialized.
530 template<typename _Iter>
531 requires (!requires { typename __iter_traits<_Iter>::iterator_concept; }
532 && !requires { typename __iter_traits<_Iter>::iterator_category; }
533 && __primary_traits_iter<_Iter>)
534 struct __iter_concept_impl<_Iter>
535 { using type = random_access_iterator_tag; };
536
537 // Otherwise, there is no ITER_CONCEPT(I) type.
538 template<typename _Iter>
539 struct __iter_concept_impl
540 { };
541
542 // ITER_CONCEPT
543 template<typename _Iter>
544 using __iter_concept = typename __iter_concept_impl<_Iter>::type;
545
546 template<typename _In>
547 concept __indirectly_readable_impl = requires
548 {
549 typename iter_value_t<_In>;
550 typename iter_reference_t<_In>;
551 typename iter_rvalue_reference_t<_In>;
552 requires same_as<iter_reference_t<const _In>,
553 iter_reference_t<_In>>;
554 requires same_as<iter_rvalue_reference_t<const _In>,
555 iter_rvalue_reference_t<_In>>;
556 }
557 && common_reference_with<iter_reference_t<_In>&&, iter_value_t<_In>&>
558 && common_reference_with<iter_reference_t<_In>&&,
559 iter_rvalue_reference_t<_In>&&>
560 && common_reference_with<iter_rvalue_reference_t<_In>&&,
561 const iter_value_t<_In>&>;
562
563 } // namespace __detail
564
565 /// Requirements for types that are readable by applying operator*.
566 template<typename _In>
567 concept indirectly_readable
568 = __detail::__indirectly_readable_impl<remove_cvref_t<_In>>;
569
570 namespace __detail
571 {
572 template<typename _Tp>
573 struct __indirect_value
574 { using type = iter_value_t<_Tp>&; };
575
576 // __indirect_value<projected<_Iter, _Proj>> is defined later.
577 } // namespace __detail
578
579 template<typename _Tp>
580 using __indirect_value_t = typename __detail::__indirect_value<_Tp>::type;
581
582 template<indirectly_readable _Tp>
583 using iter_common_reference_t
584 = common_reference_t<iter_reference_t<_Tp>, __indirect_value_t<_Tp>>;
585
586 /// Requirements for writing a value into an iterator's referenced object.
587 template<typename _Out, typename _Tp>
588 concept indirectly_writable = requires(_Out&& __o, _Tp&& __t)
589 {
590 *__o = std::forward<_Tp>(__t);
592 const_cast<const iter_reference_t<_Out>&&>(*__o)
593 = std::forward<_Tp>(__t);
594 const_cast<const iter_reference_t<_Out>&&>(*std::forward<_Out>(__o))
595 = std::forward<_Tp>(__t);
596 };
597
598 namespace ranges::__detail
599 {
600 class __max_diff_type;
601 class __max_size_type;
602
603 template<typename _Tp>
604 concept __cv_bool = same_as<const volatile _Tp, const volatile bool>;
605
606 template<typename _Tp>
607 concept __integral_nonbool = integral<_Tp> && !__cv_bool<_Tp>;
608
609 template<typename _Tp>
610 concept __is_integer_like = __integral_nonbool<_Tp>
611 || same_as<_Tp, __max_diff_type> || same_as<_Tp, __max_size_type>;
612
613 template<typename _Tp>
614 concept __is_signed_integer_like = signed_integral<_Tp>
615 || same_as<_Tp, __max_diff_type>;
616
617 } // namespace ranges::__detail
618
619 namespace __detail { using ranges::__detail::__is_signed_integer_like; }
620
621 /// Requirements on types that can be incremented with ++.
622 template<typename _Iter>
623 concept weakly_incrementable = movable<_Iter>
624 && requires(_Iter __i)
625 {
626 typename iter_difference_t<_Iter>;
627 requires __detail::__is_signed_integer_like<iter_difference_t<_Iter>>;
628 { ++__i } -> same_as<_Iter&>;
629 __i++;
630 };
631
632 template<typename _Iter>
633 concept incrementable = regular<_Iter> && weakly_incrementable<_Iter>
634 && requires(_Iter __i) { { __i++ } -> same_as<_Iter>; };
635
636 template<typename _Iter>
637 concept input_or_output_iterator
638 = requires(_Iter __i) { { *__i } -> __detail::__can_reference; }
639 && weakly_incrementable<_Iter>;
640
641 template<typename _Sent, typename _Iter>
642 concept sentinel_for = semiregular<_Sent>
643 && input_or_output_iterator<_Iter>
644 && __detail::__weakly_eq_cmp_with<_Sent, _Iter>;
645
646 template<typename _Sent, typename _Iter>
647 inline constexpr bool disable_sized_sentinel_for = false;
648
649 template<typename _Sent, typename _Iter>
650 concept sized_sentinel_for = sentinel_for<_Sent, _Iter>
651 && !disable_sized_sentinel_for<remove_cv_t<_Sent>, remove_cv_t<_Iter>>
652 && requires(const _Iter& __i, const _Sent& __s)
653 {
654 { __s - __i } -> same_as<iter_difference_t<_Iter>>;
655 { __i - __s } -> same_as<iter_difference_t<_Iter>>;
656 };
657
658 template<typename _Iter>
659 concept input_iterator = input_or_output_iterator<_Iter>
660 && indirectly_readable<_Iter>
661 && requires { typename __detail::__iter_concept<_Iter>; }
662 && derived_from<__detail::__iter_concept<_Iter>, input_iterator_tag>;
663
664 template<typename _Iter, typename _Tp>
665 concept output_iterator = input_or_output_iterator<_Iter>
666 && indirectly_writable<_Iter, _Tp>
667 && requires(_Iter __i, _Tp&& __t) { *__i++ = std::forward<_Tp>(__t); };
668
669 template<typename _Iter>
670 concept forward_iterator = input_iterator<_Iter>
671 && derived_from<__detail::__iter_concept<_Iter>, forward_iterator_tag>
672 && incrementable<_Iter> && sentinel_for<_Iter, _Iter>;
673
674 template<typename _Iter>
675 concept bidirectional_iterator = forward_iterator<_Iter>
676 && derived_from<__detail::__iter_concept<_Iter>,
678 && requires(_Iter __i)
679 {
680 { --__i } -> same_as<_Iter&>;
681 { __i-- } -> same_as<_Iter>;
682 };
683
684 template<typename _Iter>
685 concept random_access_iterator = bidirectional_iterator<_Iter>
686 && derived_from<__detail::__iter_concept<_Iter>,
688 && totally_ordered<_Iter> && sized_sentinel_for<_Iter, _Iter>
689 && requires(_Iter __i, const _Iter __j,
690 const iter_difference_t<_Iter> __n)
691 {
692 { __i += __n } -> same_as<_Iter&>;
693 { __j + __n } -> same_as<_Iter>;
694 { __n + __j } -> same_as<_Iter>;
695 { __i -= __n } -> same_as<_Iter&>;
696 { __j - __n } -> same_as<_Iter>;
697 { __j[__n] } -> same_as<iter_reference_t<_Iter>>;
698 };
699
700 template<typename _Iter>
701 concept contiguous_iterator = random_access_iterator<_Iter>
702 && derived_from<__detail::__iter_concept<_Iter>, contiguous_iterator_tag>
703 && is_lvalue_reference_v<iter_reference_t<_Iter>>
704 && same_as<iter_value_t<_Iter>, remove_cvref_t<iter_reference_t<_Iter>>>
705 && requires(const _Iter& __i)
706 {
707 { std::to_address(__i) }
708 -> same_as<add_pointer_t<iter_reference_t<_Iter>>>;
709 };
710
711 // [indirectcallable], indirect callable requirements
712
713 // [indirectcallable.indirectinvocable], indirect callables
714
715 template<typename _Fn, typename _Iter>
716 concept indirectly_unary_invocable = indirectly_readable<_Iter>
717 && copy_constructible<_Fn> && invocable<_Fn&, __indirect_value_t<_Iter>>
718 && invocable<_Fn&, iter_reference_t<_Iter>>
719 && common_reference_with<invoke_result_t<_Fn&, __indirect_value_t<_Iter>>,
720 invoke_result_t<_Fn&, iter_reference_t<_Iter>>>;
721
722 template<typename _Fn, typename _Iter>
723 concept indirectly_regular_unary_invocable = indirectly_readable<_Iter>
724 && copy_constructible<_Fn>
725 && regular_invocable<_Fn&, __indirect_value_t<_Iter>>
726 && regular_invocable<_Fn&, iter_reference_t<_Iter>>
727 && common_reference_with<invoke_result_t<_Fn&, __indirect_value_t<_Iter>>,
728 invoke_result_t<_Fn&, iter_reference_t<_Iter>>>;
729
730 template<typename _Fn, typename _Iter>
731 concept indirect_unary_predicate = indirectly_readable<_Iter>
732 && copy_constructible<_Fn> && predicate<_Fn&, __indirect_value_t<_Iter>>
733 && predicate<_Fn&, iter_reference_t<_Iter>>;
734
735 template<typename _Fn, typename _I1, typename _I2>
736 concept indirect_binary_predicate
737 = indirectly_readable<_I1> && indirectly_readable<_I2>
738 && copy_constructible<_Fn>
739 && predicate<_Fn&, __indirect_value_t<_I1>, __indirect_value_t<_I2>>
740 && predicate<_Fn&, __indirect_value_t<_I1>, iter_reference_t<_I2>>
741 && predicate<_Fn&, iter_reference_t<_I1>, __indirect_value_t<_I2>>
742 && predicate<_Fn&, iter_reference_t<_I1>, iter_reference_t<_I2>>;
743
744 template<typename _Fn, typename _I1, typename _I2 = _I1>
745 concept indirect_equivalence_relation
746 = indirectly_readable<_I1> && indirectly_readable<_I2>
747 && copy_constructible<_Fn>
748 && equivalence_relation<_Fn&, __indirect_value_t<_I1>, __indirect_value_t<_I2>>
749 && equivalence_relation<_Fn&, __indirect_value_t<_I1>, iter_reference_t<_I2>>
750 && equivalence_relation<_Fn&, iter_reference_t<_I1>, __indirect_value_t<_I2>>
751 && equivalence_relation<_Fn&, iter_reference_t<_I1>,
752 iter_reference_t<_I2>>;
753
754 template<typename _Fn, typename _I1, typename _I2 = _I1>
755 concept indirect_strict_weak_order
756 = indirectly_readable<_I1> && indirectly_readable<_I2>
757 && copy_constructible<_Fn>
758 && strict_weak_order<_Fn&, __indirect_value_t<_I1>, __indirect_value_t<_I2>>
759 && strict_weak_order<_Fn&, __indirect_value_t<_I1>, iter_reference_t<_I2>>
760 && strict_weak_order<_Fn&, iter_reference_t<_I1>, __indirect_value_t<_I2>>
761 && strict_weak_order<_Fn&, iter_reference_t<_I1>, iter_reference_t<_I2>>;
762
763 template<typename _Fn, typename... _Is>
764 requires (indirectly_readable<_Is> && ...)
765 && invocable<_Fn, iter_reference_t<_Is>...>
766 using indirect_result_t = invoke_result_t<_Fn, iter_reference_t<_Is>...>;
767
768 namespace __detail
769 {
770 template<typename _Iter, typename _Proj>
771 struct __projected
772 {
773 struct __type
774 {
775 using value_type = remove_cvref_t<indirect_result_t<_Proj&, _Iter>>;
776 indirect_result_t<_Proj&, _Iter> operator*() const; // not defined
777
778 // These are used to identify and obtain the template arguments of a
779 // specialization of the 'projected' alias template below.
780 using __projected_Iter = _Iter;
781 using __projected_Proj = _Proj;
782 };
783 };
784
785 template<weakly_incrementable _Iter, typename _Proj>
786 struct __projected<_Iter, _Proj>
787 {
788 struct __type
789 {
790 using value_type = remove_cvref_t<indirect_result_t<_Proj&, _Iter>>;
791 using difference_type = iter_difference_t<_Iter>;
792 indirect_result_t<_Proj&, _Iter> operator*() const; // not defined
793
794 using __projected_Iter = _Iter;
795 using __projected_Proj = _Proj;
796 };
797 };
798 } // namespace __detail
799
800 /// [projected], projected
801 template<indirectly_readable _Iter,
802 indirectly_regular_unary_invocable<_Iter> _Proj>
803 using projected = typename __detail::__projected<_Iter, _Proj>::__type;
804
805 // Matches specializations of the 'projected' alias template.
806 template<typename _Tp>
807 requires same_as<_Tp, projected<typename _Tp::__projected_Iter,
808 typename _Tp::__projected_Proj>>
809 struct __detail::__indirect_value<_Tp>
810 {
811 using _Iter = typename _Tp::__projected_Iter;
812 using _Proj = typename _Tp::__projected_Proj;
813 using type = invoke_result_t<_Proj&, __indirect_value_t<_Iter>>;
814 };
815
816#if __glibcxx_algorithm_default_value_type // C++ >= 26
817 template<indirectly_readable _Iter,
818 indirectly_regular_unary_invocable<_Iter> _Proj>
819 using projected_value_t
820 = remove_cvref_t<invoke_result_t<_Proj&, iter_value_t<_Iter>&>>;
821#endif
822
823 // [alg.req], common algorithm requirements
824
825 /// [alg.req.ind.move], concept `indirectly_movable`
826
827 template<typename _In, typename _Out>
828 concept indirectly_movable = indirectly_readable<_In>
829 && indirectly_writable<_Out, iter_rvalue_reference_t<_In>>;
830
831 template<typename _In, typename _Out>
832 concept indirectly_movable_storable = indirectly_movable<_In, _Out>
833 && indirectly_writable<_Out, iter_value_t<_In>>
834 && movable<iter_value_t<_In>>
835 && constructible_from<iter_value_t<_In>, iter_rvalue_reference_t<_In>>
836 && assignable_from<iter_value_t<_In>&, iter_rvalue_reference_t<_In>>;
837
838 /// [alg.req.ind.copy], concept `indirectly_copyable`
839 template<typename _In, typename _Out>
840 concept indirectly_copyable = indirectly_readable<_In>
841 && indirectly_writable<_Out, iter_reference_t<_In>>;
842
843 template<typename _In, typename _Out>
844 concept indirectly_copyable_storable = indirectly_copyable<_In, _Out>
845 && indirectly_writable<_Out, iter_value_t<_In>&>
846 && indirectly_writable<_Out, const iter_value_t<_In>&>
847 && indirectly_writable<_Out, iter_value_t<_In>&&>
848 && indirectly_writable<_Out, const iter_value_t<_In>&&>
849 && copyable<iter_value_t<_In>>
850 && constructible_from<iter_value_t<_In>, iter_reference_t<_In>>
851 && assignable_from<iter_value_t<_In>&, iter_reference_t<_In>>;
852
853namespace ranges
854{
855 /// @cond undocumented
856 // Implementation of std::ranges::iter_swap, [iterator.cust.swap].
857 namespace __iswap
858 {
859 template<typename _It1, typename _It2>
860 void iter_swap(_It1, _It2) = delete;
861
862 // Satisfied if _Tp and _Up are class or enumeration types and iter_swap
863 // can be found by argument-dependent lookup.
864 template<typename _Tp, typename _Up>
865 concept __adl_iswap
866 = (std::__detail::__class_or_enum<remove_reference_t<_Tp>>
867 || std::__detail::__class_or_enum<remove_reference_t<_Up>>)
868 && requires(_Tp&& __t, _Up&& __u) {
869 iter_swap(static_cast<_Tp&&>(__t), static_cast<_Up&&>(__u));
870 };
871
872 template<typename _Xp, typename _Yp>
873 constexpr iter_value_t<_Xp>
874 __iter_exchange_move(_Xp&& __x, _Yp&& __y)
875 noexcept(noexcept(iter_value_t<_Xp>(iter_move(__x)))
876 && noexcept(*__x = iter_move(__y)))
877 {
878 iter_value_t<_Xp> __old_value(iter_move(__x));
879 *__x = iter_move(__y);
880 return __old_value;
881 }
882
883 struct _IterSwap
884 {
885 private:
886 template<typename _Tp, typename _Up>
887 static constexpr bool
888 _S_noexcept()
889 {
890 if constexpr (__adl_iswap<_Tp, _Up>)
891 return noexcept(iter_swap(std::declval<_Tp>(),
893 else if constexpr (indirectly_readable<_Tp>
894 && indirectly_readable<_Up>
895 && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
896 return noexcept(ranges::swap(*std::declval<_Tp>(),
898 else
899 return noexcept(*std::declval<_Tp>()
900 = __iswap::__iter_exchange_move(std::declval<_Up>(),
902 }
903
904 public:
905 template<typename _Tp, typename _Up>
906 requires __adl_iswap<_Tp, _Up>
907 || (indirectly_readable<remove_reference_t<_Tp>>
908 && indirectly_readable<remove_reference_t<_Up>>
909 && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
910 || (indirectly_movable_storable<_Tp, _Up>
911 && indirectly_movable_storable<_Up, _Tp>)
912 constexpr void
913 operator()(_Tp&& __e1, _Up&& __e2) const
914 noexcept(_S_noexcept<_Tp, _Up>())
915 {
916 if constexpr (__adl_iswap<_Tp, _Up>)
917 iter_swap(static_cast<_Tp&&>(__e1), static_cast<_Up&&>(__e2));
918 else if constexpr (indirectly_readable<_Tp>
919 && indirectly_readable<_Up>
920 && swappable_with<iter_reference_t<_Tp>, iter_reference_t<_Up>>)
921 ranges::swap(*__e1, *__e2);
922 else
923 *__e1 = __iswap::__iter_exchange_move(__e2, __e1);
924 }
925 };
926 } // namespace __iswap
927 /// @endcond
928
929 inline namespace _Cpo {
930 inline constexpr __iswap::_IterSwap iter_swap{};
931 }
932
933} // namespace ranges
934
935 /// [alg.req.ind.swap], concept `indirectly_swappable`
936 template<typename _I1, typename _I2 = _I1>
937 concept indirectly_swappable
938 = indirectly_readable<_I1> && indirectly_readable<_I2>
939 && requires(const _I1 __i1, const _I2 __i2)
940 {
941 ranges::iter_swap(__i1, __i1);
942 ranges::iter_swap(__i2, __i2);
943 ranges::iter_swap(__i1, __i2);
944 ranges::iter_swap(__i2, __i1);
945 };
946
947 /// [alg.req.ind.cmp], concept `indirectly_comparable`
948 template<typename _I1, typename _I2, typename _Rel, typename _P1 = identity,
949 typename _P2 = identity>
950 concept indirectly_comparable
951 = indirect_binary_predicate<_Rel, projected<_I1, _P1>,
952 projected<_I2, _P2>>;
953
954 /// [alg.req.permutable], concept `permutable`
955 template<typename _Iter>
956 concept permutable = forward_iterator<_Iter>
957 && indirectly_movable_storable<_Iter, _Iter>
958 && indirectly_swappable<_Iter, _Iter>;
959
960 /// [alg.req.mergeable], concept `mergeable`
961 template<typename _I1, typename _I2, typename _Out,
962 typename _Rel = ranges::less, typename _P1 = identity,
963 typename _P2 = identity>
964 concept mergeable = input_iterator<_I1> && input_iterator<_I2>
965 && weakly_incrementable<_Out> && indirectly_copyable<_I1, _Out>
966 && indirectly_copyable<_I2, _Out>
967 && indirect_strict_weak_order<_Rel, projected<_I1, _P1>,
968 projected<_I2, _P2>>;
969
970 /// [alg.req.sortable], concept `sortable`
971 template<typename _Iter, typename _Rel = ranges::less,
972 typename _Proj = identity>
973 concept sortable = permutable<_Iter>
974 && indirect_strict_weak_order<_Rel, projected<_Iter, _Proj>>;
975
976 struct unreachable_sentinel_t
977 {
978 template<weakly_incrementable _It>
979 friend constexpr bool
980 operator==(unreachable_sentinel_t, const _It&) noexcept
981 { return false; }
982 };
983
984 inline constexpr unreachable_sentinel_t unreachable_sentinel{};
985
986 // This is the namespace for [range.access] CPOs.
987 namespace ranges::__access
988 {
989 using std::__detail::__class_or_enum;
990
991 template<typename _Tp>
992 concept __member_begin = requires(_Tp& __t)
993 {
994 { _GLIBCXX_AUTO_CAST(__t.begin()) } -> input_or_output_iterator;
995 };
996
997 // Poison pill so that unqualified lookup doesn't find std::begin.
998 void begin() = delete;
999
1000 template<typename _Tp>
1001 concept __adl_begin = __class_or_enum<remove_reference_t<_Tp>>
1002 && requires(_Tp& __t)
1003 {
1004 { _GLIBCXX_AUTO_CAST(begin(__t)) } -> input_or_output_iterator;
1005 };
1006
1007 // Simplified version of std::ranges::begin that only supports lvalues,
1008 // for use by __range_iter_t below.
1009 template<typename _Tp>
1010 requires is_array_v<_Tp> || __member_begin<_Tp&> || __adl_begin<_Tp&>
1011 auto
1012 __begin(_Tp& __t)
1013 {
1014 if constexpr (is_array_v<_Tp>)
1015 return __t + 0;
1016 else if constexpr (__member_begin<_Tp&>)
1017 return __t.begin();
1018 else
1019 return begin(__t);
1020 }
1021 } // namespace ranges::__access
1022
1023 namespace __detail
1024 {
1025 // Implementation of std::ranges::iterator_t, without using ranges::begin.
1026 template<typename _Tp>
1027 using __range_iter_t
1028 = decltype(ranges::__access::__begin(std::declval<_Tp&>()));
1029
1030 } // namespace __detail
1031
1032#endif // C++20 library concepts
1033_GLIBCXX_END_NAMESPACE_VERSION
1034} // namespace std
1035#pragma GCC diagnostic pop
1036#endif // C++20
1037#endif // _ITERATOR_CONCEPTS_H
constexpr complex< _Tp > operator*(const complex< _Tp > &__x, const complex< _Tp > &__y)
Return new complex value x times y.
Definition complex:434
constexpr _Tp * to_address(_Tp *__ptr) noexcept
Obtain address referenced by a pointer to an object.
Definition ptr_traits.h:232
typename common_reference< _Tp... >::type common_reference_t
Definition type_traits:4195
typename make_signed< _Tp >::type make_signed_t
Alias template for make_signed.
Definition type_traits:2198
auto declval() noexcept -> decltype(__declval< _Tp >(0))
Definition type_traits:2670
constexpr std::remove_reference< _Tp >::type && move(_Tp &&__t) noexcept
Convert a value to an rvalue.
Definition move.h:138
constexpr _Tp && forward(typename std::remove_reference< _Tp >::type &__t) noexcept
Forward an lvalue.
Definition move.h:72
_Tp * begin(valarray< _Tp > &__va) noexcept
Return an iterator pointing to the first element of the valarray.
Definition valarray:1229
ISO C++ entities toplevel namespace is std.
constexpr default_sentinel_t default_sentinel
A default sentinel value.
Implementation details not part of the namespace std interface.
[func.identity] The identity function.
Definition ranges_cmp.h:48
ranges::less function object type.
Definition ranges_cmp.h:110
Marking input iterators.
Forward iterators support a superset of input iterator operations.
Bidirectional iterators support a superset of forward iterator operations.
Random-access iterators support a superset of bidirectional iterator operations.
Contiguous iterators point to objects stored contiguously in memory.