22 Iterators library [iterators]

22.4 Iterator primitives [iterator.primitives]

22.4.3 Range iterator operations [range.iter.ops]

22.4.3.1 ranges​::​advance [range.iter.op.advance]

🔗
template<Iterator I> constexpr void ranges::advance(I& i, iter_difference_t<I> n);
1
#
Expects: If I does not model BidirectionalIterator, n is not negative.
2
#
Effects:
  • (2.1)
    If I models RandomAccessIterator, equivalent to i += n.
  • (2.2)
    Otherwise, if n is non-negative, increments i by n.
  • (2.3)
    Otherwise, decrements i by -n.
🔗
template<Iterator I, Sentinel<I> S> constexpr void ranges::advance(I& i, S bound);
3
#
Expects: [i, bound) denotes a range.
4
#
Effects:
  • (4.1)
    If I and S model Assignable<I&, S>, equivalent to i = std::move(bound).
  • (4.2)
    Otherwise, if S and I model SizedSentinel<S, I>, equivalent to ranges::advance(i, bound - i).
  • (4.3)
    Otherwise, while bool(i != bound) is true, increments i.
🔗
template<Iterator I, Sentinel<I> S> constexpr iter_difference_t<I> ranges::advance(I& i, iter_difference_t<I> n, S bound);
5
#
Expects: If n > 0, [i, bound) denotes a range.
If n == 0, [i, bound) or [bound, i) denotes a range.
If n < 0, [bound, i) denotes a range, I models BidirectionalIterator, and I and S model Same<I, S>.
6
#
Effects:
  • (6.1)
    If S and I model SizedSentinel<S, I>:
    • (6.1.1)
      If ​, equivalent to ranges::advance(i, bound).
    • (6.1.2)
      Otherwise, equivalent to ranges::advance(i, n).
  • (6.2)
    Otherwise,
    • (6.2.1)
      if n is non-negative, while bool(i != bound) is true, increments i but at most n times.
    • (6.2.2)
      Otherwise, while bool(i != bound) is true, decrements i but at most -n times.
7
#
Returns: n - M, where M is the difference between the ending and starting positions of i.