std::ranges::distance

 

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（範圍迭代器移動） (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)	範圍訪問 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>
呼叫簽名 (Call signature)
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++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 3392	C++20	過載 (1) 按值獲取迭代器，因此移動專用 具有有大小哨兵的迭代器左值被拒絕	添加了過載 (2)
LWG 3664	C++20	LWG issue 3392 的解決方案導致 ranges::distance 拒絕陣列引數	接受它們

參見

ranges::advance（範圍前進） (C++20)	將迭代器前進指定距離或到指定邊界 (演算法函式物件)
ranges::count（範圍計數）ranges::count_if（範圍條件計數） (C++20)(C++20)	返回滿足特定條件的元素數量 (演算法函式物件)
distance（距離）	返回兩個迭代器間的距離 (函式模板)