std::ranges::distance

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (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 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 的大小，表示为带符号整数。

此页面上描述的类似函数的实体是 niebloids，即

• 在调用任何这些实体时，不能指定显式模板参数列表。
• 它们都不对 依赖于参数的查找 可见。
• 当 普通非限定查找 找到它们作为函数调用运算符左侧的名称时，依赖于参数的查找 被禁止。

实际上，它们可能作为函数对象实现，或使用特殊的编译器扩展。

参数

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 <cassert>
#include <forward_list>
#include <iterator>
#include <vector>
 
int main() 
{
    std::vector<int> v{3, 1, 4};
    assert(std::ranges::distance(v.begin(), v.end()) == 3);
    assert(std::ranges::distance(v.end(), v.begin()) == -3);
    assert(std::ranges::distance(v) == 3);
 
    std::forward_list<int> l{2, 7, 1};
    // auto size = std::ranges::size(l); // error: not a sizable range
    auto size = std::ranges::distance(l); // OK, but aware O(N) complexity
    assert(size == 3);
}

缺陷报告

以下更改行为的缺陷报告被追溯应用于以前发布的 C++ 标准。

DR	应用于	发布时的行为	正确的行为
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	返回两个迭代器之间的距离 (函数模板)