std::ranges::subrange<I,S,K>::advance
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Ranges library
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++26)(C++26)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)
(C++23)(C++23)
(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)(C++23)
(C++23)
std::ranges::subrange
subrange::advance
constexpr subrange& advance( std::iter_difference_t <I> n );
(since C++20)
Increments or decrements begin_ :
- If
Imodelsbidirectional_iteratorand n < 0 is true, decrementsbegin_by -n elements.
- Equivalent to: ranges::advance (
begin_, n);
if constexpr (StoreSize)size_+=to-unsigned-like(-n);
return *this;.
- Equivalent to: auto d = n - ranges::advance (
begin_, n,end_);
if constexpr (StoreSize)size_-=to-unsigned-like(d);
return *this;.
According to the preconditions of ranges::advance , if n < 0 is true and begin_ cannot be decremented by -n elements, the behavior is undefined.
[edit] Parameters
n
-
number of maximal increments of the iterator
[edit] Return value
*this
[edit] Example
Run this code
#include <algorithm> #include <array> #include <iostream> #include <iterator> #include <ranges> void print(auto name, auto const sub) { std::cout << name << ".size() == " << sub.size() << "; { "; std::ranges::for_each (sub, [](int x) { std::cout << x << ' '; }); std::cout << "}\n"; }; int main() { std::array arr{1, 2, 3, 4, 5, 6, 7}; std::ranges::subrange sub{std::next (arr.begin()), std::prev (arr.end())}; print("1) sub", sub); print("2) sub", sub.advance(3)); print("3) sub", sub.advance(-2)); }
Output:
1) sub.size() == 5; { 2 3 4 5 6 }
2) sub.size() == 2; { 5 6 }
3) sub.size() == 4; { 3 4 5 6 }[edit] Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
| DR | Applied to | Behavior as published | Correct behavior |
|---|---|---|---|
| LWG 3433 | C++20 | the behavior was undefined if n < 0 | made well-defined if begin_ can be decremented
|
[edit] See also
obtains a copy of the
(public member function) [edit]
subrange with its iterator advanced by a given distance (public member function) [edit]
obtains a copy of the
(public member function) [edit]
subrange with its iterator decremented by a given distance (public member function) [edit]