std::iterator

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

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

技術仕様書

 

イテレータライブラリ

イテレータコンセプト
readable (C++20) 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) 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)
イテレータアダプタ
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)

 

ヘッダ <iterator> で定義
template<     class Category,     class T,     class Distance = std::ptrdiff_t,     class Pointer = T*,     class Reference = T& > struct iterator;		(C++17で非推奨)

std::iterator はイテレータのために要求される型の定義を簡単にするために提供される基底クラスです。

テンプレート引数

Category	-	イテレータのカテゴリ。 イテレータカテゴリタグのいずれかでなければなりません
T	-	イテレータを逆参照することによって取得できる値の型。 この型は出力イテレータに対しては void であるべきです
Distance	-	イテレータ間の距離を表すために使用できる型
Pointer	-	イテレートする型 (T) を指すポインタを定義します
Reference	-	イテレートする型 (T) を指す参照を定義します

メンバ型

メンバ型	定義
iterator_category	Category
value_type	T
difference_type	Distance
pointer	Pointer
reference	Reference

例

以下の例は std::iterator を継承して入力イテレータを実装する方法を示します。

Run this code

#include <iostream>
#include <algorithm>
 
template<long FROM, long TO>
class Range {
public:
    // メンバ typedef は std::iterator からの継承を通して提供されます。
    class iterator: public std::iterator<
                        std::input_iterator_tag,   // iterator_category
                        long,                      // value_type
                        long,                      // difference_type
                        const long*,               // pointer
                        long                       // reference
                                      >{
        long num = FROM;
    public:
        explicit iterator(long _num = 0) : num(_num) {}
        iterator& operator++() {num = TO >= FROM ? num + 1: num - 1; return *this;}
        iterator operator++(int) {iterator retval = *this; ++(*this); return retval;}
        bool operator==(iterator other) const {return num == other.num;}
        bool operator!=(iterator other) const {return !(*this == other);}
        reference operator*() const {return num;}
    };
    iterator begin() {return iterator(FROM);}
    iterator end() {return iterator(TO >= FROM? TO+1 : TO-1);}
};
 
int main() {
    // std::find は入力イテレータを要求します。
    auto range = Range<15, 25>();
    auto itr = std::find(range.begin(), range.end(), 18);
    std::cout << *itr << '\n'; // 18
 
    // Range::iterator は範囲ベースの for の要件も満たします。
    for(long l : Range<3, 5>()) {
        std::cout << l << ' '; // 3 4 5
    }
    std::cout << '\n';
}

出力:

18
3 4 5

関連項目

iterator_traits	イテレータの性質への統一されたインタフェースを提供します (クラステンプレート)
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	イテレータのカテゴリを表すために使用される空のクラス型 (クラス)