std::common_iterator

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

迭代器库

迭代器概念
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) input_or_output_iterator (C++20) sentinel_for (C++20) sized_sentinel_for (C++20)	input_iterator (C++20) output_iterator (C++20) forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
迭代器原语
iterator_traits input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20) iterator (C++17 中弃用)	incrementable_traits (C++20) indirectly_readable_traits (C++20) iter_value_titer_difference_titer_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++20)(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	projected
迭代器适配器
reverse_iterator move_iterator (C++11) move_sentinel (C++20) common_iterator (C++20) counted_iterator (C++20) back_insert_iterator front_insert_iterator insert_iterator	make_reverse_iterator (C++14) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20) back_inserter front_inserter inserter
流迭代器
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) endcend (C++11)(C++14) sizessize (C++17)(C++20)	rbegincrbegin (C++14)(C++14) rendcrend (C++14)(C++14) empty (C++17) data (C++17)

 

std::common_iterator

成员函数

common_iterator::common_iterator (C++20)

common_iterator::operator= (C++20)

common_iterator::operator*common_iterator::operator-> (C++20)(C++20)

common_iterator::operator++common_iterator::operator++(int) (C++20)(C++20)

非成员函数

operator== (C++20)

operator- (C++20)

iter_move (C++20)

iter_swap (C++20)

辅助类

incrementable_traits (C++20)

iterator_traits (C++20)

 

定义于头文件 <iterator>
template< std::input_or_output_iterator I, std::sentinel_for<I> S >   requires ( !std::same_as<I, S> && std::copyable<I> )     class common_iterator;		(C++20 起)

std::common_iterator 是含有迭代器或哨位之一并定义适合的比较运算符 operator== ，从而可以将非共用范围（其中 I 与 S 有别）表示成 common_range 的迭代器 I / 哨位 S 适配器。
能以 std::common_iterator 为迭代器/哨位对所表示的序列与期待 common_range 式序列的遗留函数间的“桥梁”。

成员函数

(构造函数) (C++20)	构造新的迭代器适配器 (公开成员函数)
operator= (C++20)	赋值另一迭代器适配器 (公开成员函数)
operator*operator-> (C++20)	访问被指向的元素 (公开成员函数)
operator++operator++(int) (C++20)	推进迭代器适配器 (公开成员函数)

成员对象

成员名	定义
var (私有)	std::variant<I, S> 类型对象，名字仅用于阐释

非成员函数

operator== (C++20)	比较底层迭代器或哨位 (函数模板)
operator- (C++20)	计算二个迭代器适配器间的距离 (函数模板)
iter_move (C++20)	转型解引用底层迭代器的结果为其所关联的右值引用类型 (函数)
iter_swap (C++20)	交换二个底层迭代器所指向的对象 (函数模板)

辅助类

std::incrementable_traits<std::common_iterator> (C++20)	计算 std::common_iterator 类型的关联差类型 (类模板特化)
std::iterator_traits<std::common_iterator> (C++20)	对 std::counted_iterator 类型的属性提供均一的接口 (类模板特化)

示例

运行此代码

#include <algorithm>
#include <list>
#include <iostream>
#include <iterator>
#include <string>
 
template <class ForwardIter>
void fire(ForwardIter first, ForwardIter last) {
    std::copy(first, last, std::ostream_iterator<std::string>{std::cout, " "});    
}
 
int main() {
    std::list<std::string> stars{"Pollux", "Arcturus", "Mira", "Aldebaran", "Sun"};
    using IT = std::common_iterator<
                   std::counted_iterator<std::list<std::string>::iterator>,
                   std::default_sentinel_t>;
    fire( IT(std::counted_iterator(stars.begin(), stars.size()-1)),
          IT(std::default_sentinel) );
}

输出：

Pollux Arcturus Mira Aldebaran

引用

• C++20 标准（ISO/IEC 14882:2020）：

• 23.5.4 Common iterators [iterators.common]

参阅

ranges::common_range (C++20)	指定范围拥有相同的迭代器和哨位类型 (概念)
ranges::common_viewviews::common (C++20)	转换 view 为 common_range (类模板) (范围适配器对象)