std::iterator_traits
Defined in header <iterator> | ||
---|---|---|
template< class Iter > struct iterator_traits; | ||
template< class T > struct iterator_traits<T*>; | ||
template< class T > struct iterator_traits<const T*>; | (until C++20) |
std::iterator_traits
is the type trait class that provides uniform interface to the properties of LegacyIterator types. This makes it possible to implement algorithms only in terms of iterators.
The class defines the following types:
-
difference_type
- a signed integer type that can be used to identify distance between iterators -
value_type
- the type of the values that can be obtained by dereferencing the iterator. This type isvoid
for output iterators. -
pointer
- defines a pointer to the type iterated over (value_type
) -
reference
- defines a reference to the type iterated over (value_type
) -
iterator_category
- the category of the iterator. Must be one of iterator category tags.
The template can be specialized for user-defined iterators so that the information about the iterator can be retrieved even if the type does not provide the usual typedefs.
User specializations may define the member type | (since C++20) |
Template parameters
Iter | - | the iterator type to retrieve properties for |
Member types
Member type | Definition |
---|---|
difference_type | Iter::difference_type |
value_type | Iter::value_type |
pointer | Iter::pointer |
reference | Iter::reference |
iterator_category | Iter::iterator_category |
If |
(since C++17) (until C++20) |
||||||||||||||||||||||||||||||||||||
If
Otherwise, if
Otherwise, if
Otherwise, this template has no members by any of those names ( | (since C++20) |
Specializations
This type trait may be specialized for user-provided types that may be used as iterators. The standard library provides two partial specializations for pointer types T*, which makes it possible to use all iterator-based algorithms with raw pointers.
T*
specialization member types
Only specialized if | (since C++20) |
Member type | Definition |
---|---|
difference_type | std::ptrdiff_t |
value_type | T (until C++20)std::remove_cv_t<T> (since C++20) |
pointer | T* |
reference | T& |
iterator_category | std::random_access_iterator_tag |
iterator_concept (since C++20) | std::contiguous_iterator_tag |
|
Member type | Definition |
---|---|
difference_type | std::ptrdiff_t |
value_type | T |
pointer | const T* |
reference | const T& |
iterator_category | std::random_access_iterator_tag |
Example
The following example shows a general-purpose reverse()
implementation for bidirectional iterators.
#include <iostream> #include <iterator> #include <vector> #include <list> template<class BidirIt> void my_reverse(BidirIt first, BidirIt last) { typename std::iterator_traits<BidirIt>::difference_type n = std::distance(first, last); --n; while(n > 0) { typename std::iterator_traits<BidirIt>::value_type tmp = *first; *first++ = *--last; *last = tmp; n -= 2; } } int main() { std::vector<int> v{1, 2, 3, 4, 5}; my_reverse(v.begin(), v.end()); for (int n : v) { std::cout << n << ' '; } std::cout << '\n'; std::list<int> l{1, 2, 3, 4, 5}; my_reverse(l.begin(), l.end()); for (auto n : l) { std::cout << n << ' '; } std::cout << '\n'; int a[] = {1, 2, 3, 4, 5}; my_reverse(a, a+5); for (int i=0; i<5; ++i) { std::cout << a[i] << ' '; } std::cout << '\n'; // std::istreambuf_iterator<char> i1(std::cin), i2; // my_reverse(i1, i2); // compilation error }
Output:
5 4 3 2 1 5 4 3 2 1 5 4 3 2 1
See also
(deprecated in C++17) | base class to ease the definition of required types for simple iterators (class template) |
(C++20) | empty class types used to indicate iterator categories (class) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://en.cppreference.com/w/cpp/iterator/iterator_traits