std::iterator_traits

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

イテレータライブラリ

イテレータのコンセプト
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)	Rangeアクセス 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 Iter > struct iterator_traits;
template< class T > struct iterator_traits<T*>;
template< class T > struct iterator_traits<const T*>;		(C++20で削除)

std::iterator_traitsは、LegacyIterator型のプロパティに対して統一されたインターフェースを提供する型特性クラスです。これにより、アルゴリズムをイテレータのみの観点から実装することが可能になります。

テンプレートはユーザー定義イテレータに対して特殊化できるため、型が通常のtypedefを提供しない場合でも、イテレータに関する情報を取得できます。

ユーザー定義の特殊化では、ネストされた型iterator_conceptをイテレータカテゴリタグのいずれかに定義することで、イテレータコンセプトへの準拠を示すことができます。

(C++20以降)

テンプレートパラメータ

Iter

-

プロパティを取得するイテレータ型

メンバ型

ネストされた型	定義
difference_type	Iter::difference_type
value_type	Iter::value_type
pointer	Iter::pointer
reference	Iter::reference
iterator_category	Iter::iterator_category

Iterがいずれかの5つのネストされた型を持たない場合、このテンプレートはその名前のメンバを持ちません（std::iterator_traitsはSFINAEフレンドリーです）。

(C++17以降) (C++20まで)

Iterがpointerを持たず、残りの4つのネストされた型すべてを持つ場合、これらの4つのネストされた型は次のように宣言されます。 ネストされた型 定義 difference_type Iter::difference_type value_type Iter::value_type pointer void reference Iter::reference iterator_category Iter::iterator_category それ以外の場合、Iterが表現専用コンセプト__LegacyInputIteratorを満たす場合、ネストされた型は次のように宣言されます。 ネストされた型 定義 difference_type std::incrementable_traits<Iter>::difference_type value_type std::indirectly_readable_traits<Iter>::value_type pointer Iter::pointer（有効な場合） それ以外の場合、decltype(std::declval<Iter&>().operator->())（有効な場合）。 それ以外の場合、void。 reference Iter::reference（有効な場合） それ以外の場合、std::iter_reference_t<Iter>。 iterator_category Iter::iterator_category（有効な場合）。 それ以外の場合、Iterが__LegacyRandomAccessIteratorを満たす場合は、std::random_access_iterator_tag。 それ以外の場合、Iterが__LegacyBidirectionalIteratorを満たす場合は、std::bidirectional_iterator_tag。 それ以外の場合、Iterが__LegacyForwardIteratorを満たす場合は、std::forward_iterator_tag。 それ以外の場合、std::input_iterator_tag。 それ以外の場合、Iterが表現専用コンセプト__LegacyIteratorを満たす場合、ネストされた型は次のように宣言されます。 ネストされた型 定義 difference_type std::incrementable_traits<Iter>::difference_type（有効な場合）。 それ以外の場合、void。 value_type void pointer void reference void iterator_category std::output_iterator_tag それ以外の場合、このテンプレートはその名前のメンバを持ちません（std::iterator_traitsはSFINAEフレンドリーです）。

(C++20以降)

特殊化

この型特性は、イテレータとして使用できるユーザー提供の型に対して特殊化される場合があります。標準ライブラリはポインタ型T*に対する部分特殊化を提供しており、これにより生のポインタですべてのイテレータベースのアルゴリズムを使用できます。

標準ライブラリは、一部の標準イテレータアダプタに対しても部分特殊化を提供します。

(C++20以降)

T* 特殊化のネストされた型

std::is_object_v<T> が true の場合にのみ特殊化されます。

(C++20以降)

ネストされた型	定義
difference_type	std::ptrdiff_t
value_type	T(C++20まで)std::remove_cv_t<T>(C++20以降)
pointer	T*
reference	T&
iterator_category	std::random_access_iterator_tag
iterator_concept (C++20以降)	std::contiguous_iterator_tag

const T* 特殊化のネストされた型 ネストされた型 定義 difference_type std::ptrdiff_t value_type T pointer const T* reference const T& iterator_category std::random_access_iterator_tag

(C++20まで)

ライブラリ型のための特殊化

std::iterator_traits<std::common_iterator> (C++20)	std::common_iterator 型のプロパティに対する統一されたインターフェースを提供します。 (クラステンプレート特殊化)
std::iterator_traits<std::counted_iterator> (C++20)	std::counted_iterator 型のプロパティに対する統一されたインターフェースを提供します。 (クラステンプレート特殊化)

例

双方向イテレータのための汎用的なstd::reverse() の実装を示します。

このコードを実行

#include <iostream>
#include <iterator>
#include <list>
#include <vector>
 
template<class BidirIt>
void my_reverse(BidirIt first, BidirIt last)
{
    typename std::iterator_traits<BidirIt>::difference_type n = std::distance(first, last);
    for (--n; n > 0; n -= 2)
    {
        typename std::iterator_traits<BidirIt>::value_type tmp = *first;
        *first++ = *--last;
        *last = tmp;
    }
}
 
int main()
{
    std::vector<int> v{1, 2, 3, 4, 5};
    my_reverse(v.begin(), v.end());
    for (int n : v)
        std::cout << n << ' ';
    std::cout << '\n';
 
    std::list<int> l{1, 2, 3, 4, 5};
    my_reverse(l.begin(), l.end());
    for (int n : l)
        std::cout << n << ' ';
    std::cout << '\n';
 
    int a[]{1, 2, 3, 4, 5};
    my_reverse(a, a + std::size(a));
    for (int n : a)
        std::cout << n << ' ';
    std::cout << '\n';
 
//  std::istreambuf_iterator<char> i1(std::cin), i2;
//  my_reverse(i1, i2); // compilation error: i1, i2 are input iterators
}

出力

5 4 3 2 1
5 4 3 2 1
5 4 3 2 1

関連項目

iterator (C++17で非推奨)	単純なイテレータに必要な型の定義を容易にするための基底クラス (クラステンプレート)
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	イテレータカテゴリを示すために使用される空のクラス型 (クラス)
iter_value_titer_reference_titer_const_reference_titer_difference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++23)(C++20)(C++20)(C++20)	イテレータの関連型を計算する (エイリアステンプレート)