std::advance

 

C++

Language

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Iterator library

Iterator primitives
iterator_traits
input_iterator_tag output_iterator_tag forward_iterator_tag bidirectional_iterator_tag random_access_iterator_tag
iterator
Iterator adaptors
reverse_iterator
move_iterator (C++11) back_insert_iterator front_insert_iterator insert_iterator	make_move_iterator (C++11) back_inserter front_inserter inserter
Stream iterators
istream_iterator
ostream_iterator
istreambuf_iterator
ostreambuf_iterator
Iterator operations
advance
distance
prev (C++11)
next (C++11)
Range access
begin (C++11)
end (C++11)

 

Defined in header <iterator>
template< class InputIterator, class Distance > void advance( InputIterator& it, Distance n );

Increments (or decrements if n < 0) given iterator it by n elements.

For random access iterators constant time is required, because operator+ and operator- are used.

Linear time is required for input, forward or bidirectional iterators, since for them operator++ and operator-- are used.

Parameters

it	-	iterator to be advanced
n	-	number of elements it should be advanced. Shall only be negative if it is either a bidirectional or random access iterator.

Return value

(none)

Example

#include <iostream>
#include <iterator>
#include <vector>
 
int main() 
{
    std::vector<int> v{ 3, 1, 4 };
 
    auto vi = v.begin();
 
    std::advance(vi, 2);
 
    std::cout << *vi << '\n';
}

Output:

4

See also

distance	returns the distance between two iterators (function)