Namespaces
Variants
Views
Actions

std::advance

From cppreference.com
< cpp‎ | iterator
Revision as of 23:04, 31 May 2013 by P12bot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Defined in header <iterator>
template< class InputIt, class Distance >
void advance( InputIt& it, Distance n );

Increments given iterator it by n elements.

If n is negative, the iterator is decremented. In this case, InputIt must meet the requirements of BidirectionalIterator, otherwise the behavior is undefined.

Contents

[edit] Parameters

it - iterator to be advanced
n - number of elements it should be advanced
Type requirements
-
InputIt must meet the requirements of InputIterator.

[edit] Return value

(none)

[edit] Complexity

Linear.

However, if InputIt additionally meets the requirements of RandomAccessIterator, complexity is constant.

[edit] 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

[edit] See also

returns the distance between two iterators
(function) [edit]