blob: 225ae815363ce19d05d0d98ab85fb4502be59b4d [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
Louis Dionne9bd93882021-11-17 16:25:01 -05002//===----------------------------------------------------------------------===//
Howard Hinnantc51e1022010-05-11 19:42:16 +00003//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Howard Hinnantc51e1022010-05-11 19:42:16 +00007//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_ITERATOR
11#define _LIBCPP_ITERATOR
12
13/*
14 iterator synopsis
15
Christopher Di Bella490fe402021-03-23 03:55:52 +000016#include <concepts>
17
Howard Hinnantc51e1022010-05-11 19:42:16 +000018namespace std
19{
Christopher Di Bellae00eebc2021-03-23 20:48:41 +000020template<class> struct incrementable_traits; // since C++20
Christopher Di Bellaa3a10062021-04-20 18:56:08 +000021template<class T>
22 using iter_difference_t = see below; // since C++20
23
Christopher Di Bellae00eebc2021-03-23 20:48:41 +000024template<class> struct indirectly_readable_traits; // since C++20
Christopher Di Bellaa3a10062021-04-20 18:56:08 +000025template<class T>
26 using iter_value_t = see below; // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +000027
28template<class Iterator>
zoecarver9f1e2972021-04-20 08:50:11 -040029struct iterator_traits;
Howard Hinnantc51e1022010-05-11 19:42:16 +000030
31template<class T>
zoecarver9f1e2972021-04-20 08:50:11 -040032 requires is_object_v<T> // since C++20
33struct iterator_traits<T*>;
Howard Hinnantc51e1022010-05-11 19:42:16 +000034
Christopher Di Bella875636f2021-04-04 05:12:46 +000035template<dereferenceable T>
36 using iter_reference_t = decltype(*declval<T&>());
37
Louis Dionneca989a52021-04-20 14:40:43 -040038namespace ranges::inline unspecified {
39 inline constexpr unspecified iter_move = unspecified; // since C++20, nodiscard as an extension
40}}
41
42template<dereferenceable T>
43 requires ...
44using iter_rvalue_reference_t = decltype(ranges::iter_move(declval<T&>())); // since C++20
45
Louis Dionne463afb82021-04-22 11:05:30 -040046// [iterator.concepts], iterator concepts
47// [iterator.concept.readable], concept indirectly_readable
48template<class In>
Louis Dionne170a03c2021-04-28 15:02:08 -040049 concept indirectly_readable = see below; // since C++20
50
51template<indirectly_readable T>
52 using iter_common_reference_t =
53 common_reference_t<iter_reference_t<T>, iter_value_t<T>&>; // since C++20
Louis Dionne463afb82021-04-22 11:05:30 -040054
55// [iterator.concept.writable], concept indirectly_writable
56template<class Out, class T>
57 concept indirectly_writable = see below; // since C++20
58
Mark de Wever6639f422021-04-26 17:53:20 +020059// [iterator.concept.winc], concept weakly_incrementable
Christopher Di Bella54ffc182021-04-23 18:22:55 -070060template<class I>
61 concept weakly_incrementable = see below; // since C++20
62
63// [iterator.concept.inc], concept incrementable
64template<class I>
65 concept incrementable = see below; // since C++20
66
Mark de Wever6639f422021-04-26 17:53:20 +020067// [iterator.concept.iterator], concept input_or_output_iterator
Christopher Di Bella0ef52282021-04-09 02:10:32 +000068 template<class I>
69 concept input_or_output_iterator = see below; // since C++20
70
Mark de Wever6639f422021-04-26 17:53:20 +020071// [iterator.concept.sentinel], concept sentinel_for
Christopher Di Bella0ef52282021-04-09 02:10:32 +000072template<class S, class I>
73 concept sentinel_for = see below; // since C++20
74
zoecarver11391bc2021-04-26 09:35:47 -070075// [iterator.concept.sizedsentinel], concept sized_sentinel_for
76template<class S, class I>
77 inline constexpr bool disable_sized_sentinel_for = false;
78
79template<class S, class I>
80 concept sized_sentinel_for = see below;
81
Christopher Di Bella8250c632021-04-11 19:04:52 +000082// [iterator.concept.input], concept input_iterator
83template<class I>
84 concept input_iterator = see below; // since C++20
85
Louis Dionneb53a0ec2021-07-23 15:26:23 -040086// [iterator.concept.output], concept output_iterator
87template<class I, class T>
88 concept output_iterator = see below; // since C++20
89
Christopher Di Bella8f1370d2021-04-11 22:11:03 +000090// [iterator.concept.forward], concept forward_iterator
91template<class I>
92 concept forward_iterator = see below; // since C++20
93
Christopher Di Bella10a31472021-04-12 01:16:45 +000094// [iterator.concept.bidir], concept bidirectional_iterator
95template<class I>
96 concept bidirectional_iterator = see below; // since C++20
97
zoecarver21da57e2021-04-23 17:11:44 -070098// [iterator.concept.random.access], concept random_access_iterator
99template<class I>
100 concept random_access_iterator = see below; // since C++20
101
Louis Dionne170a03c2021-04-28 15:02:08 -0400102// [indirectcallable]
103// [indirectcallable.indirectinvocable]
104template<class F, class I>
105 concept indirectly_unary_invocable = see below; // since C++20
106
107template<class F, class I>
108 concept indirectly_regular_unary_invocable = see below; // since C++20
109
110template<class F, class I>
111 concept indirect_unary_predicate = see below; // since C++20
112
113template<class F, class I1, class I2>
114 concept indirect_binary_predicate = see below; // since C++20
115
116template<class F, class I1, class I2 = I1>
117 concept indirect_equivalence_relation = see below; // since C++20
118
119template<class F, class I1, class I2 = I1>
120 concept indirect_strict_weak_order = see below; // since C++20
121
122template<class F, class... Is>
123 using indirect_result_t = see below; // since C++20
124
125// [projected], projected
126template<indirectly_readable I, indirectly_regular_unary_invocable<I> Proj>
127 struct projected; // since C++20
128
129template<weakly_incrementable I, indirectly_regular_unary_invocable<I> Proj>
130 struct incrementable_traits<projected<I, Proj>>; // since C++20
131
zoecarver7e38f802021-05-17 10:30:12 -0700132// [alg.req.ind.move], concept indirectly_movable
133template<class In, class Out>
134 concept indirectly_movable = see below; // since C++20
135
136template<class In, class Out>
137 concept indirectly_movable_storable = see below; // since C++20
138
Konstantin Varlamovde87b2c2022-02-02 13:27:28 -0800139// [alg.req.ind.copy], concept indirectly_copyable
140template<class In, class Out>
Konstantin Varlamov1755e8d2022-02-17 20:15:02 -0800141 concept indirectly_copyable = see below; // since C++20
Konstantin Varlamovde87b2c2022-02-02 13:27:28 -0800142
143template<class In, class Out>
Konstantin Varlamov1755e8d2022-02-17 20:15:02 -0800144 concept indirectly_copyable_storable = see below; // since C++20
Konstantin Varlamovde87b2c2022-02-02 13:27:28 -0800145
zoecarvere0d98082021-07-01 11:58:54 -0700146// [alg.req.ind.swap], concept indirectly_swappable
147template<class I1, class I2 = I1>
148 concept indirectly_swappable = see below; // since C++20
149
Nikolas Klauser764ac5e2022-01-04 19:55:37 +0100150template<class I1, class I2, class R, class P1 = identity,
151 class P2 = identity>
152 concept indirectly_comparable =
153 indirect_binary_predicate<R, projected<I1, P1>, projected<I2, P2>>; // since C++20
154
Konstantin Varlamov1755e8d2022-02-17 20:15:02 -0800155// [alg.req.permutable], concept permutable
Konstantin Varlamov73b5c162022-02-17 20:11:46 -0800156template<class I>
Konstantin Varlamov1755e8d2022-02-17 20:15:02 -0800157 concept permutable = see below; // since C++20
Konstantin Varlamov73b5c162022-02-17 20:11:46 -0800158
159 // [alg.req.mergeable], concept mergeable
160template<class I1, class I2, class Out,
161 class R = ranges::less, class P1 = identity, class P2 = identity>
162 concept mergeable = see below; // since C++20
163
Konstantin Varlamov1755e8d2022-02-17 20:15:02 -0800164// [alg.req.sortable], concept sortable
165template<class I, class R = ranges::less, class P = identity>
166 concept sortable = see below; // since C++20
167
zoecarver6eb71a92021-05-27 09:23:19 -0700168template<input_or_output_iterator I, sentinel_for<I> S>
169 requires (!same_as<I, S> && copyable<I>)
170class common_iterator; // since C++20
171
Howard Hinnantc51e1022010-05-11 19:42:16 +0000172template<class Category, class T, class Distance = ptrdiff_t,
173 class Pointer = T*, class Reference = T&>
Louis Dionne8762e2b2021-05-25 18:15:58 -0400174struct iterator // deprecated in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000175{
176 typedef T value_type;
177 typedef Distance difference_type;
178 typedef Pointer pointer;
179 typedef Reference reference;
180 typedef Category iterator_category;
181};
182
183struct input_iterator_tag {};
184struct output_iterator_tag {};
185struct forward_iterator_tag : public input_iterator_tag {};
186struct bidirectional_iterator_tag : public forward_iterator_tag {};
187struct random_access_iterator_tag : public bidirectional_iterator_tag {};
Konstantin Varlamov5eda5022022-02-02 12:53:07 -0800188struct contiguous_iterator_tag : public random_access_iterator_tag {};
Howard Hinnantc51e1022010-05-11 19:42:16 +0000189
Marshall Clow75468e72017-05-17 18:51:36 +0000190// 27.4.3, iterator operations
Louis Dionne45768662020-06-08 16:16:01 -0400191template <class InputIterator, class Distance> // constexpr in C++17
192 constexpr void advance(InputIterator& i, Distance n);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000193
Marshall Clow75468e72017-05-17 18:51:36 +0000194template <class InputIterator> // constexpr in C++17
195 constexpr typename iterator_traits<InputIterator>::difference_type
196 distance(InputIterator first, InputIterator last);
197
198template <class InputIterator> // constexpr in C++17
199 constexpr InputIterator next(InputIterator x,
200typename iterator_traits<InputIterator>::difference_type n = 1);
201
202template <class BidirectionalIterator> // constexpr in C++17
203 constexpr BidirectionalIterator prev(BidirectionalIterator x,
Louis Dionne173f29e2019-05-29 16:01:36 +0000204 typename iterator_traits<BidirectionalIterator>::difference_type n = 1);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000205
Christopher Di Bellac6ead652021-05-05 07:14:08 +0000206// [range.iter.ops], range iterator operations
207namespace ranges {
208 // [range.iter.op.advance], ranges::advance
209 template<input_or_output_iterator I>
210 constexpr void advance(I& i, iter_difference_t<I> n); // since C++20
211 template<input_or_output_iterator I, sentinel_for<I> S>
212 constexpr void advance(I& i, S bound); // since C++20
213 template<input_or_output_iterator I, sentinel_for<I> S>
214 constexpr iter_difference_t<I> advance(I& i, iter_difference_t<I> n, S bound); // since C++20
215}
216
Howard Hinnantc51e1022010-05-11 19:42:16 +0000217template <class Iterator>
218class reverse_iterator
Louis Dionne8762e2b2021-05-25 18:15:58 -0400219 : public iterator<typename iterator_traits<Iterator>::iterator_category, // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000220 typename iterator_traits<Iterator>::value_type,
221 typename iterator_traits<Iterator>::difference_type,
222 typename iterator_traits<Iterator>::pointer,
223 typename iterator_traits<Iterator>::reference>
224{
225protected:
226 Iterator current;
227public:
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700228 using iterator_type = Iterator;
229 using iterator_concept = see below; // since C++20
230 using iterator_category = typename iterator_traits<Iterator>::iterator_category; // since C++17, until C++20
231 using iterator_category = see below; // since C++20
232 using value_type = typename iterator_traits<Iterator>::value_type; // since C++17, until C++20
233 using value_type = iter_value_t<Iterator>; // since C++20
234 using difference_type = typename iterator_traits<Iterator>::difference_type; // until C++20
235 using difference_type = iter_difference_t<Iterator>; // since C++20
236 using pointer = typename iterator_traits<Iterator>::pointer;
237 using reference = typename iterator_traits<Iterator>::reference; // until C++20
238 using reference = iter_reference_t<Iterator>; // since C++20
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000239
Marshall Clow5ace5542016-10-19 15:12:50 +0000240 constexpr reverse_iterator();
241 constexpr explicit reverse_iterator(Iterator x);
242 template <class U> constexpr reverse_iterator(const reverse_iterator<U>& u);
243 template <class U> constexpr reverse_iterator& operator=(const reverse_iterator<U>& u);
244 constexpr Iterator base() const;
245 constexpr reference operator*() const;
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700246 constexpr pointer operator->() const; // until C++20
247 constexpr pointer operator->() const requires see below; // since C++20
Marshall Clow5ace5542016-10-19 15:12:50 +0000248 constexpr reverse_iterator& operator++();
249 constexpr reverse_iterator operator++(int);
250 constexpr reverse_iterator& operator--();
251 constexpr reverse_iterator operator--(int);
252 constexpr reverse_iterator operator+ (difference_type n) const;
253 constexpr reverse_iterator& operator+=(difference_type n);
254 constexpr reverse_iterator operator- (difference_type n) const;
255 constexpr reverse_iterator& operator-=(difference_type n);
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700256 constexpr unspecified operator[](difference_type n) const;
257
258 friend constexpr iter_rvalue_reference_t<Iterator>
259 iter_move(const reverse_iterator& i) noexcept(see below);
260 template<indirectly_swappable<Iterator> Iterator2>
261 friend constexpr void
262 iter_swap(const reverse_iterator& x,
263 const reverse_iterator<Iterator2>& y) noexcept(see below);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000264};
265
266template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000267constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000268operator==(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
269
270template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000271constexpr bool // constexpr in C++17
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700272operator!=(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000273
274template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000275constexpr bool // constexpr in C++17
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700276operator<(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000277
278template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000279constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000280operator>(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
281
282template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000283constexpr bool // constexpr in C++17
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700284operator<=(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000285
286template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000287constexpr bool // constexpr in C++17
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700288operator>=(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
289
290template<class Iterator1, three_way_comparable_with<Iterator1> Iterator2>
291 constexpr compare_three_way_result_t<Iterator1, Iterator2>
292 operator<=>(const reverse_iterator<Iterator1>& x,
293 const reverse_iterator<Iterator2>& y);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000294
295template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000296constexpr auto
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000297operator-(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y)
Marshall Clow5ace5542016-10-19 15:12:50 +0000298-> decltype(__y.base() - __x.base()); // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000299
300template <class Iterator>
Marshall Clow5ace5542016-10-19 15:12:50 +0000301constexpr reverse_iterator<Iterator>
Louis Dionne173f29e2019-05-29 16:01:36 +0000302operator+(typename reverse_iterator<Iterator>::difference_type n,
Marshall Clow5ace5542016-10-19 15:12:50 +0000303 const reverse_iterator<Iterator>& x); // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000304
Marshall Clow5ace5542016-10-19 15:12:50 +0000305template <class Iterator>
306constexpr reverse_iterator<Iterator> make_reverse_iterator(Iterator i); // C++14, constexpr in C++17
Marshall Clow6dbbdc92014-03-03 01:24:04 +0000307
Konstantin Varlamovb8996862022-03-17 19:57:39 -0700308template<class Iterator1, class Iterator2>
309 requires (!sized_sentinel_for<Iterator1, Iterator2>)
310 inline constexpr bool disable_sized_sentinel_for<reverse_iterator<Iterator1>,
311 reverse_iterator<Iterator2>> = true;
312
Howard Hinnantc51e1022010-05-11 19:42:16 +0000313template <class Container>
314class back_insert_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400315 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000316{
317protected:
318 Container* container;
319public:
320 typedef Container container_type;
321 typedef void value_type;
Louis Dionne3402c3c2021-05-27 12:56:12 -0400322 typedef void difference_type; // until C++20
323 typedef ptrdiff_t difference_type; // since C++20
Eric Fiselier9aeea872016-06-30 04:40:50 +0000324 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000325 typedef void pointer;
326
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500327 explicit back_insert_iterator(Container& x); // constexpr in C++20
328 back_insert_iterator& operator=(const typename Container::value_type& value); // constexpr in C++20
329 back_insert_iterator& operator*(); // constexpr in C++20
330 back_insert_iterator& operator++(); // constexpr in C++20
331 back_insert_iterator operator++(int); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000332};
333
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500334template <class Container> back_insert_iterator<Container> back_inserter(Container& x); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000335
336template <class Container>
337class front_insert_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400338 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000339{
340protected:
341 Container* container;
342public:
343 typedef Container container_type;
344 typedef void value_type;
Louis Dionne3402c3c2021-05-27 12:56:12 -0400345 typedef void difference_type; // until C++20
346 typedef ptrdiff_t difference_type; // since C++20
Eric Fiselier9aeea872016-06-30 04:40:50 +0000347 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000348 typedef void pointer;
349
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500350 explicit front_insert_iterator(Container& x); // constexpr in C++20
351 front_insert_iterator& operator=(const typename Container::value_type& value); // constexpr in C++20
352 front_insert_iterator& operator*(); // constexpr in C++20
353 front_insert_iterator& operator++(); // constexpr in C++20
354 front_insert_iterator operator++(int); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000355};
356
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500357template <class Container> front_insert_iterator<Container> front_inserter(Container& x); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000358
359template <class Container>
360class insert_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400361 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000362{
363protected:
364 Container* container;
365 typename Container::iterator iter;
366public:
367 typedef Container container_type;
368 typedef void value_type;
Louis Dionne3402c3c2021-05-27 12:56:12 -0400369 typedef void difference_type; // until C++20
370 typedef ptrdiff_t difference_type; // since C++20
Eric Fiselier9aeea872016-06-30 04:40:50 +0000371 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000372 typedef void pointer;
373
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500374 insert_iterator(Container& x, typename Container::iterator i); // constexpr in C++20
375 insert_iterator& operator=(const typename Container::value_type& value); // constexpr in C++20
376 insert_iterator& operator*(); // constexpr in C++20
377 insert_iterator& operator++(); // constexpr in C++20
378 insert_iterator& operator++(int); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000379};
380
Konstantin Varlamoveb3faed2022-02-10 18:43:43 -0800381template <class Container>
382insert_iterator<Container> inserter(Container& x, typename Container::iterator i); // until C++20
383template <class Container>
384constexpr insert_iterator<Container> inserter(Container& x, ranges::iterator_t<Container> i); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000385
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000386template <class Iterator>
387class move_iterator {
388public:
Konstantin Varlamov2c7e7ba2022-05-24 19:56:02 -0700389 using iterator_type = Iterator;
390 using iterator_concept = input_iterator_tag; // From C++20
391 using iterator_category = see below; // not always present starting from C++20
392 using value_type = iter_value_t<Iterator>; // Until C++20, iterator_traits<Iterator>::value_type
393 using difference_type = iter_difference_t<Iterator>; // Until C++20, iterator_traits<Iterator>::difference_type;
394 using pointer = Iterator;
395 using reference = iter_rvalue_reference_t<Iterator>; // Until C++20, value_type&&
Louis Dionne173f29e2019-05-29 16:01:36 +0000396
Marshall Clowb5f99122016-11-02 15:30:26 +0000397 constexpr move_iterator(); // all the constexprs are in C++17
398 constexpr explicit move_iterator(Iterator i);
399 template <class U>
400 constexpr move_iterator(const move_iterator<U>& u);
401 template <class U>
402 constexpr move_iterator& operator=(const move_iterator<U>& u);
Konstantin Varlamov2c7e7ba2022-05-24 19:56:02 -0700403
404 constexpr iterator_type base() const; // Until C++20
405 constexpr const Iterator& base() const & noexcept; // From C++20
406 constexpr Iterator base() &&; // From C++20
407
Marshall Clowb5f99122016-11-02 15:30:26 +0000408 constexpr reference operator*() const;
Konstantin Varlamov89a23f32022-06-28 11:59:59 -0700409 constexpr pointer operator->() const; // Deprecated in C++20
Marshall Clowb5f99122016-11-02 15:30:26 +0000410 constexpr move_iterator& operator++();
Konstantin Varlamov2c7e7ba2022-05-24 19:56:02 -0700411 constexpr auto operator++(int); // Return type was move_iterator until C++20
Marshall Clowb5f99122016-11-02 15:30:26 +0000412 constexpr move_iterator& operator--();
413 constexpr move_iterator operator--(int);
Louis Dionne173f29e2019-05-29 16:01:36 +0000414 constexpr move_iterator operator+(difference_type n) const;
415 constexpr move_iterator& operator+=(difference_type n);
416 constexpr move_iterator operator-(difference_type n) const;
417 constexpr move_iterator& operator-=(difference_type n);
Konstantin Varlamov2c7e7ba2022-05-24 19:56:02 -0700418 constexpr reference operator[](difference_type n) const; // Return type unspecified until C++20
419
420 template<sentinel_for<Iterator> S>
421 friend constexpr bool
422 operator==(const move_iterator& x, const move_sentinel<S>& y); // Since C++20
423 template<sized_sentinel_for<Iterator> S>
424 friend constexpr iter_difference_t<Iterator>
425 operator-(const move_sentinel<S>& x, const move_iterator& y); // Since C++20
426 template<sized_sentinel_for<Iterator> S>
427 friend constexpr iter_difference_t<Iterator>
428 operator-(const move_iterator& x, const move_sentinel<S>& y); // Since C++20
429 friend constexpr iter_rvalue_reference_t<Iterator>
430 iter_move(const move_iterator& i)
431 noexcept(noexcept(ranges::iter_move(i.current))); // Since C++20
432 template<indirectly_swappable<Iterator> Iterator2>
433 friend constexpr void
434 iter_swap(const move_iterator& x, const move_iterator<Iterator2>& y)
435 noexcept(noexcept(ranges::iter_swap(x.current, y.current))); // Since C++20
436
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000437private:
438 Iterator current; // exposition only
439};
440
441template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000442constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000443operator==(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
444
445template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000446constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000447operator!=(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
448
449template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000450constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000451operator<(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
452
453template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000454constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000455operator<=(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
456
457template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000458constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000459operator>(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
460
461template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000462constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000463operator>=(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
464
465template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000466constexpr auto // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000467operator-(const move_iterator<Iterator1>& x,
468 const move_iterator<Iterator2>& y) -> decltype(x.base() - y.base());
469
470template <class Iterator>
Marshall Clowb5f99122016-11-02 15:30:26 +0000471constexpr move_iterator<Iterator> operator+( // constexpr in C++17
Louis Dionne173f29e2019-05-29 16:01:36 +0000472 typename move_iterator<Iterator>::difference_type n,
Marshall Clowb5f99122016-11-02 15:30:26 +0000473 const move_iterator<Iterator>& x);
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000474
Marshall Clowb5f99122016-11-02 15:30:26 +0000475template <class Iterator> // constexpr in C++17
476constexpr move_iterator<Iterator> make_move_iterator(const Iterator& i);
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000477
Konstantin Varlamov2c7e7ba2022-05-24 19:56:02 -0700478template<semiregular S>
479class move_sentinel {
480public:
481 constexpr move_sentinel();
482 constexpr explicit move_sentinel(S s);
483 template<class S2>
484 requires convertible_to<const S2&, S>
485 constexpr move_sentinel(const move_sentinel<S2>& s);
486 template<class S2>
487 requires assignable_from<S&, const S2&>
488 constexpr move_sentinel& operator=(const move_sentinel<S2>& s);
489
490 constexpr S base() const;
491private:
492 S last; // exposition only
493};
494
zoecarver63f13202021-06-01 12:55:33 -0700495// [default.sentinel], default sentinel
496struct default_sentinel_t;
497inline constexpr default_sentinel_t default_sentinel{};
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000498
zoecarverd3aca592021-07-13 11:06:10 -0700499// [iterators.counted], counted iterators
500template<input_or_output_iterator I> class counted_iterator;
501
502template<input_iterator I>
503 requires see below
504 struct iterator_traits<counted_iterator<I>>;
505
zoecarver23001f72021-08-11 11:16:27 -0700506// [unreachable.sentinel], unreachable sentinel
507struct unreachable_sentinel_t;
508inline constexpr unreachable_sentinel_t unreachable_sentinel{};
509
Howard Hinnantc51e1022010-05-11 19:42:16 +0000510template <class T, class charT = char, class traits = char_traits<charT>, class Distance = ptrdiff_t>
511class istream_iterator
Louis Dionne8762e2b2021-05-25 18:15:58 -0400512 : public iterator<input_iterator_tag, T, Distance, const T*, const T&> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000513{
514public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400515 typedef input_iterator_tag iterator_category;
516 typedef T value_type;
517 typedef Distance difference_type;
518 typedef const T* pointer;
519 typedef const T& reference;
520
521 typedef charT char_type;
522 typedef traits traits_type;
523 typedef basic_istream<charT, traits> istream_type;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000524
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800525 istream_iterator(); // constexpr since C++11
526 constexpr istream_iterator(default_sentinel_t); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000527 istream_iterator(istream_type& s);
528 istream_iterator(const istream_iterator& x);
529 ~istream_iterator();
530
531 const T& operator*() const;
532 const T* operator->() const;
533 istream_iterator& operator++();
534 istream_iterator operator++(int);
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800535 friend bool operator==(const istream_iterator& i, default_sentinel_t); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000536};
537
538template <class T, class charT, class traits, class Distance>
539bool operator==(const istream_iterator<T,charT,traits,Distance>& x,
540 const istream_iterator<T,charT,traits,Distance>& y);
541template <class T, class charT, class traits, class Distance>
542bool operator!=(const istream_iterator<T,charT,traits,Distance>& x,
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800543 const istream_iterator<T,charT,traits,Distance>& y); // until C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000544
545template <class T, class charT = char, class traits = char_traits<charT> >
546class ostream_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400547 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000548{
549public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400550 typedef output_iterator_tag iterator_category;
551 typedef void value_type;
552 typedef void difference_type; // until C++20
553 typedef ptrdiff_t difference_type; // since C++20
554 typedef void pointer;
555 typedef void reference;
556
Howard Hinnantc51e1022010-05-11 19:42:16 +0000557 typedef charT char_type;
558 typedef traits traits_type;
559 typedef basic_ostream<charT,traits> ostream_type;
560
561 ostream_iterator(ostream_type& s);
562 ostream_iterator(ostream_type& s, const charT* delimiter);
563 ostream_iterator(const ostream_iterator& x);
564 ~ostream_iterator();
565 ostream_iterator& operator=(const T& value);
566
567 ostream_iterator& operator*();
568 ostream_iterator& operator++();
569 ostream_iterator& operator++(int);
570};
571
572template<class charT, class traits = char_traits<charT> >
573class istreambuf_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400574 : public iterator<input_iterator_tag, charT, traits::off_type, unspecified, charT> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000575{
576public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400577 typedef input_iterator_tag iterator_category;
578 typedef charT value_type;
579 typedef traits::off_type difference_type;
580 typedef unspecified pointer;
581 typedef charT reference;
582
583 typedef charT char_type;
584 typedef traits traits_type;
585 typedef traits::int_type int_type;
586 typedef basic_streambuf<charT, traits> streambuf_type;
587 typedef basic_istream<charT, traits> istream_type;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000588
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800589 istreambuf_iterator() noexcept; // constexpr since C++11
590 constexpr istreambuf_iterator(default_sentinel_t) noexcept; // since C++20
Howard Hinnant011138d2012-07-20 19:36:34 +0000591 istreambuf_iterator(istream_type& s) noexcept;
592 istreambuf_iterator(streambuf_type* s) noexcept;
593 istreambuf_iterator(a-private-type) noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000594
595 charT operator*() const;
596 pointer operator->() const;
597 istreambuf_iterator& operator++();
598 a-private-type operator++(int);
599
600 bool equal(const istreambuf_iterator& b) const;
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800601 friend bool operator==(const istreambuf_iterator& i, default_sentinel_t s); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000602};
603
604template <class charT, class traits>
605bool operator==(const istreambuf_iterator<charT,traits>& a,
606 const istreambuf_iterator<charT,traits>& b);
607template <class charT, class traits>
608bool operator!=(const istreambuf_iterator<charT,traits>& a,
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800609 const istreambuf_iterator<charT,traits>& b); // until C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000610
611template <class charT, class traits = char_traits<charT> >
612class ostreambuf_iterator
Louis Dionne8762e2b2021-05-25 18:15:58 -0400613 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000614{
615public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400616 typedef output_iterator_tag iterator_category;
617 typedef void value_type;
618 typedef void difference_type; // until C++20
619 typedef ptrdiff_t difference_type; // since C++20
620 typedef void pointer;
621 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000622
Louis Dionne3402c3c2021-05-27 12:56:12 -0400623 typedef charT char_type;
624 typedef traits traits_type;
625 typedef basic_streambuf<charT, traits> streambuf_type;
626 typedef basic_ostream<charT, traits> ostream_type;
627
Howard Hinnant011138d2012-07-20 19:36:34 +0000628 ostreambuf_iterator(ostream_type& s) noexcept;
629 ostreambuf_iterator(streambuf_type* s) noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000630 ostreambuf_iterator& operator=(charT c);
631 ostreambuf_iterator& operator*();
632 ostreambuf_iterator& operator++();
633 ostreambuf_iterator& operator++(int);
Howard Hinnant011138d2012-07-20 19:36:34 +0000634 bool failed() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000635};
636
Marshall Clow99ba0022017-01-04 17:58:17 +0000637template <class C> constexpr auto begin(C& c) -> decltype(c.begin());
638template <class C> constexpr auto begin(const C& c) -> decltype(c.begin());
639template <class C> constexpr auto end(C& c) -> decltype(c.end());
640template <class C> constexpr auto end(const C& c) -> decltype(c.end());
641template <class T, size_t N> constexpr T* begin(T (&array)[N]);
642template <class T, size_t N> constexpr T* end(T (&array)[N]);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000643
Marshall Clow99ba0022017-01-04 17:58:17 +0000644template <class C> auto constexpr cbegin(const C& c) -> decltype(std::begin(c)); // C++14
645template <class C> auto constexpr cend(const C& c) -> decltype(std::end(c)); // C++14
646template <class C> auto constexpr rbegin(C& c) -> decltype(c.rbegin()); // C++14
647template <class C> auto constexpr rbegin(const C& c) -> decltype(c.rbegin()); // C++14
648template <class C> auto constexpr rend(C& c) -> decltype(c.rend()); // C++14
649template <class C> constexpr auto rend(const C& c) -> decltype(c.rend()); // C++14
650template <class E> reverse_iterator<const E*> constexpr rbegin(initializer_list<E> il); // C++14
651template <class E> reverse_iterator<const E*> constexpr rend(initializer_list<E> il); // C++14
652template <class T, size_t N> reverse_iterator<T*> constexpr rbegin(T (&array)[N]); // C++14
653template <class T, size_t N> reverse_iterator<T*> constexpr rend(T (&array)[N]); // C++14
654template <class C> constexpr auto crbegin(const C& c) -> decltype(std::rbegin(c)); // C++14
655template <class C> constexpr auto crend(const C& c) -> decltype(std::rend(c)); // C++14
Marshall Clowb278e9c2013-08-30 01:17:07 +0000656
Marshall Clowef357272014-11-19 19:43:23 +0000657// 24.8, container access:
658template <class C> constexpr auto size(const C& c) -> decltype(c.size()); // C++17
659template <class T, size_t N> constexpr size_t size(const T (&array)[N]) noexcept; // C++17
Marshall Clow3c5363e2019-02-27 02:58:56 +0000660
661template <class C> constexpr auto ssize(const C& c)
Arthur O'Dwyer2fc9b5d2021-04-17 17:03:20 -0400662 -> common_type_t<ptrdiff_t, make_signed_t<decltype(c.size())>>; // C++20
Marshall Clow3c5363e2019-02-27 02:58:56 +0000663template <class T, ptrdiff_t> constexpr ptrdiff_t ssize(const T (&array)[N]) noexcept; // C++20
664
Marshall Clowef357272014-11-19 19:43:23 +0000665template <class C> constexpr auto empty(const C& c) -> decltype(c.empty()); // C++17
666template <class T, size_t N> constexpr bool empty(const T (&array)[N]) noexcept; // C++17
667template <class E> constexpr bool empty(initializer_list<E> il) noexcept; // C++17
668template <class C> constexpr auto data(C& c) -> decltype(c.data()); // C++17
669template <class C> constexpr auto data(const C& c) -> decltype(c.data()); // C++17
670template <class T, size_t N> constexpr T* data(T (&array)[N]) noexcept; // C++17
671template <class E> constexpr const E* data(initializer_list<E> il) noexcept; // C++17
672
Howard Hinnantc51e1022010-05-11 19:42:16 +0000673} // std
674
675*/
676
Louis Dionneb4fce352022-03-25 12:55:36 -0400677#include <__assert> // all public C++ headers provide the assertion handler
Howard Hinnantc51e1022010-05-11 19:42:16 +0000678#include <__config>
Arthur O'Dwyera2f99ee2021-04-29 17:40:17 -0400679#include <__debug>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000680#include <__iterator/access.h>
Christopher Di Bellac6ead652021-05-05 07:14:08 +0000681#include <__iterator/advance.h>
Louis Dionne77249522021-06-11 09:55:11 -0400682#include <__iterator/back_insert_iterator.h>
Louis Dionne7d244ab2022-06-06 14:01:38 -0400683#include <__iterator/bounded_iter.h>
zoecarver6eb71a92021-05-27 09:23:19 -0700684#include <__iterator/common_iterator.h>
Louis Dionne463afb82021-04-22 11:05:30 -0400685#include <__iterator/concepts.h>
zoecarverd3aca592021-07-13 11:06:10 -0700686#include <__iterator/counted_iterator.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000687#include <__iterator/data.h>
zoecarver63f13202021-06-01 12:55:33 -0700688#include <__iterator/default_sentinel.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000689#include <__iterator/distance.h>
690#include <__iterator/empty.h>
691#include <__iterator/erase_if_container.h>
Louis Dionne77249522021-06-11 09:55:11 -0400692#include <__iterator/front_insert_iterator.h>
zoecarver61ae1dc2021-04-19 14:28:27 -0400693#include <__iterator/incrementable_traits.h>
Nikolas Klauser764ac5e2022-01-04 19:55:37 +0100694#include <__iterator/indirectly_comparable.h>
Louis Dionne77249522021-06-11 09:55:11 -0400695#include <__iterator/insert_iterator.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000696#include <__iterator/istream_iterator.h>
Arthur O'Dwyer65077c02022-01-07 09:45:05 -0500697#include <__iterator/istreambuf_iterator.h>
Louis Dionneca989a52021-04-20 14:40:43 -0400698#include <__iterator/iter_move.h>
zoecarver31f4f5d2021-05-18 16:18:18 -0700699#include <__iterator/iter_swap.h>
Arthur O'Dwyer65077c02022-01-07 09:45:05 -0500700#include <__iterator/iterator.h>
701#include <__iterator/iterator_traits.h>
Konstantin Varlamov73b5c162022-02-17 20:11:46 -0800702#include <__iterator/mergeable.h>
Louis Dionne77249522021-06-11 09:55:11 -0400703#include <__iterator/move_iterator.h>
Arthur O'Dwyer6b240aa2022-01-19 06:26:52 -0500704#include <__iterator/move_sentinel.h>
Christopher Di Bella9c0adab2021-05-08 05:02:43 +0000705#include <__iterator/next.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000706#include <__iterator/ostream_iterator.h>
Arthur O'Dwyer65077c02022-01-07 09:45:05 -0500707#include <__iterator/ostreambuf_iterator.h>
Konstantin Varlamovea9734e2022-02-09 20:32:56 -0800708#include <__iterator/permutable.h>
Christopher Di Bellab8e21042021-05-16 01:39:22 +0000709#include <__iterator/prev.h>
Louis Dionne170a03c2021-04-28 15:02:08 -0400710#include <__iterator/projected.h>
zoecarver61ae1dc2021-04-19 14:28:27 -0400711#include <__iterator/readable_traits.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000712#include <__iterator/reverse_access.h>
Louis Dionne77249522021-06-11 09:55:11 -0400713#include <__iterator/reverse_iterator.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000714#include <__iterator/size.h>
Konstantin Varlamov1755e8d2022-02-17 20:15:02 -0800715#include <__iterator/sortable.h>
zoecarver23001f72021-08-11 11:16:27 -0700716#include <__iterator/unreachable_sentinel.h>
Louis Dionne77249522021-06-11 09:55:11 -0400717#include <__iterator/wrap_iter.h>
Louis Dionne735bc462021-04-14 13:59:03 -0400718#include <__memory/addressof.h>
Arthur O'Dwyer1ac9f092021-01-15 12:59:56 -0500719#include <__memory/pointer_traits.h>
Arthur O'Dwyera2f99ee2021-04-29 17:40:17 -0400720#include <compare>
721#include <concepts> // Mandated by the Standard.
722#include <cstddef>
723#include <initializer_list>
Arthur O'Dwyera2f99ee2021-04-29 17:40:17 -0400724#include <type_traits>
Marshall Clow0a1e7502018-09-12 19:41:40 +0000725#include <version>
Howard Hinnant48fd5d52012-11-14 21:17:15 +0000726
Louis Dionne22355cc2022-06-27 15:53:41 -0400727#ifndef _LIBCPP_REMOVE_TRANSITIVE_INCLUDES
728# include <exception>
729# include <new>
730# include <typeinfo>
731# include <utility>
732#endif
733
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000734#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Arthur O'Dwyer6eeaa002022-02-01 20:16:40 -0500735# pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000736#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000737
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400738#endif // _LIBCPP_ITERATOR