cppdraft_translate/cppdraft/range/stride/iterator.md

[range.stride.iterator]

25 Ranges library [ranges]

25.7 Range adaptors [range.adaptors]

25.7.32 Stride view [range.stride]

25.7.32.3 Class template stride_view​::​iterator [range.stride.iterator]

🔗

namespace std::ranges {template<input_range V>requires viewtemplateclass stride_view::iterator {using Parent = maybe-const<Const, stride_view>; // exposition onlyusing Base = maybe-const<Const, V>; // exposition only iterator_t<Base> current_ = iterator_t<Base>(); // exposition only sentinel_t<Base> end_ = sentinel_t<Base>(); // exposition only range_difference_t<Base> stride_ = 0; // exposition only range_difference_t<Base> missing_ = 0; // exposition onlyconstexpr iterator(Parent* parent, iterator_t<Base> current, // exposition only range_difference_t<Base> missing = 0); public:using difference_type = range_difference_t<Base>; using value_type = range_value_t<Base>; using iterator_concept = see below; using iterator_category = see below; // not always presentiterator() requires default_initializable<iterator_t<Base>> = default; constexpr iterator(iterator other)requires Const && convertible_to<iterator_t, iterator_t<Base>>&& convertible_to<sentinel_t, sentinel_t<Base>>; constexpr iterator_t<Base> base() &&; constexpr const iterator_t<Base>& base() const & noexcept; constexpr decltype(auto) operator*() const { return **current_*; }constexpr iterator& operator++(); constexpr void operator++(int); constexpr iterator operator++(int) requires forward_range<Base>; constexpr iterator& operator--() requires bidirectional_range<Base>; constexpr iterator operator--(int) requires bidirectional_range<Base>; constexpr iterator& operator+=(difference_type n) requires random_access_range<Base>; constexpr iterator& operator-=(difference_type n) requires random_access_range<Base>; constexpr decltype(auto) operator[](difference_type n) constrequires random_access_range<Base>{ return *(*this + n); }friend constexpr bool operator==(const iterator& x, default_sentinel_t); friend constexpr bool operator==(const iterator& x, const iterator& y)requires equality_comparable<iterator_t<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 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& x, difference_type n)requires random_access_range<Base>; friend constexpr iterator operator+(difference_type n, const iterator& x)requires random_access_range<Base>; friend constexpr iterator operator-(const iterator& x, 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 difference_type operator-(default_sentinel_t y, const iterator& x)requires sized_sentinel_for<sentinel_t<Base>, iterator_t<Base>>; friend constexpr difference_type operator-(const iterator& x, default_sentinel_t y)requires sized_sentinel_for<sentinel_t<Base>, iterator_t<Base>>; friend constexpr range_rvalue_reference_t<Base> iter_move(const iterator& i)noexcept(noexcept(ranges::iter_move(i.current_))); friend constexpr void iter_swap(const iterator& x, const iterator& y)noexcept(noexcept(ranges::iter_swap(x.current_, y.current_)))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, if Base models forward_range, then iterator_concept denotes forward_iterator_tag.

• (1.4)

  Otherwise, iterator_concept denotes input_iterator_tag.

2

#

The member typedef-name iterator_category is defined if and only if Base models forward_range.

In that case,iterator​::​iterator_category is defined as follows:

• (2.1)

  Let C denote the type iterator_traits<iterator_t<Base>>​::​iterator_category.

• (2.2)

  If C modelsderived_from<random_access_iterator_tag>, then iterator_category denotes random_access_iterator_tag.

• (2.3)

  Otherwise, iterator_category denotes C.

🔗

constexpr iterator(Parent* parent, iterator_t<Base> current, range_difference_t<Base> missing = 0);

3

#

Effects: Initializes current_ with std​::​move(current),end_ with ranges​::​end(parent->base_),stride_ with parent->stride_, andmissing_ with missing.

🔗

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>> && [convertible_to](concept.convertible#concept:convertible_to "18.4.4 Concept convertible_­to [concept.convertible]")<sentinel_t<V>, sentinel_t<Base>>;

4

#

Effects: Initializes current_ with std​::​move(i.current_),end_ with std​::​move(i.end_),stride_ with i.stride_, andmissing_ with i.missing_.

🔗

constexpr iterator_t<Base> base() &&;

5

#

Returns: std​::​move(current_).

🔗

constexpr const iterator_t<Base>& base() const & noexcept;

6

#

Returns: current_.

🔗

constexpr iterator& operator++();

7

#

Preconditions: current_ != end_ is true.

8

#

Effects: Equivalent to:missing_ = ranges::advance(current_, stride_, end_);return *this;

🔗

constexpr void operator++(int);

9

#

Effects: Equivalent to ++*this;

🔗

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

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

#

Effects: Equivalent to:ranges::advance(current_, missing_ - stride_);missing_ = 0;return *this;

🔗

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

12

#

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

🔗

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

13

#

Preconditions: If n is positive,ranges​::​distance(current_, end_) > stride_ * (n - 1) is true.

[Note 1:

If n is negative, the Effects paragraph implies a precondition.

— end note]

14

#

Effects: Equivalent to:if (n > 0) { ranges::advance(current_, stride_ * (n - 1)); missing_ = ranges::advance(current_, stride_, end_);} else if (n < 0) { ranges::advance(current_, stride_ * n + missing_); missing_ = 0;}return *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>;

15

#

Effects: Equivalent to: return *this += -x;

🔗

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

16

#

Returns: x.current_ == x.end_.

🔗

friend constexpr bool operator==(const iterator& x, const iterator& y) requires [equality_comparable](concept.equalitycomparable#concept:equality_comparable "18.5.4 Concept equality_­comparable [concept.equalitycomparable]")<iterator_t<Base>>;

17

#

Returns: x.current_ == y.current_.

🔗

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>;

18

#

Returns: x.current_ < y.current_.

🔗

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>;

19

#

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>;

20

#

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>;

21

#

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>>;

22

#

Returns: x.current_ <=> y.current_.

🔗

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>;

23

#

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>;

24

#

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>>;

25

#

Returns: Let N be (x.current_ - y.current_).

• (25.1)

  If Base models forward_range,(N + x.missing_ - y.missing_) / x.stride_.

• (25.2)

  Otherwise, if N is negative, -div-ceil(-N, x.stride_).

• (25.3)

  Otherwise, div-ceil(N, x.stride_).

🔗

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

26

#

Returns: div-ceil(x.end_ - x.current_, x.stride_).

🔗

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

27

#

Effects: Equivalent to: return -(y - x);

🔗

friend constexpr range_rvalue_reference_t<Base> iter_move(const iterator& i) noexcept(noexcept(ranges::iter_move(i.current_)));

28

#

Effects: Equivalent to: return ranges​::​iter_move(i.current_);

🔗

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

29

#

Effects: Equivalent to:ranges​::​iter_swap(x.current_, y.current_);