libstdc++
ranges_base.h
Go to the documentation of this file.
1// Core concepts and definitions for <ranges> -*- 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/ranges_base.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{ranges}
28 */
29
30#ifndef _GLIBCXX_RANGES_BASE_H
31#define _GLIBCXX_RANGES_BASE_H 1
32
33#ifdef _GLIBCXX_SYSHDR
34#pragma GCC system_header
35#endif
36
37#if __cplusplus > 201703L
38#include <initializer_list>
39#include <bits/stl_iterator.h>
40#include <ext/numeric_traits.h>
41#include <bits/max_size_type.h>
42#include <bits/version.h>
43
44#if __glibcxx_containers_ranges // C++ >= 23
45# include <bits/utility.h> // for tuple_element_t
46#endif
47
48#pragma GCC diagnostic push
49#pragma GCC diagnostic ignored "-Wpedantic" // __int128
50
51#if __glibcxx_algorithm_default_value_type // C++ >= 26
52# define _GLIBCXX26_RANGE_ALGO_DEF_VAL_T(_I, _P) = projected_value_t<_I, _P>
53#else
54# define _GLIBCXX26_RANGE_ALGO_DEF_VAL_T(_I, _P)
55#endif
56
57#ifdef __cpp_lib_concepts
58namespace std _GLIBCXX_VISIBILITY(default)
59{
60_GLIBCXX_BEGIN_NAMESPACE_VERSION
61namespace ranges
62{
63 template<typename>
64 inline constexpr bool disable_sized_range = false;
65
66 template<typename _Tp>
67 inline constexpr bool enable_borrowed_range = false;
68
69 namespace __detail
70 {
71 [[__gnu__::__always_inline__]]
72 constexpr __max_size_type
73 __to_unsigned_like(__max_size_type __t) noexcept
74 { return __t; }
75
76 [[__gnu__::__always_inline__]]
77 constexpr __max_size_type
78 __to_unsigned_like(__max_diff_type __t) noexcept
79 { return __max_size_type(__t); }
80
81 template<integral _Tp>
82 [[__gnu__::__always_inline__]]
83 constexpr auto
84 __to_unsigned_like(_Tp __t) noexcept
85 { return static_cast<make_unsigned_t<_Tp>>(__t); }
86
87 template<typename _Tp>
88 using __make_unsigned_like_t
89 = decltype(__detail::__to_unsigned_like(std::declval<_Tp>()));
90
91 // Part of the constraints of ranges::borrowed_range
92 template<typename _Tp>
93 concept __maybe_borrowed_range
94 = is_lvalue_reference_v<_Tp>
95 || enable_borrowed_range<remove_cvref_t<_Tp>>;
96
97 } // namespace __detail
98
99 // Namespace for helpers for the <ranges> customization points.
100 namespace __access
101 {
102 using std::ranges::__detail::__maybe_borrowed_range;
103 using std::__detail::__range_iter_t;
104
105 struct _Begin
106 {
107 private:
108 template<typename _Tp>
109 static consteval bool
110 _S_noexcept()
111 {
112 if constexpr (is_array_v<remove_reference_t<_Tp>>)
113 return true;
114 else if constexpr (__member_begin<_Tp>)
115 return noexcept(_GLIBCXX_AUTO_CAST(std::declval<_Tp&>().begin()));
116 else
117 return noexcept(_GLIBCXX_AUTO_CAST(begin(std::declval<_Tp&>())));
118 }
119
120 public:
121 template<__maybe_borrowed_range _Tp>
122 requires is_array_v<remove_reference_t<_Tp>> || __member_begin<_Tp>
123 || __adl_begin<_Tp>
124 [[nodiscard, __gnu__::__always_inline__]]
125 constexpr auto
126 operator()(_Tp&& __t) const noexcept(_S_noexcept<_Tp&>())
127 {
128 if constexpr (is_array_v<remove_reference_t<_Tp>>)
129 {
130 static_assert(is_lvalue_reference_v<_Tp>);
131 return __t + 0;
132 }
133 else if constexpr (__member_begin<_Tp>)
134 return __t.begin();
135 else
136 return begin(__t);
137 }
138 };
139
140 template<typename _Tp>
141 concept __member_end = requires(_Tp& __t)
142 {
143 { _GLIBCXX_AUTO_CAST(__t.end()) } -> sentinel_for<__range_iter_t<_Tp>>;
144 };
145
146 // Poison pill so that unqualified lookup doesn't find std::end.
147 void end() = delete;
148
149 template<typename _Tp>
150 concept __adl_end = __class_or_enum<remove_reference_t<_Tp>>
151 && requires(_Tp& __t)
152 {
153 { _GLIBCXX_AUTO_CAST(end(__t)) } -> sentinel_for<__range_iter_t<_Tp>>;
154 };
155
156 struct _End
157 {
158 private:
159 template<typename _Tp>
160 static consteval bool
161 _S_noexcept()
162 {
163 if constexpr (is_bounded_array_v<remove_reference_t<_Tp>>)
164 return true;
165 else if constexpr (__member_end<_Tp>)
166 return noexcept(_GLIBCXX_AUTO_CAST(std::declval<_Tp&>().end()));
167 else
168 return noexcept(_GLIBCXX_AUTO_CAST(end(std::declval<_Tp&>())));
169 }
170
171 public:
172 template<__maybe_borrowed_range _Tp>
173 requires is_bounded_array_v<remove_reference_t<_Tp>>
174 || __member_end<_Tp> || __adl_end<_Tp>
175 [[nodiscard, __gnu__::__always_inline__]]
176 constexpr auto
177 operator()(_Tp&& __t) const noexcept(_S_noexcept<_Tp&>())
178 {
179 if constexpr (is_bounded_array_v<remove_reference_t<_Tp>>)
180 {
181 static_assert(is_lvalue_reference_v<_Tp>);
182 return __t + extent_v<remove_reference_t<_Tp>>;
183 }
184 else if constexpr (__member_end<_Tp>)
185 return __t.end();
186 else
187 return end(__t);
188 }
189 };
190
191 template<typename _Tp>
192 concept __member_rbegin = requires(_Tp& __t)
193 {
194 { _GLIBCXX_AUTO_CAST(__t.rbegin()) } -> input_or_output_iterator;
195 };
196
197 void rbegin() = delete;
198
199 template<typename _Tp>
200 concept __adl_rbegin = __class_or_enum<remove_reference_t<_Tp>>
201 && requires(_Tp& __t)
202 {
203 { _GLIBCXX_AUTO_CAST(rbegin(__t)) } -> input_or_output_iterator;
204 };
205
206 template<typename _Tp>
207 concept __reversable = requires(_Tp& __t)
208 {
209 { _Begin{}(__t) } -> bidirectional_iterator;
210 { _End{}(__t) } -> same_as<decltype(_Begin{}(__t))>;
211 };
212
213 struct _RBegin
214 {
215 private:
216 template<typename _Tp>
217 static consteval bool
218 _S_noexcept()
219 {
220 if constexpr (__member_rbegin<_Tp>)
221 return noexcept(_GLIBCXX_AUTO_CAST(std::declval<_Tp&>().rbegin()));
222 else if constexpr (__adl_rbegin<_Tp>)
223 return noexcept(_GLIBCXX_AUTO_CAST(rbegin(std::declval<_Tp&>())));
224 else
225 {
226 if constexpr (noexcept(_End{}(std::declval<_Tp&>())))
227 {
228 using _It = decltype(_End{}(std::declval<_Tp&>()));
229 // std::reverse_iterator copy-initializes its member.
230 return is_nothrow_copy_constructible_v<_It>;
231 }
232 else
233 return false;
234 }
235 }
236
237 public:
238 template<__maybe_borrowed_range _Tp>
239 requires __member_rbegin<_Tp> || __adl_rbegin<_Tp> || __reversable<_Tp>
240 [[nodiscard, __gnu__::__always_inline__]]
241 constexpr auto
242 operator()(_Tp&& __t) const
243 noexcept(_S_noexcept<_Tp&>())
244 {
245 if constexpr (__member_rbegin<_Tp>)
246 return __t.rbegin();
247 else if constexpr (__adl_rbegin<_Tp>)
248 return rbegin(__t);
249 else
250 return std::make_reverse_iterator(_End{}(__t));
251 }
252 };
253
254 template<typename _Tp>
255 concept __member_rend = requires(_Tp& __t)
256 {
257 { _GLIBCXX_AUTO_CAST(__t.rend()) }
258 -> sentinel_for<decltype(_RBegin{}(std::forward<_Tp>(__t)))>;
259 };
260
261 void rend() = delete;
262
263 template<typename _Tp>
264 concept __adl_rend = __class_or_enum<remove_reference_t<_Tp>>
265 && requires(_Tp& __t)
266 {
267 { _GLIBCXX_AUTO_CAST(rend(__t)) }
268 -> sentinel_for<decltype(_RBegin{}(std::forward<_Tp>(__t)))>;
269 };
270
271 struct _REnd
272 {
273 private:
274 template<typename _Tp>
275 static consteval bool
276 _S_noexcept()
277 {
278 if constexpr (__member_rend<_Tp>)
279 return noexcept(_GLIBCXX_AUTO_CAST(std::declval<_Tp&>().rend()));
280 else if constexpr (__adl_rend<_Tp>)
281 return noexcept(_GLIBCXX_AUTO_CAST(rend(std::declval<_Tp&>())));
282 else
283 {
284 if constexpr (noexcept(_Begin{}(std::declval<_Tp&>())))
285 {
286 using _It = decltype(_Begin{}(std::declval<_Tp&>()));
287 // std::reverse_iterator copy-initializes its member.
288 return is_nothrow_copy_constructible_v<_It>;
289 }
290 else
291 return false;
292 }
293 }
294
295 public:
296 template<__maybe_borrowed_range _Tp>
297 requires __member_rend<_Tp> || __adl_rend<_Tp> || __reversable<_Tp>
298 [[nodiscard, __gnu__::__always_inline__]]
299 constexpr auto
300 operator()(_Tp&& __t) const
301 noexcept(_S_noexcept<_Tp&>())
302 {
303 if constexpr (__member_rend<_Tp>)
304 return __t.rend();
305 else if constexpr (__adl_rend<_Tp>)
306 return rend(__t);
307 else
308 return std::make_reverse_iterator(_Begin{}(__t));
309 }
310 };
311
312 template<typename _Tp>
313 concept __member_size = !disable_sized_range<remove_cvref_t<_Tp>>
314 && requires(_Tp& __t)
315 {
316 { _GLIBCXX_AUTO_CAST(__t.size()) } -> __detail::__is_integer_like;
317 };
318
319 void size() = delete;
320
321 template<typename _Tp>
322 concept __adl_size = __class_or_enum<remove_reference_t<_Tp>>
323 && !disable_sized_range<remove_cvref_t<_Tp>>
324 && requires(_Tp& __t)
325 {
326 { _GLIBCXX_AUTO_CAST(size(__t)) } -> __detail::__is_integer_like;
327 };
328
329 template<typename _Tp>
330 concept __sentinel_size = requires(_Tp& __t)
331 {
332 requires (!is_unbounded_array_v<remove_reference_t<_Tp>>);
333
334 { _Begin{}(__t) } -> forward_iterator;
335
336 { _End{}(__t) } -> sized_sentinel_for<decltype(_Begin{}(__t))>;
337
338 __detail::__to_unsigned_like(_End{}(__t) - _Begin{}(__t));
339 };
340
341 struct _Size
342 {
343 private:
344 template<typename _Tp>
345 static consteval bool
346 _S_noexcept()
347 {
348 if constexpr (is_bounded_array_v<remove_reference_t<_Tp>>)
349 return true;
350 else if constexpr (__member_size<_Tp>)
351 return noexcept(_GLIBCXX_AUTO_CAST(std::declval<_Tp&>().size()));
352 else if constexpr (__adl_size<_Tp>)
353 return noexcept(_GLIBCXX_AUTO_CAST(size(std::declval<_Tp&>())));
354 else if constexpr (__sentinel_size<_Tp>)
355 return noexcept(_End{}(std::declval<_Tp&>())
356 - _Begin{}(std::declval<_Tp&>()));
357 }
358
359 public:
360 template<typename _Tp>
361 requires is_bounded_array_v<remove_reference_t<_Tp>>
362 || __member_size<_Tp> || __adl_size<_Tp> || __sentinel_size<_Tp>
363 [[nodiscard, __gnu__::__always_inline__]]
364 constexpr auto
365 operator()(_Tp&& __t) const noexcept(_S_noexcept<_Tp&>())
366 {
367 if constexpr (is_bounded_array_v<remove_reference_t<_Tp>>)
368 return extent_v<remove_reference_t<_Tp>>;
369 else if constexpr (__member_size<_Tp>)
370 return __t.size();
371 else if constexpr (__adl_size<_Tp>)
372 return size(__t);
373 else if constexpr (__sentinel_size<_Tp>)
374 return __detail::__to_unsigned_like(_End{}(__t) - _Begin{}(__t));
375 }
376 };
377
378 struct _SSize
379 {
380 // _GLIBCXX_RESOLVE_LIB_DEFECTS
381 // 3403. Domain of ranges::ssize(E) doesn't match ranges::size(E)
382 template<typename _Tp>
383 requires requires (_Tp& __t) { _Size{}(__t); }
384 [[nodiscard, __gnu__::__always_inline__]]
385 constexpr auto
386 operator()(_Tp&& __t) const noexcept(noexcept(_Size{}(__t)))
387 {
388 auto __size = _Size{}(__t);
389 using __size_type = decltype(__size);
390 // Return the wider of ptrdiff_t and make-signed-like-t<__size_type>.
391 if constexpr (integral<__size_type>)
392 {
394 if constexpr (__int_traits<__size_type>::__digits
395 < __int_traits<ptrdiff_t>::__digits)
396 return static_cast<ptrdiff_t>(__size);
397 else
398 return static_cast<make_signed_t<__size_type>>(__size);
399 }
400 else // Must be one of __max_diff_type or __max_size_type.
401 return __detail::__max_diff_type(__size);
402 }
403 };
404
405 template<typename _Tp>
406 concept __member_empty = requires(_Tp& __t) { bool(__t.empty()); };
407
408 template<typename _Tp>
409 concept __size0_empty = requires(_Tp& __t) { _Size{}(__t) == 0; };
410
411 template<typename _Tp>
412 concept __eq_iter_empty = requires(_Tp& __t)
413 {
414 requires (!is_unbounded_array_v<remove_reference_t<_Tp>>);
415
416 { _Begin{}(__t) } -> forward_iterator;
417
418 bool(_Begin{}(__t) == _End{}(__t));
419 };
420
421 struct _Empty
422 {
423 private:
424 template<typename _Tp>
425 static consteval bool
426 _S_noexcept()
427 {
428 if constexpr (__member_empty<_Tp>)
429 return noexcept(bool(std::declval<_Tp&>().empty()));
430 else if constexpr (__size0_empty<_Tp>)
431 return noexcept(_Size{}(std::declval<_Tp&>()) == 0);
432 else
433 return noexcept(bool(_Begin{}(std::declval<_Tp&>())
434 == _End{}(std::declval<_Tp&>())));
435 }
436
437 public:
438 template<typename _Tp>
439 requires __member_empty<_Tp> || __size0_empty<_Tp>
440 || __eq_iter_empty<_Tp>
441 [[nodiscard, __gnu__::__always_inline__]]
442 constexpr bool
443 operator()(_Tp&& __t) const noexcept(_S_noexcept<_Tp&>())
444 {
445 if constexpr (__member_empty<_Tp>)
446 return bool(__t.empty());
447 else if constexpr (__size0_empty<_Tp>)
448 return _Size{}(__t) == 0;
449 else
450 return bool(_Begin{}(__t) == _End{}(__t));
451 }
452 };
453
454 template<typename _Tp>
455 concept __pointer_to_object = is_pointer_v<_Tp>
456 && is_object_v<remove_pointer_t<_Tp>>;
457
458 template<typename _Tp>
459 concept __member_data = requires(_Tp& __t)
460 {
461 { _GLIBCXX_AUTO_CAST(__t.data()) } -> __pointer_to_object;
462 };
463
464 template<typename _Tp>
465 concept __begin_data = contiguous_iterator<__range_iter_t<_Tp>>;
466
467 struct _Data
468 {
469 private:
470 template<typename _Tp>
471 static consteval bool
472 _S_noexcept()
473 {
474 if constexpr (__member_data<_Tp>)
475 return noexcept(_GLIBCXX_AUTO_CAST(std::declval<_Tp&>().data()));
476 else
477 return noexcept(_Begin{}(std::declval<_Tp&>()));
478 }
479
480 public:
481 template<__maybe_borrowed_range _Tp>
482 requires __member_data<_Tp> || __begin_data<_Tp>
483 [[nodiscard, __gnu__::__always_inline__]]
484 constexpr auto
485 operator()(_Tp&& __t) const noexcept(_S_noexcept<_Tp>())
486 {
487 if constexpr (__member_data<_Tp>)
488 return __t.data();
489 else
490 return std::to_address(_Begin{}(__t));
491 }
492 };
493
494 } // namespace __access
495
496 inline namespace _Cpo
497 {
498 inline constexpr ranges::__access::_Begin begin{};
499 inline constexpr ranges::__access::_End end{};
500 inline constexpr ranges::__access::_RBegin rbegin{};
501 inline constexpr ranges::__access::_REnd rend{};
502 inline constexpr ranges::__access::_Size size{};
503 inline constexpr ranges::__access::_SSize ssize{};
504 inline constexpr ranges::__access::_Empty empty{};
505 inline constexpr ranges::__access::_Data data{};
506 }
507
508 /// [range.range] The range concept.
509 template<typename _Tp>
510 concept range = requires(_Tp& __t)
511 {
512 ranges::begin(__t);
513 ranges::end(__t);
514 };
515
516 /// [range.range] The borrowed_range concept.
517 template<typename _Tp>
518 concept borrowed_range
519 = range<_Tp> && __detail::__maybe_borrowed_range<_Tp>;
520
521 template<typename _Tp>
522 using iterator_t = std::__detail::__range_iter_t<_Tp>;
523
524 template<range _Range>
525 using sentinel_t = decltype(ranges::end(std::declval<_Range&>()));
526
527#if __glibcxx_ranges_as_const // >= C++23
528 template<range _Range>
529 using const_iterator_t = const_iterator<iterator_t<_Range>>;
530
531 template<range _Range>
532 using const_sentinel_t = const_sentinel<sentinel_t<_Range>>;
533
534 template<range _Range>
535 using range_const_reference_t = iter_const_reference_t<iterator_t<_Range>>;
536#endif
537
538 template<range _Range>
539 using range_difference_t = iter_difference_t<iterator_t<_Range>>;
540
541 template<range _Range>
542 using range_value_t = iter_value_t<iterator_t<_Range>>;
543
544 template<range _Range>
545 using range_reference_t = iter_reference_t<iterator_t<_Range>>;
546
547 template<range _Range>
548 using range_rvalue_reference_t
549 = iter_rvalue_reference_t<iterator_t<_Range>>;
550
551 // _GLIBCXX_RESOLVE_LIB_DEFECTS
552 // 3860. range_common_reference_t is missing
553 template<range _Range>
554 using range_common_reference_t
555 = iter_common_reference_t<iterator_t<_Range>>;
556
557 /// [range.sized] The sized_range concept.
558 template<typename _Tp>
559 concept sized_range = range<_Tp>
560 && requires(_Tp& __t) { ranges::size(__t); };
561
562 template<sized_range _Range>
563 using range_size_t = decltype(ranges::size(std::declval<_Range&>()));
564
565 template<typename _Derived>
566 requires is_class_v<_Derived> && same_as<_Derived, remove_cv_t<_Derived>>
567 class view_interface; // defined in <bits/ranges_util.h>
568
569 namespace __detail
570 {
571 template<typename _Tp, typename _Up>
572 requires (!same_as<_Tp, view_interface<_Up>>)
573 void __is_derived_from_view_interface_fn(const _Tp&,
574 const view_interface<_Up>&); // not defined
575
576 // Returns true iff _Tp has exactly one public base class that's a
577 // specialization of view_interface.
578 template<typename _Tp>
579 concept __is_derived_from_view_interface
580 = requires (_Tp __t) { __is_derived_from_view_interface_fn(__t, __t); };
581 } // namespace __detail
582
583 /// [range.view] The ranges::view_base type.
584 struct view_base { };
585
586 /// [range.view] The ranges::enable_view boolean.
587 template<typename _Tp>
588 inline constexpr bool enable_view = derived_from<_Tp, view_base>
589 || __detail::__is_derived_from_view_interface<_Tp>;
590
591 /// [range.view] The ranges::view concept.
592 template<typename _Tp>
593 concept view
594 = range<_Tp> && movable<_Tp> && enable_view<_Tp>;
595
596 // [range.refinements]
597
598 /// A range for which ranges::begin returns an output iterator.
599 template<typename _Range, typename _Tp>
600 concept output_range
601 = range<_Range> && output_iterator<iterator_t<_Range>, _Tp>;
602
603 /// A range for which ranges::begin returns an input iterator.
604 template<typename _Tp>
605 concept input_range = range<_Tp> && input_iterator<iterator_t<_Tp>>;
606
607 /// A range for which ranges::begin returns a forward iterator.
608 template<typename _Tp>
609 concept forward_range
610 = input_range<_Tp> && forward_iterator<iterator_t<_Tp>>;
611
612 /// A range for which ranges::begin returns a bidirectional iterator.
613 template<typename _Tp>
614 concept bidirectional_range
615 = forward_range<_Tp> && bidirectional_iterator<iterator_t<_Tp>>;
616
617 /// A range for which ranges::begin returns a random access iterator.
618 template<typename _Tp>
619 concept random_access_range
620 = bidirectional_range<_Tp> && random_access_iterator<iterator_t<_Tp>>;
621
622 /// A range for which ranges::begin returns a contiguous iterator.
623 template<typename _Tp>
624 concept contiguous_range
625 = random_access_range<_Tp> && contiguous_iterator<iterator_t<_Tp>>
626 && requires(_Tp& __t)
627 {
628 { ranges::data(__t) } -> same_as<add_pointer_t<range_reference_t<_Tp>>>;
629 };
630
631 /// A range for which ranges::begin and ranges::end return the same type.
632 template<typename _Tp>
633 concept common_range
634 = range<_Tp> && same_as<iterator_t<_Tp>, sentinel_t<_Tp>>;
635
636#if __glibcxx_ranges_as_const // >= C++23
637 template<typename _Tp>
638 concept constant_range
639 = input_range<_Tp> && std::__detail::__constant_iterator<iterator_t<_Tp>>;
640#endif
641
642 namespace __access
643 {
644#if __glibcxx_ranges_as_const // >= C++23
645 template<input_range _Range>
646 [[__gnu__::__always_inline__]]
647 constexpr auto&
648 __possibly_const_range(_Range& __r) noexcept
649 {
650 // _GLIBCXX_RESOLVE_LIB_DEFECTS
651 // 4027. possibly-const-range should prefer returning const R&
652 if constexpr (input_range<const _Range>)
653 return const_cast<const _Range&>(__r);
654 else
655 return __r;
656 }
657#else
658 // If _To is an lvalue-reference, return const _Tp&, otherwise const _Tp&&.
659 template<typename _To, typename _Tp>
660 [[__gnu__::__always_inline__]]
661 constexpr decltype(auto)
662 __as_const(_Tp& __t) noexcept
663 {
664 static_assert(std::is_same_v<_To&, _Tp&>);
665
666 if constexpr (is_lvalue_reference_v<_To>)
667 return const_cast<const _Tp&>(__t);
668 else
669 return static_cast<const _Tp&&>(__t);
670 }
671#endif
672
673 struct _CBegin
674 {
675#if __glibcxx_ranges_as_const // >= C++23
676 template<__maybe_borrowed_range _Tp>
677 [[nodiscard]]
678 constexpr auto
679 operator()(_Tp&& __t) const
680 noexcept(noexcept(std::make_const_iterator
681 (ranges::begin(__access::__possibly_const_range(__t)))))
682 requires requires { std::make_const_iterator
683 (ranges::begin(__access::__possibly_const_range(__t))); }
684 {
685 auto& __r = __access::__possibly_const_range(__t);
686 return const_iterator_t<decltype(__r)>(ranges::begin(__r));
687 }
688#else
689 template<typename _Tp>
690 [[nodiscard]]
691 constexpr auto
692 operator()(_Tp&& __e) const
693 noexcept(noexcept(_Begin{}(__access::__as_const<_Tp>(__e))))
694 requires requires { _Begin{}(__access::__as_const<_Tp>(__e)); }
695 {
696 return _Begin{}(__access::__as_const<_Tp>(__e));
697 }
698#endif
699 };
700
701 struct _CEnd final
702 {
703#if __glibcxx_ranges_as_const // >= C++23
704 template<__maybe_borrowed_range _Tp>
705 [[nodiscard]]
706 constexpr auto
707 operator()(_Tp&& __t) const
708 noexcept(noexcept(std::make_const_sentinel
709 (ranges::end(__access::__possibly_const_range(__t)))))
710 requires requires { std::make_const_sentinel
711 (ranges::end(__access::__possibly_const_range(__t))); }
712 {
713 auto& __r = __access::__possibly_const_range(__t);
714 return const_sentinel_t<decltype(__r)>(ranges::end(__r));
715 }
716#else
717 template<typename _Tp>
718 [[nodiscard]]
719 constexpr auto
720 operator()(_Tp&& __e) const
721 noexcept(noexcept(_End{}(__access::__as_const<_Tp>(__e))))
722 requires requires { _End{}(__access::__as_const<_Tp>(__e)); }
723 {
724 return _End{}(__access::__as_const<_Tp>(__e));
725 }
726#endif
727 };
728
729 struct _CRBegin
730 {
731#if __glibcxx_ranges_as_const // >= C++23
732 template<__maybe_borrowed_range _Tp>
733 [[nodiscard]]
734 constexpr auto
735 operator()(_Tp&& __t) const
736 noexcept(noexcept(std::make_const_iterator
737 (ranges::rbegin(__access::__possibly_const_range(__t)))))
738 requires requires { std::make_const_iterator
739 (ranges::rbegin(__access::__possibly_const_range(__t))); }
740 {
741 auto& __r = __access::__possibly_const_range(__t);
742 return const_iterator<decltype(ranges::rbegin(__r))>(ranges::rbegin(__r));
743 }
744#else
745 template<typename _Tp>
746 [[nodiscard]]
747 constexpr auto
748 operator()(_Tp&& __e) const
749 noexcept(noexcept(_RBegin{}(__access::__as_const<_Tp>(__e))))
750 requires requires { _RBegin{}(__access::__as_const<_Tp>(__e)); }
751 {
752 return _RBegin{}(__access::__as_const<_Tp>(__e));
753 }
754#endif
755 };
756
757 struct _CREnd
758 {
759#if __glibcxx_ranges_as_const // >= C++23
760 template<__maybe_borrowed_range _Tp>
761 [[nodiscard]]
762 constexpr auto
763 operator()(_Tp&& __t) const
764 noexcept(noexcept(std::make_const_sentinel
765 (ranges::rend(__access::__possibly_const_range(__t)))))
766 requires requires { std::make_const_sentinel
767 (ranges::rend(__access::__possibly_const_range(__t))); }
768 {
769 auto& __r = __access::__possibly_const_range(__t);
770 return const_sentinel<decltype(ranges::rend(__r))>(ranges::rend(__r));
771 }
772#else
773 template<typename _Tp>
774 [[nodiscard]]
775 constexpr auto
776 operator()(_Tp&& __e) const
777 noexcept(noexcept(_REnd{}(__access::__as_const<_Tp>(__e))))
778 requires requires { _REnd{}(__access::__as_const<_Tp>(__e)); }
779 {
780 return _REnd{}(__access::__as_const<_Tp>(__e));
781 }
782#endif
783 };
784
785 struct _CData
786 {
787#if __glibcxx_ranges_as_const // >= C++23
788 template<__maybe_borrowed_range _Tp>
789 [[nodiscard]]
790 constexpr const auto*
791 operator()(_Tp&& __t) const
792 noexcept(noexcept(ranges::data(__access::__possibly_const_range(__t))))
793 requires requires { ranges::data(__access::__possibly_const_range(__t)); }
794 { return ranges::data(__access::__possibly_const_range(__t)); }
795#else
796 template<typename _Tp>
797 [[nodiscard]]
798 constexpr auto
799 operator()(_Tp&& __e) const
800 noexcept(noexcept(_Data{}(__access::__as_const<_Tp>(__e))))
801 requires requires { _Data{}(__access::__as_const<_Tp>(__e)); }
802 {
803 return _Data{}(__access::__as_const<_Tp>(__e));
804 }
805#endif
806 };
807 } // namespace __access
808
809 inline namespace _Cpo
810 {
811 inline constexpr ranges::__access::_CBegin cbegin{};
812 inline constexpr ranges::__access::_CEnd cend{};
813 inline constexpr ranges::__access::_CRBegin crbegin{};
814 inline constexpr ranges::__access::_CREnd crend{};
815 inline constexpr ranges::__access::_CData cdata{};
816 }
817
818 namespace __detail
819 {
820 template<typename _Tp>
821 inline constexpr bool __is_initializer_list = false;
822
823 template<typename _Tp>
824 inline constexpr bool __is_initializer_list<initializer_list<_Tp>> = true;
825 } // namespace __detail
826
827 /// A range which can be safely converted to a view.
828 template<typename _Tp>
829 concept viewable_range = range<_Tp>
830 && ((view<remove_cvref_t<_Tp>> && constructible_from<remove_cvref_t<_Tp>, _Tp>)
831 || (!view<remove_cvref_t<_Tp>>
832 && (is_lvalue_reference_v<_Tp>
833 || (movable<remove_reference_t<_Tp>>
834 && !__detail::__is_initializer_list<remove_cvref_t<_Tp>>))));
835
836 // [range.iter.ops] range iterator operations
837
838 struct __advance_fn final
839 {
840 template<input_or_output_iterator _It>
841 constexpr void
842 operator()(_It& __it, iter_difference_t<_It> __n) const
843 {
844 if constexpr (random_access_iterator<_It>)
845 __it += __n;
846 else if constexpr (bidirectional_iterator<_It>)
847 {
848 if (__n > 0)
849 {
850 do
851 {
852 ++__it;
853 }
854 while (--__n);
855 }
856 else if (__n < 0)
857 {
858 do
859 {
860 --__it;
861 }
862 while (++__n);
863 }
864 }
865 else
866 {
867 // cannot decrement a non-bidirectional iterator
868 __glibcxx_assert(__n >= 0);
869 while (__n-- > 0)
870 ++__it;
871 }
872 }
873
874 template<input_or_output_iterator _It, sentinel_for<_It> _Sent>
875 constexpr void
876 operator()(_It& __it, _Sent __bound) const
877 {
878 if constexpr (assignable_from<_It&, _Sent>)
879 __it = std::move(__bound);
880 else if constexpr (sized_sentinel_for<_Sent, _It>)
881 (*this)(__it, __bound - __it);
882 else
883 {
884 while (__it != __bound)
885 ++__it;
886 }
887 }
888
889 template<input_or_output_iterator _It, sentinel_for<_It> _Sent>
890 constexpr iter_difference_t<_It>
891 operator()(_It& __it, iter_difference_t<_It> __n, _Sent __bound) const
892 {
893 if constexpr (sized_sentinel_for<_Sent, _It>)
894 {
895 const iter_difference_t<_It> __diff = __bound - __it;
896
897 if (__diff == 0)
898 {
899 // inline any possible side effects of advance(it, bound)
900 if constexpr (assignable_from<_It&, _Sent>)
901 __it = std::move(__bound);
902 else if constexpr (random_access_iterator<_It>)
903 __it += 0;
904 return __n;
905 }
906 else if (__diff > 0 ? __n >= __diff : __n <= __diff)
907 {
908 (*this)(__it, __bound);
909 return __n - __diff;
910 }
911 else if (__n != 0) [[likely]]
912 {
913 // n and bound must not lead in opposite directions:
914 __glibcxx_assert((__n < 0) == (__diff < 0));
915
916 (*this)(__it, __n);
917 return 0;
918 }
919 else
920 {
921 // inline any possible side effects of advance(it, n)
922 if constexpr (random_access_iterator<_It>)
923 __it += 0;
924 return 0;
925 }
926 }
927 else if (__n == 0 || __it == __bound)
928 return __n;
929 else if (__n > 0)
930 {
931 iter_difference_t<_It> __m = 0;
932 do
933 {
934 ++__it;
935 ++__m;
936 }
937 while (__m != __n && __it != __bound);
938 return __n - __m;
939 }
940 else if constexpr (bidirectional_iterator<_It> && same_as<_It, _Sent>)
941 {
942 iter_difference_t<_It> __m = 0;
943 do
944 {
945 --__it;
946 --__m;
947 }
948 while (__m != __n && __it != __bound);
949 return __n - __m;
950 }
951 else
952 {
953 // cannot decrement a non-bidirectional iterator
954 __glibcxx_assert(__n >= 0);
955 return __n;
956 }
957 }
958
959 void operator&() const = delete;
960 };
961
962 inline constexpr __advance_fn advance{};
963
964 struct __distance_fn final
965 {
966 // _GLIBCXX_RESOLVE_LIB_DEFECTS
967 // 3664. LWG 3392 broke std::ranges::distance(a, a+3)
968 template<typename _It, sentinel_for<_It> _Sent>
969 requires (!sized_sentinel_for<_Sent, _It>)
970 constexpr iter_difference_t<_It>
971 operator()[[nodiscard]](_It __first, _Sent __last) const
972 {
973 iter_difference_t<_It> __n = 0;
974 while (__first != __last)
975 {
976 ++__first;
977 ++__n;
978 }
979 return __n;
980 }
981
982 template<typename _It, sized_sentinel_for<decay_t<_It>> _Sent>
983 [[nodiscard, __gnu__::__always_inline__]]
984 constexpr iter_difference_t<decay_t<_It>>
985 operator()(_It&& __first, _Sent __last) const
986 { return __last - static_cast<const decay_t<_It>&>(__first); }
987
988 template<range _Range>
989 [[nodiscard, __gnu__::__always_inline__]]
990 constexpr range_difference_t<_Range>
991 operator()(_Range&& __r) const
992 {
993 if constexpr (sized_range<_Range>)
994 return static_cast<range_difference_t<_Range>>(ranges::size(__r));
995 else
996 return (*this)(ranges::begin(__r), ranges::end(__r));
997 }
998
999 void operator&() const = delete;
1000 };
1001
1002 inline constexpr __distance_fn distance{};
1003
1004 struct __next_fn final
1005 {
1006 template<input_or_output_iterator _It>
1007 [[nodiscard, __gnu__::__always_inline__]]
1008 constexpr _It
1009 operator()(_It __x) const
1010 {
1011 ++__x;
1012 return __x;
1013 }
1014
1015 template<input_or_output_iterator _It>
1016 [[nodiscard, __gnu__::__always_inline__]]
1017 constexpr _It
1018 operator()(_It __x, iter_difference_t<_It> __n) const
1019 {
1020 ranges::advance(__x, __n);
1021 return __x;
1022 }
1023
1024 template<input_or_output_iterator _It, sentinel_for<_It> _Sent>
1025 [[nodiscard, __gnu__::__always_inline__]]
1026 constexpr _It
1027 operator()(_It __x, _Sent __bound) const
1028 {
1029 ranges::advance(__x, __bound);
1030 return __x;
1031 }
1032
1033 template<input_or_output_iterator _It, sentinel_for<_It> _Sent>
1034 [[nodiscard, __gnu__::__always_inline__]]
1035 constexpr _It
1036 operator()(_It __x, iter_difference_t<_It> __n, _Sent __bound) const
1037 {
1038 ranges::advance(__x, __n, __bound);
1039 return __x;
1040 }
1041
1042 void operator&() const = delete;
1043 };
1044
1045 inline constexpr __next_fn next{};
1046
1047 struct __prev_fn final
1048 {
1049 template<bidirectional_iterator _It>
1050 [[nodiscard, __gnu__::__always_inline__]]
1051 constexpr _It
1052 operator()(_It __x) const
1053 {
1054 --__x;
1055 return __x;
1056 }
1057
1058 template<bidirectional_iterator _It>
1059 [[nodiscard, __gnu__::__always_inline__]]
1060 constexpr _It
1061 operator()(_It __x, iter_difference_t<_It> __n) const
1062 {
1063 ranges::advance(__x, -__n);
1064 return __x;
1065 }
1066
1067 template<bidirectional_iterator _It>
1068 [[nodiscard, __gnu__::__always_inline__]]
1069 constexpr _It
1070 operator()(_It __x, iter_difference_t<_It> __n, _It __bound) const
1071 {
1072 ranges::advance(__x, -__n, __bound);
1073 return __x;
1074 }
1075
1076 void operator&() const = delete;
1077 };
1078
1079 inline constexpr __prev_fn prev{};
1080
1081 /// Type returned by algorithms instead of a dangling iterator or subrange.
1082 struct dangling
1083 {
1084 constexpr dangling() noexcept = default;
1085 template<typename... _Args>
1086 constexpr dangling(_Args&&...) noexcept { }
1087 };
1088
1089 template<range _Range>
1090 using borrowed_iterator_t = __conditional_t<borrowed_range<_Range>,
1091 iterator_t<_Range>,
1092 dangling>;
1093} // namespace ranges
1094
1095#if __glibcxx_ranges_to_container // C++ >= 23
1096 struct from_range_t { explicit from_range_t() = default; };
1097 inline constexpr from_range_t from_range{};
1098#endif
1099
1100#if __glibcxx_containers_ranges // C++ >= 23
1101/// @cond undocumented
1102 template<typename _T1, typename _T2>
1103 struct pair;
1104
1105namespace __detail
1106{
1107 template<typename _Rg, typename _Tp>
1108 concept __container_compatible_range
1109 = ranges::input_range<_Rg>
1110 && convertible_to<ranges::range_reference_t<_Rg>, _Tp>;
1111
1112 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1113 // 4223. Deduction guides for maps are mishandling tuples and references
1114 template<ranges::input_range _Range>
1115 using __range_key_type
1116 = remove_cvref_t<tuple_element_t<0, ranges::range_value_t<_Range>>>;
1117
1118 template<ranges::input_range _Range>
1119 using __range_mapped_type
1120 = remove_cvref_t<tuple_element_t<1, ranges::range_value_t<_Range>>>;
1121
1122 // The allocator's value_type for map-like containers.
1123 template<ranges::input_range _Range>
1124 using __range_to_alloc_type
1125 = pair<const __range_key_type<_Range>, __range_mapped_type<_Range>>;
1126}
1127/// @endcond
1128#endif
1129
1130_GLIBCXX_END_NAMESPACE_VERSION
1131} // namespace std
1132#endif // library concepts
1133#pragma GCC diagnostic pop
1134#endif // C++20
1135#endif // _GLIBCXX_RANGES_BASE_H
constexpr _Tp * to_address(_Tp *__ptr) noexcept
Obtain address referenced by a pointer to an object.
Definition ptr_traits.h:232
typename make_unsigned< _Tp >::type make_unsigned_t
Alias template for make_unsigned.
Definition type_traits:2203
pair(_T1, _T2) -> pair< _T1, _T2 >
Two pairs are equal iff their members are equal.
auto declval() noexcept -> decltype(__declval< _Tp >(0))
Definition type_traits:2671
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 * end(valarray< _Tp > &__va) noexcept
Return an iterator pointing to one past the last element of the valarray.
Definition valarray:1251
_Tp * begin(valarray< _Tp > &__va) noexcept
Return an iterator pointing to the first element of the valarray.
Definition valarray:1229
constexpr reverse_iterator< _Iterator > make_reverse_iterator(_Iterator __i)
Generator function for reverse_iterator.
ISO C++ entities toplevel namespace is std.
constexpr auto rbegin(_Container &__cont) noexcept(noexcept(__cont.rbegin())) -> decltype(__cont.rbegin())
Return a reverse iterator pointing to the last element of the container.
constexpr iterator_traits< _InputIterator >::difference_type distance(_InputIterator __first, _InputIterator __last)
A generalization of pointer arithmetic.
constexpr auto cend(const _Container &__cont) noexcept(noexcept(std::end(__cont))) -> decltype(std::end(__cont))
Return an iterator pointing to one past the last element of the const container.
constexpr auto empty(const _Container &__cont) noexcept(noexcept(__cont.empty())) -> decltype(__cont.empty())
Return whether a container is empty.
constexpr auto crbegin(const _Container &__cont) noexcept(noexcept(std::rbegin(__cont))) -> decltype(std::rbegin(__cont))
Return a reverse iterator pointing to the last element of the const container.
constexpr auto size(const _Container &__cont) noexcept(noexcept(__cont.size())) -> decltype(__cont.size())
Return the size of a container.
constexpr void advance(_InputIterator &__i, _Distance __n)
A generalization of pointer arithmetic.
constexpr auto data(_Container &__cont) noexcept(noexcept(__cont.data())) -> decltype(__cont.data())
Return the data pointer of a container.
constexpr auto cbegin(const _Container &__cont) noexcept(noexcept(std::begin(__cont))) -> decltype(std::begin(__cont))
Return an iterator pointing to the first element of the const container.
constexpr auto rend(_Container &__cont) noexcept(noexcept(__cont.rend())) -> decltype(__cont.rend())
Return a reverse iterator pointing one past the first element of the container.
constexpr bitset< _Nb > operator&(const bitset< _Nb > &__x, const bitset< _Nb > &__y) noexcept
Global bitwise operations on bitsets.
Definition bitset:1597
constexpr auto crend(const _Container &__cont) noexcept(noexcept(std::rend(__cont))) -> decltype(std::rend(__cont))
Return a reverse iterator pointing one past the first element of the const container.
Implementation details not part of the namespace std interface.
__numeric_traits_integer< _Tp > __int_traits
Convenience alias for __numeric_traits<integer-type>.
The ranges::view_interface class template.
Definition ranges_util.h:71
Struct holding two objects of arbitrary type.
Definition stl_pair.h:304