std::prev

 

C++

Language

Standard library headers

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 BidirIt > BidirIt prev( BidirIt it,               typename std::iterator_traits<BidirIt>::difference_type n = 1 );		(since C++11)

Return the nth predecessor of iterator it.

Parameters

it	-	an iterator
n	-	number of elements it should be descended
Type requirements
- BidirIt must meet the requirements of BidirectionalIterator.

Return value

The nth predecessor of iterator it.

Possible implementation

template<class BidirIt> BidirIt prev(BidirIt it, typename std::iterator_traits<BidirIt>::difference_type n = 1) { std::advance(it, -n); return it; }

Example

run this code

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

Output:

1

See also

next (C++11)	increment an iterator (function)
advance	advances an iterator by given distance (function)