std::iterator_traits

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

迭代器库

迭代器概念
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
迭代器原语
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (C++17 中已弃用) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
算法概念与工具
间接可调用概念
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
常用算法要求
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
工具
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
迭代器适配器
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
流迭代器 istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	迭代器定制点 ranges::iter_move (C++20) ranges::iter_swap (C++20)
迭代器操作 advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	范围访问 begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (C++17)

 

定义于头文件 <iterator>
template< class Iter > struct iterator_traits;
template< class T > struct iterator_traits<T*>;
template< class T > struct iterator_traits<const T*>;		(C++20 中移除)

std::iterator_traits 是类型特征类，它为 LegacyIterator 类型的属性提供统一接口。这使得仅通过迭代器实现算法成为可能。

该模板可以针对用户定义的迭代器进行特化，以便即使类型不提供常用 typedef，也可以检索有关迭代器的信息。

用户特化可以将其嵌套类型 iterator_concept 定义为 迭代器类别标签之一，以指示与迭代器概念的符合性。

(C++20 起)

模板参数

Iter

-

要检索属性的迭代器类型

成员类型

嵌套类型	定义
difference_type	Iter::difference_type
value_type	Iter::value_type
pointer	Iter::pointer
reference	Iter::reference
iterator_category	Iter::iterator_category

如果 Iter 不包含上述五个嵌套类型中的任何一个，则此模板不包含任何具有这些名称的成员（std::iterator_traits 兼容 SFINAE）。

(C++17 起) (C++20 前)

如果 Iter 没有 pointer，但包含所有剩余的四个嵌套类型，则这四个嵌套类型声明如下： 嵌套类型 定义 difference_type Iter::difference_type value_type Iter::value_type pointer void reference Iter::reference iterator_category Iter::iterator_category 否则，如果 Iter 满足仅用于说明的概念 __LegacyInputIterator，则嵌套类型声明如下： 嵌套类型 定义 difference_type std::incrementable_traits<Iter>::difference_type value_type std::indirectly_readable_traits<Iter>::value_type pointer 如果有效，则为 Iter::pointer。 否则，如果有效，则为 decltype(std::declval<Iter&>().operator->())。 否则为 void。 reference 如果有效，则为 Iter::reference。 否则为 std::iter_reference_t<Iter>。 iterator_category 如果有效，则为 Iter::iterator_category。 否则，如果 Iter 满足 __LegacyRandomAccessIterator，则为 std::random_access_iterator_tag。 否则，如果 Iter 满足 __LegacyBidirectionalIterator，则为 std::bidirectional_iterator_tag。 否则，如果 Iter 满足 __LegacyForwardIterator，则为 std::forward_iterator_tag。 否则为 std::input_iterator_tag。 否则，如果 Iter 满足仅用于说明的概念 __LegacyIterator，则嵌套类型声明如下： 嵌套类型 定义 difference_type 如果有效，则为 std::incrementable_traits<Iter>::difference_type。 否则为 void。 value_type void pointer void reference void iterator_category std::output_iterator_tag 否则，此模板不包含任何具有这些名称的成员（std::iterator_traits 兼容 SFINAE）。

(C++20 起)

特化

此类型特征可以针对可作为迭代器使用的用户提供类型进行特化。标准库为指针类型 T* 提供部分特化，这使得可以使用原始指针的所有基于迭代器的算法。

标准库还为某些标准迭代器适配器提供部分特化。

(C++20 起)

T* 特化嵌套类型

仅当 std::is_object_v<T> 为 true 时才进行特化。

(C++20 起)

嵌套类型	定义
difference_type	std::ptrdiff_t
value_type	T(直到 C++20)std::remove_cv_t<T>(自 C++20 起)
pointer	T*
reference	T&
iterator_category	std::random_access_iterator_tag
iterator_concept (自 C++20 起)	std::contiguous_iterator_tag

const T* 特化嵌套类型 嵌套类型 定义 difference_type std::ptrdiff_t value_type T pointer const T* reference const T& iterator_category std::random_access_iterator_tag

(C++20 前)

库类型的特化

std::iterator_traits<std::common_iterator> (C++20)	为 std::common_iterator 类型的属性提供统一接口 (类模板特化)
std::iterator_traits<std::counted_iterator> (C++20)	为 std::counted_iterator 类型的属性提供统一接口 (类模板特化)

示例

显示了双向迭代器的通用 std::reverse() 实现。

运行此代码

#include <iostream>
#include <iterator>
#include <list>
#include <vector>
 
template<class BidirIt>
void my_reverse(BidirIt first, BidirIt last)
{
    typename std::iterator_traits<BidirIt>::difference_type n = std::distance(first, last);
    for (--n; n > 0; n -= 2)
    {
        typename std::iterator_traits<BidirIt>::value_type tmp = *first;
        *first++ = *--last;
        *last = tmp;
    }
}
 
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 (int n : l)
        std::cout << n << ' ';
    std::cout << '\n';
 
    int a[]{1, 2, 3, 4, 5};
    my_reverse(a, a + std::size(a));
    for (int n : a)
        std::cout << n << ' ';
    std::cout << '\n';
 
//  std::istreambuf_iterator<char> i1(std::cin), i2;
//  my_reverse(i1, i2); // compilation error: i1, i2 are input iterators
}

输出

5 4 3 2 1
5 4 3 2 1
5 4 3 2 1

另请参阅

iterator (C++17 中已弃用)	基类，用于简化简单迭代器所需类型的定义 (类模板)
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	用于指示迭代器类别的空类类型 (类)
iter_value_titer_reference_titer_const_reference_titer_difference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++23)(C++20)(C++20)(C++20)	计算迭代器的关联类型 (别名模板)