cppdraft_translate/cppdraft/range/adjacent/iterator.md

[range.adjacent.iterator]

25 Ranges library [ranges]

25.7 Range adaptors [range.adaptors]

25.7.27 Adjacent view [range.adjacent]

25.7.27.3 Class template adjacent_view​::​iterator [range.adjacent.iterator]

🔗

namespace std::ranges {template<forward_range V, size_t N>requires view && (N > 0)templateclass adjacent_view<V, N>::iterator {using Base = maybe-const<Const, V>; // exposition only array<iterator_t<Base>, N> current_ = array<iterator_t<Base>, N>(); // exposition onlyconstexpr iterator(iterator_t<Base> first, sentinel_t<Base> last); // exposition onlyconstexpr iterator(as-sentinel, iterator_t<Base> first, iterator_t<Base> last); // exposition onlypublic:using iterator_category = input_iterator_tag; using iterator_concept = see below; using value_type = tuple<REPEAT(range_value_t<Base>, N)...>; using difference_type = range_difference_t<Base>; iterator() = default; constexpr iterator(iterator i)requires Const && convertible_to<iterator_t, iterator_t<Base>>; constexpr auto operator*() const; constexpr iterator& operator++(); constexpr iterator operator++(int); constexpr iterator& operator--() requires bidirectional_range<Base>; constexpr iterator operator--(int) requires bidirectional_range<Base>; constexpr iterator& operator+=(difference_type x)requires random_access_range<Base>; constexpr iterator& operator-=(difference_type x)requires random_access_range<Base>; constexpr auto operator[](difference_type n) constrequires random_access_range<Base>; friend constexpr bool operator==(const iterator& x, const iterator& y); friend constexpr bool operator<(const iterator& x, const iterator& y)requires random_access_range<Base>; friend constexpr bool operator>(const iterator& x, const iterator& y)requires random_access_range<Base>; friend constexpr bool operator<=(const iterator& x, const iterator& y)requires random_access_range<Base>; friend constexpr bool operator>=(const iterator& x, const iterator& y)requires random_access_range<Base>; friend constexpr auto operator<=>(const iterator& x, const iterator& y)requires random_access_range<Base> &&three_way_comparable<iterator_t<Base>>; friend constexpr iterator operator+(const iterator& i, difference_type n)requires random_access_range<Base>; friend constexpr iterator operator+(difference_type n, const iterator& i)requires random_access_range<Base>; friend constexpr iterator operator-(const iterator& i, difference_type n)requires random_access_range<Base>; friend constexpr difference_type operator-(const iterator& x, const iterator& y)requires sized_sentinel_for<iterator_t<Base>, iterator_t<Base>>; friend constexpr auto iter_move(const iterator& i) noexcept(see below); friend constexpr void iter_swap(const iterator& l, const iterator& r) noexcept(see below)requires indirectly_swappable<iterator_t<Base>>; };}

1

#

iterator​::​iterator_concept is defined as follows:

• (1.1)

  If Base models random_access_range, then iterator_concept denotes random_access_iterator_tag.

• (1.2)

  Otherwise, if Base models bidirectional_range, then iterator_concept denotes bidirectional_iterator_tag.

• (1.3)

  Otherwise, iterator_concept denotes forward_iterator_tag.

2

#

If the invocation of any non-const member function of iterator exits via an exception, the iterator acquires a singular value.

🔗

constexpr iterator(iterator_t<Base> first, sentinel_t<Base> last);

3

#

Postconditions: current_[0] == first is true, and for every integer 1≤i<N,current_[i] == ranges​::​next(current_[i-1], 1, last) is true.

🔗

constexpr iterator(as-sentinel, iterator_t<Base> first, iterator_t<Base> last);

4

#

Postconditions: If Base does not model bidirectional_range, each element of current_ is equal to last.

Otherwise, current_[N-1] == last is true, and for every integer 0≤i<(N−1),current_[i] == ranges​::​prev(current_[i+1], 1, first) is true.

🔗

constexpr iterator(iterator<!Const> i) requires Const && [convertible_to](concept.convertible#concept:convertible_to "18.4.4 Concept convertible_­to [concept.convertible]")<iterator_t<V>, iterator_t<Base>>;

5

#

Effects: Initializes each element of current_ with the corresponding element of i.current_ as an xvalue.

🔗

constexpr auto operator*() const;

6

#

Effects: Equivalent to:return tuple-transform([](auto& i) -> decltype(auto) { return *i; }, current_);

🔗

constexpr iterator& operator++();

7

#

Preconditions: current_.back() is incrementable.

8

#

Postconditions: Each element of current_ is equal to ranges​::​next(i), where i is the value of that element before the call.

9

#

Returns: *this.

🔗

constexpr iterator operator++(int);

10

#

Effects: Equivalent to:auto tmp = *this;++*this;return tmp;

🔗

constexpr iterator& operator--() requires [bidirectional_range](range.refinements#concept:bidirectional_range "25.4.6 Other range refinements [range.refinements]")<Base>;

11

#

Preconditions: current_.front() is decrementable.

12

#

Postconditions: Each element of current_ is equal to ranges​::​prev(i), where i is the value of that element before the call.

13

#

Returns: *this.

🔗

constexpr iterator operator--(int) requires [bidirectional_range](range.refinements#concept:bidirectional_range "25.4.6 Other range refinements [range.refinements]")<Base>;

14

#

Effects: Equivalent to:auto tmp = *this;--*this;return tmp;

🔗

constexpr iterator& operator+=(difference_type x) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

15

#

Preconditions: current_.back() + x has well-defined behavior.

16

#

Postconditions: Each element of current_ is equal to i + x, where i is the value of that element before the call.

17

#

Returns: *this.

🔗

constexpr iterator& operator-=(difference_type x) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

18

#

Preconditions: current_.front() - x has well-defined behavior.

19

#

Postconditions: Each element of current_ is equal to i - x, where i is the value of that element before the call.

20

#

Returns: *this.

🔗

constexpr auto operator[](difference_type n) const requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

21

#

Effects: Equivalent to:return tuple-transform([&](auto& i) -> decltype(auto) { return i[n]; }, current_);

🔗

friend constexpr bool operator==(const iterator& x, const iterator& y);

22

#

Returns: x.current_.back() == y.current_.back().

🔗

friend constexpr bool operator<(const iterator& x, const iterator& y) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

23

#

Returns: x.current_.back() < y.current_.back().

🔗

friend constexpr bool operator>(const iterator& x, const iterator& y) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

24

#

Effects: Equivalent to: return y < x;

🔗

friend constexpr bool operator<=(const iterator& x, const iterator& y) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

25

#

Effects: Equivalent to: return !(y < x);

🔗

friend constexpr bool operator>=(const iterator& x, const iterator& y) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

26

#

Effects: Equivalent to: return !(x < y);

🔗

friend constexpr auto operator<=>(const iterator& x, const iterator& y) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base> && [three_way_comparable](cmp.concept#concept:three_way_comparable "17.12.4 Concept three_­way_­comparable [cmp.concept]")<iterator_t<Base>>;

27

#

Returns: x.current_.back() <=> y.current_.back().

🔗

friend constexpr iterator operator+(const iterator& i, difference_type n) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>; friend constexpr iterator operator+(difference_type n, const iterator& i) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

28

#

Effects: Equivalent to:auto r = i; r += n;return r;

🔗

friend constexpr iterator operator-(const iterator& i, difference_type n) requires [random_access_range](range.refinements#concept:random_access_range "25.4.6 Other range refinements [range.refinements]")<Base>;

29

#

Effects: Equivalent to:auto r = i; r -= n;return r;

🔗

friend constexpr difference_type operator-(const iterator& x, const iterator& y) requires [sized_sentinel_for](iterator.concept.sizedsentinel#concept:sized_sentinel_for "24.3.4.8 Concept sized_­sentinel_­for [iterator.concept.sizedsentinel]")<iterator_t<Base>, iterator_t<Base>>;

30

#

Effects: Equivalent to:return x.current_.back() - y.current_.back();

🔗

friend constexpr auto iter_move(const iterator& i) noexcept(see below);

31

#

Effects: Equivalent to:return tuple-transform(ranges​::​iter_move, i.current_);

32

#

Remarks: The exception specification is equivalent to:noexcept(ranges::iter_move(declval<const iterator_t<Base>&>())) && is_nothrow_move_constructible_v<range_rvalue_reference_t<Base>>

🔗

friend constexpr void iter_swap(const iterator& l, const iterator& r) noexcept(see below) requires [indirectly_swappable](alg.req.ind.swap#concept:indirectly_swappable "24.3.7.4 Concept indirectly_­swappable [alg.req.ind.swap]")<iterator_t<Base>>;

33

#

Preconditions: None of the iterators in l.current_ is equal to an iterator in r.current_.

34

#

Effects: For every integer 0≤i<N, performsranges​::​iter_swap(l.current_[i], r.current_[i]).

35

#

Remarks: The exception specification is equivalent to:noexcept(ranges::iter_swap(declval<iterator_t<Base>>(), declval<iterator_t<Base>>()))