23 Iterators library [iterators]

23.5 Iterator adaptors [predef.iterators]

23.5.6 Counted iterators [iterators.counted]

23.5.6.1 Class template counted_­iterator [counted.iterator]

1
#
Class template counted_­iterator is an iterator adaptor with the same behavior as the underlying iterator except that it keeps track of the distance to the end of its range.
It can be used together with default_­sentinel in calls to generic algorithms to operate on a range of N elements starting at a given position without needing to know the end position a priori.
2
#
[Example 1: list<string> s; // populate the list s with at least 10 strings vector<string> v; // copies 10 strings into v: ranges::copy(counted_iterator(s.begin(), 10), default_sentinel, back_inserter(v)); — end example]
3
#
Two values i1 and i2 of types counted_­iterator<I1> and counted_­iterator<I2> refer to elements of the same sequence if and only if next(i1.base(), i1.count()) and next(i2.base(), i2.count()) refer to the same (possibly past-the-end) element.
namespace std { template<input_­or_­output_­iterator I> class counted_iterator { public: using iterator_type = I; constexpr counted_iterator() = default; constexpr counted_iterator(I x, iter_difference_t<I> n); template<class I2> requires convertible_­to<const I2&, I> constexpr counted_iterator(const counted_iterator<I2>& x); template<class I2> requires assignable_­from<I&, const I2&> constexpr counted_iterator& operator=(const counted_iterator<I2>& x); constexpr I base() const & requires copy_constructible<I>; constexpr I base() &&; constexpr iter_difference_t<I> count() const noexcept; constexpr decltype(auto) operator*(); constexpr decltype(auto) operator*() const requires dereferenceable<const I>; constexpr counted_iterator& operator++(); decltype(auto) operator++(int); constexpr counted_iterator operator++(int) requires forward_­iterator<I>; constexpr counted_iterator& operator--() requires bidirectional_­iterator<I>; constexpr counted_iterator operator--(int) requires bidirectional_­iterator<I>; constexpr counted_iterator operator+(iter_difference_t<I> n) const requires random_­access_­iterator<I>; friend constexpr counted_iterator operator+( iter_difference_t<I> n, const counted_iterator& x) requires random_­access_­iterator<I>; constexpr counted_iterator& operator+=(iter_difference_t<I> n) requires random_­access_­iterator<I>; constexpr counted_iterator operator-(iter_difference_t<I> n) const requires random_­access_­iterator<I>; template<common_­with<I> I2> friend constexpr iter_difference_t<I2> operator-( const counted_iterator& x, const counted_iterator<I2>& y); friend constexpr iter_difference_t<I> operator-( const counted_iterator& x, default_sentinel_t); friend constexpr iter_difference_t<I> operator-( default_sentinel_t, const counted_iterator& y); constexpr counted_iterator& operator-=(iter_difference_t<I> n) requires random_­access_­iterator<I>; constexpr decltype(auto) operator[](iter_difference_t<I> n) const requires random_­access_­iterator<I>; template<common_­with<I> I2> friend constexpr bool operator==( const counted_iterator& x, const counted_iterator<I2>& y); friend constexpr bool operator==( const counted_iterator& x, default_sentinel_t); template<common_­with<I> I2> friend constexpr strong_ordering operator<=>( const counted_iterator& x, const counted_iterator<I2>& y); friend constexpr iter_rvalue_reference_t<I> iter_move(const counted_iterator& i) noexcept(noexcept(ranges::iter_move(i.current))) requires input_­iterator<I>; template<indirectly_­swappable<I> I2> friend constexpr void iter_swap(const counted_iterator& x, const counted_iterator<I2>& y) noexcept(noexcept(ranges::iter_swap(x.current, y.current))); private: I current = I(); // exposition only iter_difference_t<I> length = 0; // exposition only }; template<class I> struct incrementable_traits<counted_iterator<I>> { using difference_type = iter_difference_t<I>; }; template<input_­iterator I> struct iterator_traits<counted_iterator<I>> : iterator_traits<I> { using pointer = void; }; }

23.5.6.2 Constructors and conversions [counted.iter.const]

🔗
constexpr counted_iterator(I i, iter_difference_t<I> n);
1
#
Preconditions: n >= 0.
2
#
Effects: Initializes current with std​::​move(i) and length with n.
🔗
template<class I2> requires convertible_­to<const I2&, I> constexpr counted_iterator(const counted_iterator<I2>& x);
3
#
Effects: Initializes current with x.current and length with x.length.
🔗
template<class I2> requires assignable_­from<I&, const I2&> constexpr counted_iterator& operator=(const counted_iterator<I2>& x);
4
#
Effects: Assigns x.current to current and x.length to length.
5
#
Returns: *this.

23.5.6.3 Accessors [counted.iter.access]

🔗
constexpr I base() const & requires copy_constructible<I>;
1
#
Effects: Equivalent to: return current;
🔗
constexpr I base() &&;
2
#
Returns: std​::​move(current).
🔗
constexpr iter_difference_t<I> count() const noexcept;
3
#
Effects: Equivalent to: return length;

23.5.6.4 Element access [counted.iter.elem]

🔗
constexpr decltype(auto) operator*(); constexpr decltype(auto) operator*() const requires dereferenceable<const I>;
1
#
Effects: Equivalent to: return *current;
🔗
constexpr decltype(auto) operator[](iter_difference_t<I> n) const requires random_­access_­iterator<I>;
2
#
Preconditions: n < length.
3
#
Effects: Equivalent to: return current[n];

23.5.6.5 Navigation [counted.iter.nav]

🔗
constexpr counted_iterator& operator++();
1
#
Preconditions: length > 0.
2
#
Effects: Equivalent to: ++current; --length; return *this;
🔗
decltype(auto) operator++(int);
3
#
Preconditions: length > 0.
4
#
Effects: Equivalent to: --length; try { return current++; } catch(...) { ++length; throw; }
🔗
constexpr counted_iterator operator++(int) requires forward_­iterator<I>;
5
#
Effects: Equivalent to: counted_iterator tmp = *this; ++*this; return tmp;
🔗
constexpr counted_iterator& operator--() requires bidirectional_­iterator<I>;
6
#
Effects: Equivalent to: --current; ++length; return *this;
🔗
constexpr counted_iterator operator--(int) requires bidirectional_­iterator<I>;
7
#
Effects: Equivalent to: counted_iterator tmp = *this; --*this; return tmp;
🔗
constexpr counted_iterator operator+(iter_difference_t<I> n) const requires random_­access_­iterator<I>;
8
#
Effects: Equivalent to: return counted_­iterator(current + n, length - n);
🔗
friend constexpr counted_iterator operator+( iter_difference_t<I> n, const counted_iterator& x) requires random_­access_­iterator<I>;
9
#
Effects: Equivalent to: return x + n;
🔗
constexpr counted_iterator& operator+=(iter_difference_t<I> n) requires random_­access_­iterator<I>;
10
#
Preconditions: n <= length.
11
#
Effects: Equivalent to: current += n; length -= n; return *this;
🔗
constexpr counted_iterator operator-(iter_difference_t<I> n) const requires random_­access_­iterator<I>;
12
#
Effects: Equivalent to: return counted_­iterator(current - n, length + n);
🔗
template<common_­with<I> I2> friend constexpr iter_difference_t<I2> operator-( const counted_iterator& x, const counted_iterator<I2>& y);
13
#
Preconditions: x and y refer to elements of the same sequence ([counted.iterator]).
14
#
Effects: Equivalent to: return y.length - x.length;
🔗
friend constexpr iter_difference_t<I> operator-( const counted_iterator& x, default_sentinel_t);
15
#
Effects: Equivalent to: return -x.length;
🔗
friend constexpr iter_difference_t<I> operator-( default_sentinel_t, const counted_iterator& y);
16
#
Effects: Equivalent to: return y.length;
🔗
constexpr counted_iterator& operator-=(iter_difference_t<I> n) requires random_­access_­iterator<I>;
17
#
Preconditions: -n <= length.
18
#
Effects: Equivalent to: current -= n; length += n; return *this;

23.5.6.6 Comparisons [counted.iter.cmp]

🔗
template<common_­with<I> I2> friend constexpr bool operator==( const counted_iterator& x, const counted_iterator<I2>& y);
1
#
Preconditions: x and y refer to elements of the same sequence ([counted.iterator]).
2
#
Effects: Equivalent to: return x.length == y.length;
🔗
friend constexpr bool operator==( const counted_iterator& x, default_sentinel_t);
3
#
Effects: Equivalent to: return x.length == 0;
🔗
template<common_­with<I> I2> friend constexpr strong_ordering operator<=>( const counted_iterator& x, const counted_iterator<I2>& y);
4
#
Preconditions: x and y refer to elements of the same sequence ([counted.iterator]).
5
#
Effects: Equivalent to: return y.length <=> x.length;
6
#
[Note 1:
The argument order in the Effects: element is reversed because length counts down, not up.
— end note]

23.5.6.7 Customizations [counted.iter.cust]

🔗
friend constexpr iter_rvalue_reference_t<I> iter_move(const counted_iterator& i) noexcept(noexcept(ranges::iter_move(i.current))) requires input_­iterator<I>;
1
#
Effects: Equivalent to: return ranges​::​iter_­move(i.current);
🔗
template<indirectly_­swappable<I> I2> friend constexpr void iter_swap(const counted_iterator& x, const counted_iterator<I2>& y) noexcept(noexcept(ranges::iter_swap(x.current, y.current)));
2
#
Effects: Equivalent to ranges​::​iter_­swap(x.current, y.current).