blob: 1668be3a60c8e75894604c1d2331083fbea635c5 [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>
141 concept indirectly_copyable = see below; // since C++20
142
143template<class In, class Out>
144 concept indirectly_copyable_storable = see below; // since C++20
145
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 Varlamov73b5c162022-02-17 20:11:46 -0800155// [alg.req.permutable], concept permutable // since C++20
156template<class I>
157 concept permutable = see below;
158
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
zoecarver6eb71a92021-05-27 09:23:19 -0700164template<input_or_output_iterator I, sentinel_for<I> S>
165 requires (!same_as<I, S> && copyable<I>)
166class common_iterator; // since C++20
167
Howard Hinnantc51e1022010-05-11 19:42:16 +0000168template<class Category, class T, class Distance = ptrdiff_t,
169 class Pointer = T*, class Reference = T&>
Louis Dionne8762e2b2021-05-25 18:15:58 -0400170struct iterator // deprecated in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000171{
172 typedef T value_type;
173 typedef Distance difference_type;
174 typedef Pointer pointer;
175 typedef Reference reference;
176 typedef Category iterator_category;
177};
178
179struct input_iterator_tag {};
180struct output_iterator_tag {};
181struct forward_iterator_tag : public input_iterator_tag {};
182struct bidirectional_iterator_tag : public forward_iterator_tag {};
183struct random_access_iterator_tag : public bidirectional_iterator_tag {};
Konstantin Varlamov5eda5022022-02-02 12:53:07 -0800184struct contiguous_iterator_tag : public random_access_iterator_tag {};
Howard Hinnantc51e1022010-05-11 19:42:16 +0000185
Marshall Clow75468e72017-05-17 18:51:36 +0000186// 27.4.3, iterator operations
Louis Dionne45768662020-06-08 16:16:01 -0400187template <class InputIterator, class Distance> // constexpr in C++17
188 constexpr void advance(InputIterator& i, Distance n);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000189
Marshall Clow75468e72017-05-17 18:51:36 +0000190template <class InputIterator> // constexpr in C++17
191 constexpr typename iterator_traits<InputIterator>::difference_type
192 distance(InputIterator first, InputIterator last);
193
194template <class InputIterator> // constexpr in C++17
195 constexpr InputIterator next(InputIterator x,
196typename iterator_traits<InputIterator>::difference_type n = 1);
197
198template <class BidirectionalIterator> // constexpr in C++17
199 constexpr BidirectionalIterator prev(BidirectionalIterator x,
Louis Dionne173f29e2019-05-29 16:01:36 +0000200 typename iterator_traits<BidirectionalIterator>::difference_type n = 1);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000201
Christopher Di Bellac6ead652021-05-05 07:14:08 +0000202// [range.iter.ops], range iterator operations
203namespace ranges {
204 // [range.iter.op.advance], ranges::advance
205 template<input_or_output_iterator I>
206 constexpr void advance(I& i, iter_difference_t<I> n); // since C++20
207 template<input_or_output_iterator I, sentinel_for<I> S>
208 constexpr void advance(I& i, S bound); // since C++20
209 template<input_or_output_iterator I, sentinel_for<I> S>
210 constexpr iter_difference_t<I> advance(I& i, iter_difference_t<I> n, S bound); // since C++20
211}
212
Howard Hinnantc51e1022010-05-11 19:42:16 +0000213template <class Iterator>
214class reverse_iterator
Louis Dionne8762e2b2021-05-25 18:15:58 -0400215 : public iterator<typename iterator_traits<Iterator>::iterator_category, // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000216 typename iterator_traits<Iterator>::value_type,
217 typename iterator_traits<Iterator>::difference_type,
218 typename iterator_traits<Iterator>::pointer,
219 typename iterator_traits<Iterator>::reference>
220{
221protected:
222 Iterator current;
223public:
224 typedef Iterator iterator_type;
225 typedef typename iterator_traits<Iterator>::difference_type difference_type;
226 typedef typename iterator_traits<Iterator>::reference reference;
227 typedef typename iterator_traits<Iterator>::pointer pointer;
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000228
Marshall Clow5ace5542016-10-19 15:12:50 +0000229 constexpr reverse_iterator();
230 constexpr explicit reverse_iterator(Iterator x);
231 template <class U> constexpr reverse_iterator(const reverse_iterator<U>& u);
232 template <class U> constexpr reverse_iterator& operator=(const reverse_iterator<U>& u);
233 constexpr Iterator base() const;
234 constexpr reference operator*() const;
235 constexpr pointer operator->() const;
236 constexpr reverse_iterator& operator++();
237 constexpr reverse_iterator operator++(int);
238 constexpr reverse_iterator& operator--();
239 constexpr reverse_iterator operator--(int);
240 constexpr reverse_iterator operator+ (difference_type n) const;
241 constexpr reverse_iterator& operator+=(difference_type n);
242 constexpr reverse_iterator operator- (difference_type n) const;
243 constexpr reverse_iterator& operator-=(difference_type n);
244 constexpr reference operator[](difference_type n) const;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000245};
246
247template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000248constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000249operator==(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
250
251template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000252constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000253operator<(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
254
255template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000256constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000257operator!=(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
258
259template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000260constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000261operator>(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
262
263template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000264constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000265operator>=(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
266
267template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000268constexpr bool // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000269operator<=(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y);
270
271template <class Iterator1, class Iterator2>
Marshall Clow5ace5542016-10-19 15:12:50 +0000272constexpr auto
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000273operator-(const reverse_iterator<Iterator1>& x, const reverse_iterator<Iterator2>& y)
Marshall Clow5ace5542016-10-19 15:12:50 +0000274-> decltype(__y.base() - __x.base()); // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000275
276template <class Iterator>
Marshall Clow5ace5542016-10-19 15:12:50 +0000277constexpr reverse_iterator<Iterator>
Louis Dionne173f29e2019-05-29 16:01:36 +0000278operator+(typename reverse_iterator<Iterator>::difference_type n,
Marshall Clow5ace5542016-10-19 15:12:50 +0000279 const reverse_iterator<Iterator>& x); // constexpr in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000280
Marshall Clow5ace5542016-10-19 15:12:50 +0000281template <class Iterator>
282constexpr reverse_iterator<Iterator> make_reverse_iterator(Iterator i); // C++14, constexpr in C++17
Marshall Clow6dbbdc92014-03-03 01:24:04 +0000283
Howard Hinnantc51e1022010-05-11 19:42:16 +0000284template <class Container>
285class back_insert_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400286 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000287{
288protected:
289 Container* container;
290public:
291 typedef Container container_type;
292 typedef void value_type;
Louis Dionne3402c3c2021-05-27 12:56:12 -0400293 typedef void difference_type; // until C++20
294 typedef ptrdiff_t difference_type; // since C++20
Eric Fiselier9aeea872016-06-30 04:40:50 +0000295 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000296 typedef void pointer;
297
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500298 explicit back_insert_iterator(Container& x); // constexpr in C++20
299 back_insert_iterator& operator=(const typename Container::value_type& value); // constexpr in C++20
300 back_insert_iterator& operator*(); // constexpr in C++20
301 back_insert_iterator& operator++(); // constexpr in C++20
302 back_insert_iterator operator++(int); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000303};
304
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500305template <class Container> back_insert_iterator<Container> back_inserter(Container& x); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000306
307template <class Container>
308class front_insert_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400309 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000310{
311protected:
312 Container* container;
313public:
314 typedef Container container_type;
315 typedef void value_type;
Louis Dionne3402c3c2021-05-27 12:56:12 -0400316 typedef void difference_type; // until C++20
317 typedef ptrdiff_t difference_type; // since C++20
Eric Fiselier9aeea872016-06-30 04:40:50 +0000318 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000319 typedef void pointer;
320
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500321 explicit front_insert_iterator(Container& x); // constexpr in C++20
322 front_insert_iterator& operator=(const typename Container::value_type& value); // constexpr in C++20
323 front_insert_iterator& operator*(); // constexpr in C++20
324 front_insert_iterator& operator++(); // constexpr in C++20
325 front_insert_iterator operator++(int); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000326};
327
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500328template <class Container> front_insert_iterator<Container> front_inserter(Container& x); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000329
330template <class Container>
331class insert_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400332 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000333{
334protected:
335 Container* container;
336 typename Container::iterator iter;
337public:
338 typedef Container container_type;
339 typedef void value_type;
Louis Dionne3402c3c2021-05-27 12:56:12 -0400340 typedef void difference_type; // until C++20
341 typedef ptrdiff_t difference_type; // since C++20
Eric Fiselier9aeea872016-06-30 04:40:50 +0000342 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000343 typedef void pointer;
344
Arthur O'Dwyer20638cc2021-02-09 19:12:16 -0500345 insert_iterator(Container& x, typename Container::iterator i); // constexpr in C++20
346 insert_iterator& operator=(const typename Container::value_type& value); // constexpr in C++20
347 insert_iterator& operator*(); // constexpr in C++20
348 insert_iterator& operator++(); // constexpr in C++20
349 insert_iterator& operator++(int); // constexpr in C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000350};
351
Konstantin Varlamoveb3faed2022-02-10 18:43:43 -0800352template <class Container>
353insert_iterator<Container> inserter(Container& x, typename Container::iterator i); // until C++20
354template <class Container>
355constexpr insert_iterator<Container> inserter(Container& x, ranges::iterator_t<Container> i); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000356
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000357template <class Iterator>
358class move_iterator {
359public:
360 typedef Iterator iterator_type;
361 typedef typename iterator_traits<Iterator>::difference_type difference_type;
362 typedef Iterator pointer;
363 typedef typename iterator_traits<Iterator>::value_type value_type;
364 typedef typename iterator_traits<Iterator>::iterator_category iterator_category;
365 typedef value_type&& reference;
Louis Dionne173f29e2019-05-29 16:01:36 +0000366
Marshall Clowb5f99122016-11-02 15:30:26 +0000367 constexpr move_iterator(); // all the constexprs are in C++17
368 constexpr explicit move_iterator(Iterator i);
369 template <class U>
370 constexpr move_iterator(const move_iterator<U>& u);
371 template <class U>
372 constexpr move_iterator& operator=(const move_iterator<U>& u);
373 constexpr iterator_type base() const;
374 constexpr reference operator*() const;
375 constexpr pointer operator->() const;
376 constexpr move_iterator& operator++();
377 constexpr move_iterator operator++(int);
378 constexpr move_iterator& operator--();
379 constexpr move_iterator operator--(int);
Louis Dionne173f29e2019-05-29 16:01:36 +0000380 constexpr move_iterator operator+(difference_type n) const;
381 constexpr move_iterator& operator+=(difference_type n);
382 constexpr move_iterator operator-(difference_type n) const;
383 constexpr move_iterator& operator-=(difference_type n);
Marshall Clowb5f99122016-11-02 15:30:26 +0000384 constexpr unspecified operator[](difference_type n) const;
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000385private:
386 Iterator current; // exposition only
387};
388
389template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000390constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000391operator==(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
392
393template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000394constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000395operator!=(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
396
397template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000398constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000399operator<(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
400
401template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000402constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000403operator<=(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
404
405template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000406constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000407operator>(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
408
409template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000410constexpr bool // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000411operator>=(const move_iterator<Iterator1>& x, const move_iterator<Iterator2>& y);
412
413template <class Iterator1, class Iterator2>
Marshall Clowb5f99122016-11-02 15:30:26 +0000414constexpr auto // constexpr in C++17
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000415operator-(const move_iterator<Iterator1>& x,
416 const move_iterator<Iterator2>& y) -> decltype(x.base() - y.base());
417
418template <class Iterator>
Marshall Clowb5f99122016-11-02 15:30:26 +0000419constexpr move_iterator<Iterator> operator+( // constexpr in C++17
Louis Dionne173f29e2019-05-29 16:01:36 +0000420 typename move_iterator<Iterator>::difference_type n,
Marshall Clowb5f99122016-11-02 15:30:26 +0000421 const move_iterator<Iterator>& x);
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000422
Marshall Clowb5f99122016-11-02 15:30:26 +0000423template <class Iterator> // constexpr in C++17
424constexpr move_iterator<Iterator> make_move_iterator(const Iterator& i);
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000425
zoecarver63f13202021-06-01 12:55:33 -0700426// [default.sentinel], default sentinel
427struct default_sentinel_t;
428inline constexpr default_sentinel_t default_sentinel{};
Marshall Clowf8fec4e2016-07-08 16:54:47 +0000429
zoecarverd3aca592021-07-13 11:06:10 -0700430// [iterators.counted], counted iterators
431template<input_or_output_iterator I> class counted_iterator;
432
433template<input_iterator I>
434 requires see below
435 struct iterator_traits<counted_iterator<I>>;
436
zoecarver23001f72021-08-11 11:16:27 -0700437// [unreachable.sentinel], unreachable sentinel
438struct unreachable_sentinel_t;
439inline constexpr unreachable_sentinel_t unreachable_sentinel{};
440
Howard Hinnantc51e1022010-05-11 19:42:16 +0000441template <class T, class charT = char, class traits = char_traits<charT>, class Distance = ptrdiff_t>
442class istream_iterator
Louis Dionne8762e2b2021-05-25 18:15:58 -0400443 : public iterator<input_iterator_tag, T, Distance, const T*, const T&> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000444{
445public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400446 typedef input_iterator_tag iterator_category;
447 typedef T value_type;
448 typedef Distance difference_type;
449 typedef const T* pointer;
450 typedef const T& reference;
451
452 typedef charT char_type;
453 typedef traits traits_type;
454 typedef basic_istream<charT, traits> istream_type;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000455
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800456 istream_iterator(); // constexpr since C++11
457 constexpr istream_iterator(default_sentinel_t); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000458 istream_iterator(istream_type& s);
459 istream_iterator(const istream_iterator& x);
460 ~istream_iterator();
461
462 const T& operator*() const;
463 const T* operator->() const;
464 istream_iterator& operator++();
465 istream_iterator operator++(int);
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800466 friend bool operator==(const istream_iterator& i, default_sentinel_t); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000467};
468
469template <class T, class charT, class traits, class Distance>
470bool operator==(const istream_iterator<T,charT,traits,Distance>& x,
471 const istream_iterator<T,charT,traits,Distance>& y);
472template <class T, class charT, class traits, class Distance>
473bool operator!=(const istream_iterator<T,charT,traits,Distance>& x,
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800474 const istream_iterator<T,charT,traits,Distance>& y); // until C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000475
476template <class T, class charT = char, class traits = char_traits<charT> >
477class ostream_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400478 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000479{
480public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400481 typedef output_iterator_tag iterator_category;
482 typedef void value_type;
483 typedef void difference_type; // until C++20
484 typedef ptrdiff_t difference_type; // since C++20
485 typedef void pointer;
486 typedef void reference;
487
Howard Hinnantc51e1022010-05-11 19:42:16 +0000488 typedef charT char_type;
489 typedef traits traits_type;
490 typedef basic_ostream<charT,traits> ostream_type;
491
492 ostream_iterator(ostream_type& s);
493 ostream_iterator(ostream_type& s, const charT* delimiter);
494 ostream_iterator(const ostream_iterator& x);
495 ~ostream_iterator();
496 ostream_iterator& operator=(const T& value);
497
498 ostream_iterator& operator*();
499 ostream_iterator& operator++();
500 ostream_iterator& operator++(int);
501};
502
503template<class charT, class traits = char_traits<charT> >
504class istreambuf_iterator
Louis Dionne3402c3c2021-05-27 12:56:12 -0400505 : public iterator<input_iterator_tag, charT, traits::off_type, unspecified, charT> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000506{
507public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400508 typedef input_iterator_tag iterator_category;
509 typedef charT value_type;
510 typedef traits::off_type difference_type;
511 typedef unspecified pointer;
512 typedef charT reference;
513
514 typedef charT char_type;
515 typedef traits traits_type;
516 typedef traits::int_type int_type;
517 typedef basic_streambuf<charT, traits> streambuf_type;
518 typedef basic_istream<charT, traits> istream_type;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000519
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800520 istreambuf_iterator() noexcept; // constexpr since C++11
521 constexpr istreambuf_iterator(default_sentinel_t) noexcept; // since C++20
Howard Hinnant011138d2012-07-20 19:36:34 +0000522 istreambuf_iterator(istream_type& s) noexcept;
523 istreambuf_iterator(streambuf_type* s) noexcept;
524 istreambuf_iterator(a-private-type) noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000525
526 charT operator*() const;
527 pointer operator->() const;
528 istreambuf_iterator& operator++();
529 a-private-type operator++(int);
530
531 bool equal(const istreambuf_iterator& b) const;
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800532 friend bool operator==(const istreambuf_iterator& i, default_sentinel_t s); // since C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000533};
534
535template <class charT, class traits>
536bool operator==(const istreambuf_iterator<charT,traits>& a,
537 const istreambuf_iterator<charT,traits>& b);
538template <class charT, class traits>
539bool operator!=(const istreambuf_iterator<charT,traits>& a,
Konstantin Varlamov02f89d52022-02-15 16:59:16 -0800540 const istreambuf_iterator<charT,traits>& b); // until C++20
Howard Hinnantc51e1022010-05-11 19:42:16 +0000541
542template <class charT, class traits = char_traits<charT> >
543class ostreambuf_iterator
Louis Dionne8762e2b2021-05-25 18:15:58 -0400544 : public iterator<output_iterator_tag, void, void, void, void> // until C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +0000545{
546public:
Louis Dionne3402c3c2021-05-27 12:56:12 -0400547 typedef output_iterator_tag iterator_category;
548 typedef void value_type;
549 typedef void difference_type; // until C++20
550 typedef ptrdiff_t difference_type; // since C++20
551 typedef void pointer;
552 typedef void reference;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000553
Louis Dionne3402c3c2021-05-27 12:56:12 -0400554 typedef charT char_type;
555 typedef traits traits_type;
556 typedef basic_streambuf<charT, traits> streambuf_type;
557 typedef basic_ostream<charT, traits> ostream_type;
558
Howard Hinnant011138d2012-07-20 19:36:34 +0000559 ostreambuf_iterator(ostream_type& s) noexcept;
560 ostreambuf_iterator(streambuf_type* s) noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000561 ostreambuf_iterator& operator=(charT c);
562 ostreambuf_iterator& operator*();
563 ostreambuf_iterator& operator++();
564 ostreambuf_iterator& operator++(int);
Howard Hinnant011138d2012-07-20 19:36:34 +0000565 bool failed() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000566};
567
Marshall Clow99ba0022017-01-04 17:58:17 +0000568template <class C> constexpr auto begin(C& c) -> decltype(c.begin());
569template <class C> constexpr auto begin(const C& c) -> decltype(c.begin());
570template <class C> constexpr auto end(C& c) -> decltype(c.end());
571template <class C> constexpr auto end(const C& c) -> decltype(c.end());
572template <class T, size_t N> constexpr T* begin(T (&array)[N]);
573template <class T, size_t N> constexpr T* end(T (&array)[N]);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000574
Marshall Clow99ba0022017-01-04 17:58:17 +0000575template <class C> auto constexpr cbegin(const C& c) -> decltype(std::begin(c)); // C++14
576template <class C> auto constexpr cend(const C& c) -> decltype(std::end(c)); // C++14
577template <class C> auto constexpr rbegin(C& c) -> decltype(c.rbegin()); // C++14
578template <class C> auto constexpr rbegin(const C& c) -> decltype(c.rbegin()); // C++14
579template <class C> auto constexpr rend(C& c) -> decltype(c.rend()); // C++14
580template <class C> constexpr auto rend(const C& c) -> decltype(c.rend()); // C++14
581template <class E> reverse_iterator<const E*> constexpr rbegin(initializer_list<E> il); // C++14
582template <class E> reverse_iterator<const E*> constexpr rend(initializer_list<E> il); // C++14
583template <class T, size_t N> reverse_iterator<T*> constexpr rbegin(T (&array)[N]); // C++14
584template <class T, size_t N> reverse_iterator<T*> constexpr rend(T (&array)[N]); // C++14
585template <class C> constexpr auto crbegin(const C& c) -> decltype(std::rbegin(c)); // C++14
586template <class C> constexpr auto crend(const C& c) -> decltype(std::rend(c)); // C++14
Marshall Clowb278e9c2013-08-30 01:17:07 +0000587
Marshall Clowef357272014-11-19 19:43:23 +0000588// 24.8, container access:
589template <class C> constexpr auto size(const C& c) -> decltype(c.size()); // C++17
590template <class T, size_t N> constexpr size_t size(const T (&array)[N]) noexcept; // C++17
Marshall Clow3c5363e2019-02-27 02:58:56 +0000591
592template <class C> constexpr auto ssize(const C& c)
Arthur O'Dwyer2fc9b5d2021-04-17 17:03:20 -0400593 -> common_type_t<ptrdiff_t, make_signed_t<decltype(c.size())>>; // C++20
Marshall Clow3c5363e2019-02-27 02:58:56 +0000594template <class T, ptrdiff_t> constexpr ptrdiff_t ssize(const T (&array)[N]) noexcept; // C++20
595
Marshall Clowef357272014-11-19 19:43:23 +0000596template <class C> constexpr auto empty(const C& c) -> decltype(c.empty()); // C++17
597template <class T, size_t N> constexpr bool empty(const T (&array)[N]) noexcept; // C++17
598template <class E> constexpr bool empty(initializer_list<E> il) noexcept; // C++17
599template <class C> constexpr auto data(C& c) -> decltype(c.data()); // C++17
600template <class C> constexpr auto data(const C& c) -> decltype(c.data()); // C++17
601template <class T, size_t N> constexpr T* data(T (&array)[N]) noexcept; // C++17
602template <class E> constexpr const E* data(initializer_list<E> il) noexcept; // C++17
603
Howard Hinnantc51e1022010-05-11 19:42:16 +0000604} // std
605
606*/
607
608#include <__config>
Arthur O'Dwyera2f99ee2021-04-29 17:40:17 -0400609#include <__debug>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000610#include <__iterator/access.h>
Christopher Di Bellac6ead652021-05-05 07:14:08 +0000611#include <__iterator/advance.h>
Louis Dionne77249522021-06-11 09:55:11 -0400612#include <__iterator/back_insert_iterator.h>
zoecarver6eb71a92021-05-27 09:23:19 -0700613#include <__iterator/common_iterator.h>
Louis Dionne463afb82021-04-22 11:05:30 -0400614#include <__iterator/concepts.h>
zoecarverd3aca592021-07-13 11:06:10 -0700615#include <__iterator/counted_iterator.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000616#include <__iterator/data.h>
zoecarver63f13202021-06-01 12:55:33 -0700617#include <__iterator/default_sentinel.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000618#include <__iterator/distance.h>
619#include <__iterator/empty.h>
620#include <__iterator/erase_if_container.h>
Louis Dionne77249522021-06-11 09:55:11 -0400621#include <__iterator/front_insert_iterator.h>
zoecarver61ae1dc2021-04-19 14:28:27 -0400622#include <__iterator/incrementable_traits.h>
Nikolas Klauser764ac5e2022-01-04 19:55:37 +0100623#include <__iterator/indirectly_comparable.h>
Louis Dionne77249522021-06-11 09:55:11 -0400624#include <__iterator/insert_iterator.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000625#include <__iterator/istream_iterator.h>
Arthur O'Dwyer65077c02022-01-07 09:45:05 -0500626#include <__iterator/istreambuf_iterator.h>
Louis Dionneca989a52021-04-20 14:40:43 -0400627#include <__iterator/iter_move.h>
zoecarver31f4f5d2021-05-18 16:18:18 -0700628#include <__iterator/iter_swap.h>
Arthur O'Dwyer65077c02022-01-07 09:45:05 -0500629#include <__iterator/iterator.h>
630#include <__iterator/iterator_traits.h>
Konstantin Varlamov73b5c162022-02-17 20:11:46 -0800631#include <__iterator/mergeable.h>
Louis Dionne77249522021-06-11 09:55:11 -0400632#include <__iterator/move_iterator.h>
Christopher Di Bella9c0adab2021-05-08 05:02:43 +0000633#include <__iterator/next.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000634#include <__iterator/ostream_iterator.h>
Arthur O'Dwyer65077c02022-01-07 09:45:05 -0500635#include <__iterator/ostreambuf_iterator.h>
Konstantin Varlamovea9734e2022-02-09 20:32:56 -0800636#include <__iterator/permutable.h>
Christopher Di Bellab8e21042021-05-16 01:39:22 +0000637#include <__iterator/prev.h>
Louis Dionne170a03c2021-04-28 15:02:08 -0400638#include <__iterator/projected.h>
zoecarver61ae1dc2021-04-19 14:28:27 -0400639#include <__iterator/readable_traits.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000640#include <__iterator/reverse_access.h>
Louis Dionne77249522021-06-11 09:55:11 -0400641#include <__iterator/reverse_iterator.h>
Christopher Di Bellac7674cd2021-06-29 02:32:59 +0000642#include <__iterator/size.h>
zoecarver23001f72021-08-11 11:16:27 -0700643#include <__iterator/unreachable_sentinel.h>
Louis Dionne77249522021-06-11 09:55:11 -0400644#include <__iterator/wrap_iter.h>
Louis Dionne735bc462021-04-14 13:59:03 -0400645#include <__memory/addressof.h>
Arthur O'Dwyer1ac9f092021-01-15 12:59:56 -0500646#include <__memory/pointer_traits.h>
Arthur O'Dwyera2f99ee2021-04-29 17:40:17 -0400647#include <compare>
648#include <concepts> // Mandated by the Standard.
649#include <cstddef>
650#include <initializer_list>
Arthur O'Dwyera2f99ee2021-04-29 17:40:17 -0400651#include <type_traits>
Arthur O'Dwyer3693d7a2022-02-04 13:09:30 -0500652#include <utility>
Marshall Clow0a1e7502018-09-12 19:41:40 +0000653#include <version>
Howard Hinnant48fd5d52012-11-14 21:17:15 +0000654
Nikolas Klauser4c1bf592022-02-11 19:15:18 +0100655// TODO: remove these headers
656#include <__functional/binary_function.h>
657#include <__functional/invoke.h>
658#include <__functional/operations.h>
659#include <__functional/reference_wrapper.h>
660#include <__functional/unary_function.h>
661#include <__functional/weak_result_type.h>
662#include <__memory/allocator_arg_t.h>
663#include <__memory/uses_allocator.h>
664#include <exception>
665#include <new>
666#include <typeinfo>
667
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000668#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Arthur O'Dwyer6eeaa002022-02-01 20:16:40 -0500669# pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +0000670#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000671
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400672#endif // _LIBCPP_ITERATOR