C++ 名前付き要件： SequenceContainer

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

C++ 名前付き要件

基本 DefaultConstructible MoveConstructible (C++11) CopyConstructible CopyAssignable MoveAssignable (C++11) Destructible 型のプロパティ ScalarType PODType TriviallyCopyable (C++11) TrivialType (C++11) StandardLayoutType (C++11)   ImplicitLifetimeType ライブラリワイド BooleanTestable EqualityComparable LessThanComparable Swappable ValueSwappable (C++11) NullablePointer (C++11) Hash (C++11) アロケータ FunctionObject Callable Predicate BinaryPredicate Compare

コンテナ コンテナ ReversibleContainer AllocatorAwareContainer SequenceContainer ContiguousContainer (C++17) AssociativeContainer UnorderedAssociativeContainer (C++11)   コンテナ要素 DefaultInsertable (C++11) CopyInsertable (C++11) MoveInsertable (C++11) EmplaceConstructible (C++11) Erasable (C++11) イテレータ LegacyIterator LegacyInputIterator LegacyOutputIterator LegacyForwardIterator LegacyBidirectionalIterator LegacyRandomAccessIterator LegacyContiguousIterator (C++17) ConstexprIterator (C++20) ストリームI/O FormattedInputFunction UnformattedInputFunction FormattedOutputFunction UnformattedOutputFunction フォーマッタ BasicFormatter (C++20) フォーマッタ (C++20)

乱数 SeedSequence (C++11) RandomNumberEngine (C++11) RandomNumberDistribution (C++11) UniformRandomBitGenerator (C++11) RandomNumberEngineAdaptor (C++11) 並行性 BasicLockable (C++11) Lockable (C++11) TimedLockable (C++11) SharedLockable (C++14) SharedTimedLockable (C++14) Mutex (C++11) TimedMutex (C++11) SharedMutex (C++17) SharedTimedMutex (C++14) Ranges RangeAdaptorObject (C++20) RangeAdaptorClosureObject (C++20) 多次元ビュー LayoutMapping (C++23) LayoutMappingPolicy (C++23) AccessorPolicy (C++23) その他 CharTraits RegexTraits (C++11)   BitmaskType LiteralType (C++11) NumericType UnaryTypeTrait (C++11) BinaryTypeTrait (C++11) TransformationTrait (C++11) Clock (C++11) TrivialClock (C++11)

 

SequenceContainer は、同じ型のオブジェクトを線形配置で格納する Container です。

要件

以下の型と値を考慮します

型	定義
C	シーケンスコンテナクラス
T	C の要素型
A	C のアロケータ型 C::allocator_type (存在する場合) そうでない場合は std::allocator<T>
R (C++23 以降)	container-compatible-range <T> をモデル化する型
Args (C++11 以降)	テンプレートパラメータパック
Iter	C::iterator
Ref	C::reference
CRef	C::const_reference
値	定義
v	C 型の値
cv	const C 型の値
i, j	LegacyInputIterator であって、[i, j) が 有効な範囲であり、イテレータが C::value_type に暗黙的に変換可能な要素を参照しているもの
rg (C++23 以降)	R 型の値
il (C++11 以降)	std::initializer_list<C::value_type> 型の値
n	C::size_type 型の値
p	v 内の有効な const iterator
q	v 内の 有効なデリファレンス可能な const iterator
q1, q2	v 内の const iterator であって、[q1, q2) が有効な範囲となるもの
t	値(C++11 まで)lvalue または const rvalue(C++11 以降) of type C::value_type
rv (C++11 以降)	C::value_type の非 const rvalue
args (C++11 以降)	Arg&& のパターンを持つ関数パラメータパック

C が SequenceContainer の要件を満たすのは、以下のすべての条件が満たされる場合です

• C は Container の要件を満たします。
• 以下のステートメントおよび式は、指定された意味論で正常に形成されます

基本的な数学関数 (標準ライブラリのすべてのシーケンスコンテナで必要ただし std::array を除く(C++11 以降))
ステートメント		意味論
C c(n, t);		効果	t の n 個のコピーを含むシーケンスコンテナを構築します。
		事前条件	T は C に CopyInsertable です。 (C++11以降)
		事後条件	std::distance(c.begin(), c.end()) は n です。
C c(i, j);		効果	範囲 [i, j) と要素ごとに等しいシーケンスコンテナを構築します。 範囲 [i, j) 内の各イテレータはちょうど一度デリファレンスされます。
		事前条件	T は *i から C に EmplaceConstructible です。 (C++11以降)
		事後条件	std::distance(c.begin(), c.end()) は std::distance(i, j) です。
Expression	型	セマンティクス
C(std::from_range, rg) (C++23から)	C	効果	範囲 rg と要素ごとに等しいシーケンスコンテナを構築します。 rg の各イテレータはちょうど1回逆参照されます。
		事前条件	T は、*ranges::begin(rg) から X に EmplaceConstructible です。
		事後条件	std::distance(begin(), end()) は ranges::distance(rg) です。
C(il) (C++11以降)	C	C(il.begin(), il.end()) と同等です。
v = il (C++11以降)	C&	効果	il が表す範囲を v に代入します。
		戻り値	*this
		事前条件	T は C に CopyInsertable であり、CopyAssignable です。
		事後条件	v の既存の要素は破棄されるか、または代入されます。
v.emplace(p, args) (C++11以降)	Iter	効果	std::forward<Args>(args)... で構築された T 型のオブジェクトを p の前に挿入します。
		戻り値	args から構築された新しい要素を指すイテレータが v に挿入されます。
		事前条件	T は args から C に EmplaceConstructible です。
v.insert(p, t)	Iter	効果	t のコピーを p の前に挿入します。
		戻り値	v に挿入された t のコピーを指すイテレータ。
		事前条件	T は C に CopyInsertable です。 (C++11以降)
v.insert(p, rv) (C++11以降)	Iter	効果	rv のコピーを p の前に挿入します。ムーブセマンティクスを使用する場合があります。
		戻り値	rv のコピーが v に挿入されたことを指すイテレータ。
		事前条件	T は C に MoveInsertable です。
v.insert(p, n, t)	Iter	効果	t の n 個のコピーを p の前に挿入します。
		戻り値	v に挿入された最初の要素のコピーを指すイテレータ、または n が ​0​ の場合は p。
		事前条件	T は C に CopyInsertable であり、CopyAssignable です。 (C++11以降)
v.insert(p, i, j)	Iter	効果	範囲 [i, j) の要素のコピーを p の前に挿入します。 範囲 [i, j) 内の各イテレータはちょうど一度デリファレンスされます。
		戻り値	v に挿入された最初の要素のコピーを指すイテレータ、または i == j が true の場合は p。
		事前条件	T は *i から C に EmplaceConstructible です。 (C++11以降) i および j は v 内にはありません。
v.insert_range(p, rg) (C++23から)	Iter	効果	rg の要素のコピーを p の前に挿入します。 rg の各イテレータはちょうど1回逆参照されます。
		戻り値	v に挿入された最初の要素のコピーを指すイテレータ、または rg が空の場合は p。
		事前条件	T は、*ranges::begin(rg) から C に EmplaceConstructible です。 rg と v は重複しません。
v.insert(p, il) (C++11以降)	Iter	v.insert(p, il.begin(), il.end()) と同等です。
v.erase(q)	Iter	効果	q が指す要素を削除します。
		戻り値	削除される要素の直後に続く要素を指すイテレータ、またはそのような要素が存在しない場合は v.end()。
v.erase(q1, q2)	Iter	効果	範囲 [q1, q2) の要素を削除します。
		戻り値	要素が削除される前の q2 が指していた要素を指すイテレータ、またはそのような要素が存在しない場合は v.end()。
v.clear()	void	効果	v 内のすべての要素を破棄します。 v の要素を参照するすべての参照、ポインタ、およびイテレータを無効にし、終端後イテレータを無効にする場合があります。
		事後条件	v.empty() は true です。
		計算量	線形。
v.assign(i, j)	void	効果	v の要素を、範囲 [i, j) のコピーで置き換えます。 v の要素を参照するすべての参照、ポインタ、およびイテレータを無効にします。 範囲 [i, j) 内の各イテレータはちょうど一度デリファレンスされます。
		事前条件	T は *i から C に EmplaceConstructible です。 T は *i から代入可能です。 (C++11以降) i および j は v 内にはありません。
v.assign_range(rg) (C++23から)	void	効果	v の要素を、rg の各要素のコピーで置き換えます。 もし std::assignable_from     <T&, ranges::range_reference_t<R>> がモデル化されていない場合、プログラムは不正に形成されます。 v の要素を参照するすべての参照、ポインタ、およびイテレータを無効にします。 rg の各イテレータはちょうど1回逆参照されます。
		事前条件	T は、*ranges::begin(rg) から C に EmplaceConstructible です。 rg と v は重複しません。
v.assign(il) (C++11以降)	void	v.assign(il.begin(), il.end()) と同等です。
v.assign(n, t)	void	効果	v の要素を、t の n 個のコピーで置き換えます。
		事前条件	T は C に CopyInsertable であり、CopyAssignable です。 (C++11以降)
追加の操作 (指定されたシーケンスコンテナに対してのみ必要、std:: は省略)
Expression	型	セマンティクス
v.front()	Ref	コンテナ	basic_string, array, vector, inplace_vector, deque, list, forward_list
		戻り値	*v.begin()
cv.front()	CRef	コンテナ	basic_string, array, vector, inplace_vector, deque, list, forward_list
		戻り値	*cv.begin()
v.back()	Ref	コンテナ	basic_string, array, vector, inplace_vector, deque, list
		auto tmp = v.end(); --tmp; return *tmp; と同等です。
cv.back()	CRef	コンテナ	basic_string, array, vector, inplace_vector, deque, list
		auto tmp = cv.end(); --tmp; return *tmp; と同等です。
v.emplace_front(args) (C++11以降)	void	コンテナ	deque, list, forward_list
		効果	std::forward<Args>(args)... で構築された T 型のオブジェクトを先頭に挿入します。
		戻り値	v.front()
		事前条件	T は args から C に EmplaceConstructible です。
v.emplace_back(args) (C++11以降)	void	コンテナ	vector, inplace_vector, deque, list
		効果	std::forward<Args>(args)... で構築された T 型のオブジェクトを末尾に追加します。
		戻り値	v.back()
		事前条件	T は args から C に EmplaceConstructible です。
v.push_front(t)	void	コンテナ	deque, list, forward_list
		効果	t のコピーを先頭に挿入します。
		事前条件	T は C に CopyInsertable です。 (C++11以降)
v.push_front(rv) (C++11以降)	void	コンテナ	deque, list, forward_list
		効果	rv のコピーを先頭に挿入します。ムーブセマンティクスを使用する場合があります。
		事前条件	T は C に MoveInsertable です。
v.prepend_range(rg) (C++23から)	void	コンテナ	deque, list, forward_list
		効果	rg の要素のコピーを v.begin() の前に挿入します。 rg の各イテレータはちょうど1回逆参照されます。
		事前条件	T は、*ranges::begin(rg) から C に EmplaceConstructible です。
v.push_back(t)	void	コンテナ	basic_string, vector, inplace_vector, deque, list
		効果	t のコピーを末尾に追加します。
		事前条件	T は C に CopyInsertable です。 (C++11以降)
v.push_back(rv) (C++11以降)	void	コンテナ	basic_string, vector, inplace_vector, deque, list
		効果	rv のコピーを末尾に追加します。ムーブセマンティクスを使用する場合があります。
		事前条件	T は C に MoveInsertable です。
v.append_range(rg) (C++23から)	void	コンテナ	vector, inplace_vector, deque, list
		効果	rg の要素のコピーを v.end() の前に挿入します。 rg の各イテレータはちょうど1回逆参照されます。
		事前条件	T は、*ranges::begin(rg) から C に EmplaceConstructible です。
v.pop_front()	void	コンテナ	deque, list, forward_list
		効果	先頭の要素を破棄します。
		事前条件	a.empty() は false です。
v.pop_back()	void	コンテナ	basic_string, vector, inplace_vector, deque, list
		効果	末尾の要素を破棄します。
		事前条件	a.empty() は false です。
v[n]	Ref	コンテナ	basic_string, array, vector, inplace_vector, deque
		return *(v.begin() + n); と同等です。
cv[n]	CRef	コンテナ	basic_string, array, vector, inplace_vector, deque
		return *(cv.begin() + n); と同等です。
v.at(n)	Ref	コンテナ	basic_string, array, vector, inplace_vector, deque
		戻り値	*(v.begin() + n)
		例外	もし n >= v.size() が true なら std::out_of_range をスローします。
cv.at(n)	CRef	コンテナ	basic_string, array, vector, inplace_vector, deque
		戻り値	*(cv.begin() + n)
		例外	もし n >= cv.size() が true なら std::out_of_range をスローします。
注釈

さらに、すべてのシーケンスコンテナについて

• 2つの入力イテレータを受け取るコンストラクタテンプレートと、2つの入力イテレータを受け取る insert、append、assign、replace のメンバ関数テンプレートオーバーロードは、対応するテンプレート引数が LegacyInputIterator を満たさない場合、オーバーロード解決に参加しません。

LegacyInputIterator または Allocator テンプレートパラメータのいずれかを持つ推論ガイドは、そのパラメータに対して入力イテレータまたはアロケータとして適格でない型が推論された場合、オーバーロード解決に参加しません。

(C++17以降)

標準ライブラリ

以下の標準ライブラリの文字列型およびコンテナは、SequenceContainer の要件を満たします

basic_string	文字のシーケンスを格納し操作する (クラステンプレート)
array (C++11)	固定サイズのインプレースな連続配列 (クラステンプレート)
vector	リサイズ可能な連続配列 (クラステンプレート)
inplace_vector (C++26)	リサイズ可能、固定容量、インプレースの連続配列 (クラステンプレート)
deque	両端キュー (クラステンプレート)
forward_list (C++11)	単方向連結リスト (クラステンプレート)
list	双方向リンクリスト (クラステンプレート)

使用上の注意

コンテナ	長所	短所
std::vector	高速アクセス、連続ストレージ	ほとんどの挿入/削除は非効率的
std::inplace_vector	高速アクセス、インプレース連続ストレージ	固定容量、ほとんどの挿入/削除は非効率的
std::array	高速アクセス、インプレース連続ストレージ	固定要素数、挿入/削除なし
std::deque	高速アクセス、先頭/末尾での効率的な挿入/削除	シーケンスの中央での挿入/削除は非効率的
std::list std::forward_list	シーケンスの中央での効率的な挿入/削除	アクセスはほとんど線形時間

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 139	C++98	オプションの操作は、指定されたコンテナに対して 実装される必要はありませんでした。	償却時間で必要
LWG 149	C++98	v.insert(p, t) は Iter を返しましたが、 v.insert(p, n, t) および v.insert(p, n, t) は void を返しました。	それらはすべて Iter を返します。
LWG 151	C++98	q1 はデリファレンス可能である必要がありました。	デリファレンス不可能でも構いません。
LWG 355	C++98	v.back() または v.pop_back() を呼び出すと --v.end() が実行され、危険でした。	代わりに v.end() のコピーをデクリメントします。 代わりに v.end() をデクリメントします。
LWG 589	C++98	i および j が参照する要素は C::value_type に変換可能でない場合があります。	それらは暗黙的に C::value_type に変換可能です。
LWG 2194	C++11	std::queue, std::priority_queue および std::stack も SequenceContainer でした。	それらは SequenceContainer ではありません。
LWG 2231	C++11	v.clear() の複雑性要件 は C++11 では誤って省略されていました。	複雑性は線形であると再確認されました。
LWG 3927	C++98	operator[] には暗黙的な要件がありませんでした。	暗黙的な要件が追加されました。