std::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 InputIt > typename std::iterator_traits<InputIt>::difference_type     distance( InputIt first, InputIt last );		(C++17 起 constexpr)

返回从 first 到 last 的距离。

如果 InputIt 不是老式随机访问迭代器 (LegacyRandomAccessIterator) ，那么在 last 从 first 不可及时行为未定义。

如果 InputIt 是老式随机访问迭代器 (LegacyRandomAccessIterator) ，那么在 first 和 last 互不可及时行为未定义。

参数

first	-	指向首元素的迭代器
last	-	指向范围尾的迭代器
类型要求
- InputIt 必须符合老式输入迭代器 (LegacyInputIterator) 的要求。在 InputIt 额外满足老式随机访问迭代器 (LegacyRandomAccessIterator) 的要求时操作会更高效。

返回值

从 first 走到 last 所需的自增数。

在使用随机访问迭代器且 first 从 last 可及的情况下值可能为负。

复杂度

线性。

然而，如果 InputIt 额外满足老式随机访问迭代器 (LegacyRandomAccessIterator) 的要求，那么复杂度是常数。

可能的实现

参阅 libstdc++ 与 libc++ 中的实现。

版本一
// 通过标签派发实现，移除 constexpr 后可用于 C++98 namespace detail { template<class It> constexpr // C++17 起要求 typename std::iterator_traits<It>::difference_type do_distance(It first, It last, std::input_iterator_tag) { typename std::iterator_traits<It>::difference_type result = 0; while (first != last) { ++first; ++result; } return result; }   template<class It> constexpr // C++17 起要求 typename std::iterator_traits<It>::difference_type do_distance(It first, It last, std::random_access_iterator_tag) { return last - first; } } // namespace detail   template<class It> constexpr // C++17 起 typename std::iterator_traits<It>::difference_type distance(It first, It last) { return detail::do_distance(first, last, typename std::iterator_traits<It>::iterator_category()); }
版本二
// 通过 constexpr if 实现，可用于 C++17 template<class It> constexpr typename std::iterator_traits<It>::difference_type distance(It first, It last) { using category = typename std::iterator_traits<It>::iterator_category; static_assert(std::is_base_of_v<std::input_iterator_tag, category>);   if constexpr (std::is_base_of_v<std::random_access_iterator_tag, category>) return last - first; else { typename std::iterator_traits<It>::difference_type result = 0; while (first != last) { ++first; ++result; } return result; } }

示例

运行此代码

#include <iostream>
#include <iterator>
#include <vector>
 
int main() 
{
    std::vector<int> v{3, 1, 4};
    std::cout << "distance(first, last) = "
              << std::distance(v.begin(), v.end()) << '\n'
              << "distance(last, first) = "
              << std::distance(v.end(), v.begin()) << '\n';
              // （直到LWG940）行为未定义
 
    static constexpr auto il = {3, 1, 4};
    // C++17 起 `distance` 可以在 constexpr 中使用。
    static_assert(std::distance(il.begin(), il.end()) == 3);
    static_assert(std::distance(il.end(), il.begin()) == -3);
}

输出：

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

缺陷报告

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

缺陷报告	应用于	出版时的行为	正确行为
LWG 940	C++98	first 从 last 可及的情况下的用词不明确	使之明确

参阅

advance	令迭代器前进给定的距离 (函数模板)
countcount_if	返回满足指定判别标准的元素数 (函数模板)
ranges::distance (C++20)	返回迭代器与哨位间的距离，或范围起始与结尾间的距离 (niebloid)