std::distance

 

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)

 

<tbody> </tbody>

ヘッダ <iterator> で定義
template< class InputIt > typename std::iterator_traits<InputIt>::difference_type distance( InputIt first, InputIt last );		(C++17未満)
template< class InputIt > constexpr typename std::iterator_traits<InputIt>::difference_type distance( InputIt first, InputIt last );		(C++17以上)

first から last までのホップ数を返します。

引数

last が first を (繰り返し) インクリメントすることによって first から到達できなければ、動作は未定義です。	(C++11未満)
InputIt が LegacyRandomAccessIterator でない場合、 last が first を (繰り返し) インクリメントすることによって first から到達できなければ、動作は未定義です。 InputIt が LegacyRandomAccessIterator の場合、 last が first から到達可能でなく first が last から到達可能でなければ、動作は未定義です。	(C++11以上)

first	-	最初の要素を指すイテレータ
last	-	範囲の終端を指すイテレータ
型の要件
- InputIt は LegacyInputIterator の要件を満たさなければなりません。 InputIt がさらに LegacyRandomAccessIterator の要件も満たす場合、操作はより効率的になります。

戻り値

first から last まで行くために必要なインクリメント回数。 ランダムアクセスイテレータが使用され、 first が last から到達可能であれば、値は負になることがあります。 (C++11以上)

計算量

線形。

ただし、 InputIt がさらに LegacyRandomAccessIterator の要件も満たす場合、計算量は定数時間になります。

例

Run this code

#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';
               //the behavior is undefined (until C++11)
}

出力:

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

関連項目

advance	イテレータを指定された距離だけ前進させます (関数)
countcount_if	一定の基準を満たす要素の数を返します (関数テンプレート)