イテレータライブラリ

 

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)

 

イテレータライブラリは5種類 (C++17未満)6種類 (C++17以上)のイテレータ、イテレータ特性、アダプタ、ユーティリティ関数に対する定義を提供します。

イテレータのカテゴリ

LegacyInputIterator, LegacyOutputIterator, LegacyForwardIterator, LegacyBidirectionalIterator, LegacyRandomAccessIterator, LegacyContiguousIterator (C++17以上) の 5種類 (C++17未満)6種類 (C++17以上)のイテレータがあります。

特定の型を定義する代わりに、イテレータの各々のカテゴリは実行可能な操作によって定義されます。 つまり必要な操作をサポートするあらゆる型をイテレータとして使用できるという意味です。 例えば、ポインタは LegacyRandomAccessIterator の要求する操作をすべてサポートしているため、 LegacyRandomAccessIterator が期待されるあらゆる場所でポインタを使用することができます。

すべてのイテレータのカテゴリ (LegacyOutputIterator を除く) は階層的に整理できます。 より強力なイテレータカテゴリ (例えば LegacyRandomAccessIterator) はそれより強力でないカテゴリ (例えば LegacyInputIterator) の操作もサポートします。 イテレータがこれらのカテゴリのいずれかに分類され、さらに LegacyOutputIterator の要件も満たす場合、そのイテレータは可変イテレータと呼ばれ、入力と出力の両方をサポートします。 可変でないイテレータは定数イテレータと呼ばれます。

イテレータのカテゴリ					定義されている操作
LegacyContiguousIterator	LegacyRandomAccessIterator	LegacyBidirectionalIterator	LegacyForwardIterator	LegacyInputIterator	読み込み インクリメント (シングルパス)
					インクリメント (マルチパス)
					デクリメント
					ランダムアクセス
					隣接した記憶域
上記のカテゴリのいずれかに分類され、さらに LegacyOutputIterator の要件も満たすイテレータは、可変イテレータと呼ばれます。
LegacyOutputIterator					書き込み インクリメント (シングルパス)

ノート: LegacyContiguousIterator カテゴリは C++17 で正式に規定されたものですが、 C++17 以前のコードでも std::vector, std::basic_string, std::array, std::valarray のイテレータおよび C の配列へのポインタはしばしば別のカテゴリとして扱われていました。

C++20 のイテレータコンセプト

C++20 では C++17 のイテレータと異なるコンセプトをベースとした新しいイテレータのシステムが導入されます。 基本的な分類は同じままですが、個別のイテレータカテゴリに対する要件は若干異なります。

名前空間 std で定義
indirectly_readable	型が * 演算子を適用することによって間接的に読み込み可能であることを指定します (コンセプト)
indirectly_writable	イテレータの参照先のオブジェクトに値を書き込めることを指定します (コンセプト)
weakly_incrementable	前置または後置インクリメント演算子で semiregular 型をインクリメントできることを指定します (コンセプト)
incrementable	weakly_incrementable 型に対するインクリメント演算が等しさを維持することおよびその型が equality_comparable であることを指定します (コンセプト)
input_or_output_iterator	その型のオブジェクトがインクリメントおよび逆参照できることを指定します (コンセプト)
Sentinel	型が input_or_output_iterator 型に対する番兵であることを指定します (コンセプト)
sized_sentinel_for	差を定数時間で計算するためにイテレータと番兵に - 演算子を適用できることを指定します (コンセプト)
input_iterator	型が入力イテレータである、つまり、参照先の値を読むことができ、前置および後置インクリメントができることを指定します (コンセプト)
output_iterator	型が指定された値型のための出力イテレータである、つまり、その型の値を書き込むことができ、前置および後置インクリメントができることを指定します (コンセプト)
forward_iterator	input_iterator が前進イテレータであり、等価比較とマルチパスをサポートすることを指定します (コンセプト)
bidirectional_iterator	forward_iterator が双方向イテレータであり、逆方向の移動をサポートすることを指定します (コンセプト)
random_access_iterator	bidirectional_iterator がランダムアクセスイテレータであり、定数時間での前進および添字アクセスをサポートすることを指定します (コンセプト)
contiguous_iterator	random_access_iterator が隣接イテレータであり、メモリ内で隣接する要素を参照していることを指定します (コンセプト)

イテレータの関連型

名前空間 std で定義
incrementable_traits	weakly_incrementable 型の差型を計算します (クラステンプレート)
indirectly_readable_traits	indirectly_readable 型の値型を計算します (クラステンプレート)
iter_value_titer_reference_titer_difference_titer_rvalue_reference_titer_common_reference_t	イテレータの関連型を計算します (エイリアステンプレート)

イテレータプリミティブ

iterator_traits	イテレータの性質への統一されたインタフェースを提供します (クラステンプレート)
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	イテレータのカテゴリを表すために使用される空のクラス型 (クラス)
iterator (C++17で非推奨)	シンプルなイテレータのための型要件の定義を簡単にする基底クラス (クラステンプレート)

イテレータのカスタマイゼーションポイント

名前空間 std::ranges で定義
iter_move	オブジェクトを逆参照した結果をその関連する右辺値参照型にキャストします (カスタマイゼーションポイントオブジェクト)
iter_swap	2つの逆参照可能オブジェクトの参照先の値を入れ替えます (カスタマイゼーションポイントオブジェクト)

アルゴリズムのコンセプトとユーティリティ

C++20 は共通アルゴリズム操作を簡単に制約するために設計されたコンセプトと関連するユーティリティテンプレートのセットも提供します。

ヘッダ <iterator> で定義
名前空間 std で定義
間接呼び出し可能コンセプト
indirectly_unary_invocableindirectly_regular_unary_invocable	呼び出し可能型が indirectly_readable 型を逆参照した結果を用いて呼ぶことができることを指定します (コンセプト)
indirect_unary_predicate	呼び出し可能型が indirectly_readable 型を逆参照した結果を用いて呼ばれたときに predicate を満たすことを指定します (コンセプト)
indirect_binary_predicate	呼び出し可能型が2つの indirectly_readable 型の結果を用いて呼んだときに predicate を満たすことを指定します (コンセプト)
indirect_equivalence_relation	呼び出し可能型が2つの indirectly_readable 型の逆参照の結果を用いて呼んだときに equivalence_relation を満たすことを指定します (コンセプト)
indirect_strict_weak_order	callable 型が2つの indirectly_readable を逆参照した結果を用いて呼ばれたときに strict_weak_order を満たすことを指定します (コンセプト)
共通アルゴリズム要件
indirectly_movable (C++20)	値が indirectly_readable 型から indirectly_writable 型にムーブできることを指定します (コンセプト)
indirectly_movable_storable (C++20)	値が indirectly_readable 型から indirectly_writable 型にムーブできることと、そのムーブが中間オブジェクトを介して行えることを指定します (コンセプト)
indirectly_copyable (C++20)	値が indirectly_readable 型から indirectly_writable 型にコピーできることを指定します (コンセプト)
indirectly_copyable_storable (C++20)	値が indirectly_readable 型から indirectly_writable 型にコピーできることと、そのコピーが中間オブジェクトを介して行えることを指定します (コンセプト)
indirectly_swappable	2つの indirectly_readable 型の参照先の値がスワップ可能であることを指定します (コンセプト)
indirectly_comparable	2つの indirectly_readable 型の参照先の値が比較できることを指定します (コンセプト)
permutable	その場で要素を並べ替えるアルゴリズムの共通の要件を指定します (コンセプト)
mergeable	要素をコピーすることによってソート済みシーケンスを出力シーケンスにマージするアルゴリズムの要件を指定します (コンセプト)
sortable	シーケンスを順序付きシーケンスに並び替えるアルゴリズムの共通の要件を指定します (コンセプト)
ユーティリティ
indirect_result_t	indirectly_readable 型の何らかの集合を逆参照した結果に対して callable オブジェクトを呼び出した結果を計算します (エイリアステンプレート)
projected	射影を受け取るアルゴリズムに対する制約を指定するためのヘルパーテンプレート (クラステンプレート)

イテレータアダプタ

reverse_iterator	逆順探索のためのイテレータアダプタ (クラステンプレート)
make_reverse_iterator (C++14)	引数から推定した型の std::reverse_iterator を作成します (関数テンプレート)
move_iterator (C++11)	右辺値参照を逆参照するイテレータアダプタ (クラステンプレート)
move_sentinel (C++20)	std::move_iterator と共に使用するための番兵アダプタ (クラステンプレート)
make_move_iterator (C++11)	引数から推定した型の std::move_iterator を作成します (関数テンプレート)
common_iterator (C++20)	イテレータ型とその番兵を共通イテレータ型に適合させます (クラステンプレート)
default_sentinel_t (C++20)	範囲の境界を知っているイテレータと共に使用するためのデフォルトの番兵 (クラス)
counted_iterator (C++20)	範囲の終端までの距離を追跡するイテレータアダプタ (クラステンプレート)
unreachable_sentinel_t (C++20)	いかなる weakly_incrementable 型とも常に等しくないと比較される番兵 (クラス)
back_insert_iterator	コンテナの末尾に挿入するためのイテレータアダプタ (クラステンプレート)
back_inserter	引数から推定した型の std::back_insert_iterator を作成します (関数テンプレート)
front_insert_iterator	コンテナの先頭に挿入するためのイテレータアダプタ (クラステンプレート)
front_inserter	引数から推定した型の std::front_insert_iterator を作成します (関数テンプレート)
insert_iterator	コンテナに挿入するためのイテレータアダプタ (クラステンプレート)
inserter	引数から推定した型の std::insert_iterator を作成します (関数テンプレート)

ストリームイテレータ

istream_iterator	std::basic_istream から読み込む入力イテレータ (クラステンプレート)
ostream_iterator	std::basic_ostream に書き込む出力イテレータ (クラステンプレート)
istreambuf_iterator	std::basic_streambuf から読み込む入力イテレータ (クラステンプレート)
ostreambuf_iterator	std::basic_streambuf に書き込む出力イテレータ (クラステンプレート)

イテレータの操作

ヘッダ <iterator> で定義
advance	イテレータを指定された距離だけ前進させます (関数)
distance	2つのイテレータ間の距離を返します (関数)
next (C++11)	イテレータをインクリメントします (関数)
prev (C++11)	イテレータをデクリメントします (関数)
ranges::advance (C++20)	イテレータを指定された距離または指定された境界まで前進させます (ニーブロイド)
ranges::distance (C++20)	イテレータと番兵の間または範囲の先頭と終端の間の距離を返します (ニーブロイド)
ranges::next (C++20)	イテレータを指定された距離または境界までインクリメントします (ニーブロイド)
ranges::prev (C++20)	イテレータを指定された距離または境界までデクリメントします (ニーブロイド)

範囲アクセス

これらの非メンバ関数はコンテナ、普通の配列、 std::initializer_list に対する汎用のインタフェースを提供します。

ヘッダ <array> で定義
ヘッダ <deque> で定義
ヘッダ <forward_list> で定義
ヘッダ <iterator> で定義
ヘッダ <list> で定義
ヘッダ <map> で定義
ヘッダ <regex> で定義
ヘッダ <set> で定義
ヘッダ <span> で定義
ヘッダ <string> で定義
ヘッダ <string_view> で定義
ヘッダ <unordered_map> で定義
ヘッダ <unordered_set> で定義
ヘッダ <vector> で定義
名前空間 std で定義
begincbegin (C++11)(C++14)	コンテナまたは配列の先頭を指すイテレータを返します (関数)
endcend (C++11)(C++14)	コンテナまたは配列の終端を指すイテレータを返します (関数)
rbegincrbegin (C++14)	コンテナまたは配列の先頭を指す逆イテレータを返します (関数)
rendcrend (C++14)	コンテナまたは配列の終端を指す逆イテレータを返します (関数)
sizessize (C++17)(C++20)	コンテナまたは配列のサイズを返します (関数テンプレート)
empty (C++17)	コンテナが空かどうか調べます (関数)
data (C++17)	ベースとなる配列を指すポインタを取得します (関数)