std::ranges::distance

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (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) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) 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) make_const_iterator (C++23) make_const_sentinel (C++23) 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)

 

在标头 <iterator> 定义
调用签名
template< class I, std::sentinel_for<I> S >     requires (!std::sized_sentinel_for<S, I>) constexpr std::iter_difference_t<I> distance( I first, S last );	(1)	(C++20 起)
template< class I, std::sized_sentinel_for<std::decay_t<I>> S > constexpr std::iter_difference_t<std::decay_t<I>>     distance( I&& first, S last );	(2)	(C++20 起)
template< ranges::range R > constexpr ranges::range_difference_t<R> distance( R&& r );	(3)	(C++20 起)

1,2) 返回从 first 到 last 的自增次数。

3) 以有符号整数返回 r 的大小。

此页面上描述的仿函数实体是 niebloid，即：

• 调用它们中的任何一个时不能显式指定模板实参。
• 它们都不对实参依赖查找可见。
• 在通过函数调用运算符左侧的名字进行无限定查找，找到它们之一时，禁止实参依赖查找。

实际上，它们能以函数对象，或者某些特殊编译器扩展实现。

参数

first	-	指向首元素的迭代器
last	-	代表 first 所指向的范围结尾的哨位
r	-	要计算距离的范围

返回值

1) 需要从 first 到 last 的自增次数。

2) last - static_cast<const std::decay_t<I>&>(first)。

3) 在 R 实现 ranges::sized_range 时返回 ranges::size(r)，否则返回 ranges::distance(ranges::begin(r), ranges::end(r))。

复杂度

1) 线性。

2) 常数。

3) 在 R 实现 ranges::sized_range 时，或者在 std::sized_sentinel_for<ranges::sentinel_t<R>, ranges::iterator_t<R>> 得到实现时是常数，否则是线性。

可能的实现

struct distance_fn { template<class I, std::sentinel_for<I> S> requires (!std::sized_sentinel_for<S, I>) constexpr std::iter_difference_t<I> operator()(I first, S last) const { std::iter_difference_t<I> result = 0; while (first != last) { ++first; ++result; } return result; }   template<class I, std::sized_sentinel_for<std::decay<I>> S> constexpr std::iter_difference_t<I> operator()(const I& first, S last) const { return last - first; }   template<ranges::range R> constexpr ranges::range_difference_t<R> operator()(R&& r) const { if constexpr (ranges::sized_range<std::remove_cvref_t<R>>) return static_cast<ranges::range_difference_t<R>>(ranges::size(r)); else return (*this)(ranges::begin(r), ranges::end(r)); } };   inline constexpr auto distance = distance_fn{};

示例

运行此代码

#include <iostream>
#include <iterator>
#include <vector>
 
int main() 
{
    std::vector<int> v{3, 1, 4};
    namespace ranges = std::ranges;
    std::cout << "distance(first, last) = "
              << ranges::distance(v.begin(), v.end()) << '\n'
              << "distance(last, first) = "
              << ranges::distance(v.end(), v.begin()) << '\n'
              << "distance(v) = " << ranges::distance(v) << '\n';
}

输出：

distance(first, last) = 3
distance(last, first) = -3
distance(v) = 3

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
LWG 3392	C++20	重载 (1) 按值接收迭代器，从而拒绝拥有具大小哨位的仅移动迭代器左值	添加重载 (2)
LWG 3664	C++20	LWG 问题 3392 的解决方案导致 ranges::distance 拒绝数组实参	接受数组实参

参阅

ranges::advance (C++20)	令迭代器前进给定的距离或到给定的边界 (niebloid)
ranges::countranges::count_if (C++20)(C++20)	返回满足指定判别标准的元素数 (niebloid)
distance	返回两个迭代器间的距离 (函数模板)