std::iterator

 

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_tag（输入迭代器标签）output_iterator_tag（输出迭代器标签）forward_iterator_tag（前向迭代器标签）bidirectional_iterator_tag（双向迭代器标签）random_access_iterator_tag（随机访问迭代器标签）contiguous_iterator_tag（连续迭代器标签） (C++20)	iter_value_t（迭代器值类型）iter_difference_t（迭代器差值类型）iter_reference_t（迭代器引用类型）iter_const_reference_t（迭代器常量引用类型）iter_rvalue_reference_t（迭代器右值引用类型）iter_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_invocable（间接一元可调用）indirectly_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_t（默认哨兵类型）default_sentinel（默认哨兵） (C++20)(C++20) unreachable_sentinel_t（不可达哨兵类型）unreachable_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（ranges::迭代器移动） (C++20) ranges::iter_swap（ranges::迭代器交换） (C++20)
迭代器操作 advance（前进） distance（距离） prev（前一个） (C++11)   next（下一个） (C++11) ranges::advance（ranges::前进） (C++20) ranges::distance（ranges::距离） (C++20) ranges::prev（ranges::前一个） (C++20) ranges::next（ranges::下一个） (C++20)	范围访问 begin（开始）cbegin（常量开始） (C++11)(C++14) rbegin（反向开始）crbegin（常量反向开始） (C++14)(C++14)   end（结束）cend（常量结束） (C++11)(C++14) rend（反向结束）crend（常量反向结束） (C++14)(C++14)   size（大小）ssize（有符号大小） (C++17)(C++20) empty（是否为空） (C++17) data（数据） (C++17)

 

定义于头文件 <iterator>
template<     class Category, （类别）     class T, （类型T）     class Distance = std::ptrdiff_t, （距离）     class Pointer = T*, （指针）     class Reference = T& （引用） > struct iterator;		(C++17 中已弃用)

std::iterator 是一个基类，用于简化迭代器所需类型的定义。

模板参数

分类	-	迭代器的类别。必须是迭代器类别标签之一。
T	-	通过解引用迭代器可获得的值的类型。对于输出迭代器，此类型应为void。
Distance	-	可用于标识迭代器之间距离的类型
指针	-	定义指向所迭代类型（T）的指针
引用	-	定义对所迭代类型（T）的引用

成员类型

成员类型	定义
iterator_category（迭代器类别）	分类
value_type（值类型）	T
difference_type（差值类型）	Distance
pointer（指针）	指针
reference（引用）	引用

示例

以下示例展示了如何通过继承自 std::iterator 来实现一个输入迭代器

运行此代码

#include <algorithm>
#include <iostream>
 
template<long FROM, long TO>
class Range
{
public:
    // member typedefs provided through inheriting from std::iterator
    class iterator : public std::iterator<
                                std::input_iterator_tag, // iterator_category
                                long,                    // value_type
                                long,                    // difference_type
                                const long*,             // pointer
                                long                     // reference
                            > {
        long num = FROM;
    public:
        explicit iterator(long _num = 0) : num(_num) {}
        iterator& operator++() { num = TO >= FROM ? num + 1: num - 1; return *this; }
        iterator operator++(int) { iterator retval = *this; ++(*this); return retval; }
        bool operator==(iterator other) const { return num == other.num; }
        bool operator!=(iterator other) const { return !(*this == other); }
        reference operator*() const { return num; }
    };
    iterator begin() { return iterator(FROM); }
    iterator end() { return iterator(TO >= FROM? TO + 1 : TO - 1); }
};
 
int main()
{
    // std::find requires an input iterator
    auto range = Range<15, 25>();
    auto itr = std::find(range.begin(), range.end(), 18);
    std::cout << *itr << '\n'; // 18
 
    // Range::iterator also satisfies range-based for requirements
    for (long l : Range<3, 5>())
        std::cout << l << ' '; // 3 4 5
    std::cout << '\n';
}

输出

18
3 4 5

另请参阅

iterator_traits（迭代器特性）	提供迭代器属性的统一接口 (类模板)
input_iterator_tag（输入迭代器标签）output_iterator_tag（输出迭代器标签）forward_iterator_tag（前向迭代器标签）bidirectional_iterator_tag（双向迭代器标签）random_access_iterator_tag（随机访问迭代器标签）contiguous_iterator_tag（连续迭代器标签） (C++20)	用于指示迭代器类别的空类类型 (类)