std::copy, std::copy_if
| ヘッダ <algorithm>
|
||
template< class InputIt, class OutputIt >
OutputIt copy( InputIt first, InputIt last,
OutputIt d_first );
|
で定義 (1) | (C++20 以降 constexpr) |
template< class ExecutionPolicy,
class ForwardIt1, class ForwardIt2 >
ForwardIt2 copy( ExecutionPolicy&& policy,
ForwardIt1 first, ForwardIt1 last,
ForwardIt2 d_first );
|
(2) | (C++17 以降) |
template< class InputIt, class OutputIt, class UnaryPred >
OutputIt copy_if( InputIt first, InputIt last,
OutputIt d_first, UnaryPred pred );
|
(3) | (C++11 以降) (C++20 以降 constexpr) |
template< class ExecutionPolicy,
class ForwardIt1, class ForwardIt2, class UnaryPred >
ForwardIt2 copy_if( ExecutionPolicy&& policy,
ForwardIt1 first, ForwardIt1 last,
ForwardIt2 d_first, UnaryPred pred );
|
(4) | (C++17 以降) |
範囲 [first, last) 内の要素を、d_first から始まる別の範囲(コピー先範囲)にコピーします。
[first, last) 内のすべての要素を、first から last に向かってコピーします。d_first が [first, last) に含まれる場合、動作は未定義です。この場合、代わりに std::copy_backward を使用できます。policy に従って実行されます。true である場合にのみオーバーロード解決に参加します:
|
|
(C++20 まで) |
|
|
(C++20 以降) |
[first, last) とコピー先範囲が重なる場合、動作は未定義です。pred が true を返す要素のみをコピーします。このコピーアルゴリズムは安定です: コピーされる要素の相対的な順序は保持されます。[first, last) とコピー先範囲が重なる場合、動作は未定義です。policy に従って実行されます。true である場合にのみオーバーロード解決に参加します:
|
|
(C++20 まで) |
|
|
(C++20 以降) |
パラメータ
| first, last | - | コピーする要素のソース 範囲 を定義するイテレータのペア |
| d_first | - | コピー先範囲の先頭 |
| policy | - | 使用する 実行ポリシー |
| pred | - |
必要な要素に対して
true
を返す単項述語。
式
pred
(
v
)
は、
|
| 型要件 | ||
-
InputIt
は
LegacyInputIterator
の要件を満たさなければならない。
|
||
-
OutputIt
は
LegacyOutputIterator
の要件を満たさなければならない。
|
||
-
ForwardIt1, ForwardIt2
は
LegacyForwardIterator
の要件を満たさなければならない。
|
||
-
UnaryPred
は
Predicate
の要件を満たさなければならない。
|
||
戻り値
宛先範囲内の要素への出力イテレータ。コピーされた最後の要素の次の位置。
計算量
与えられた N を std:: distance ( first, last ) として:
ExecutionPolicy を取るオーバーロードでは、
ForwardIt1 の値型が
MoveConstructible
でない場合、パフォーマンスコストが生じる可能性があります。
例外
ExecutionPolicyという名前のテンプレートパラメータを持つオーバーロードは、
以下のようにエラーを報告します:
-
アルゴリズムの一部として呼び出された関数の実行が例外をスローした場合、
ExecutionPolicyが 標準ポリシー のいずれかであるとき、 std::terminate が呼び出される。それ以外のExecutionPolicyについては、動作は実装定義である。 - アルゴリズムがメモリの確保に失敗した場合、 std::bad_alloc がスローされる。
実装例
| copy (1) |
|---|
template<class InputIt, class OutputIt> OutputIt copy(InputIt first, InputIt last, OutputIt d_first) { for (; first != last; (void)++first, (void)++d_first) *d_first = *first; return d_first; } |
| copy_if (3) |
template<class InputIt, class OutputIt, class UnaryPred> OutputIt copy_if(InputIt first, InputIt last, OutputIt d_first, UnaryPred pred) { for (; first != last; ++first) if (pred(*first)) { *d_first = *first; ++d_first; } return d_first; } |
注記
実際には、
std::copy
の実装は複数の代入を回避し、値型が
TriviallyCopyable
であり、イテレータ型が
LegacyContiguousIterator
を満たす場合、
std::memmove
のような一括コピー関数を使用します。
重複する範囲をコピーする場合、
std::copy
は左方向へのコピー(コピー先範囲の先頭がコピー元範囲の外側にある場合)に適しており、
std::copy_backward
は右方向へのコピー(コピー先範囲の終端がコピー元範囲の外側にある場合)に適しています。
例
以下のコードは
std::copy
を使用して、1つの
std::vector
の内容を別の
std::vector
にコピーし、結果の
std::vector
を表示します。
#include <algorithm> #include <iostream> #include <iterator> #include <numeric> #include <vector> int main() { std::vector<int> from_vector(10); std::iota(from_vector.begin(), from_vector.end(), 0); std::vector<int> to_vector; std::copy(from_vector.begin(), from_vector.end(), std::back_inserter(to_vector)); // or, alternatively, // std::vector<int> to_vector(from_vector.size()); // std::copy(from_vector.begin(), from_vector.end(), to_vector.begin()); // either way is equivalent to // std::vector<int> to_vector = from_vector; std::cout << "to_vector contains: "; std::copy(to_vector.begin(), to_vector.end(), std::ostream_iterator<int>(std::cout, " ")); std::cout << '\n'; std::cout << "odd numbers in to_vector are: "; std::copy_if(to_vector.begin(), to_vector.end(), std::ostream_iterator<int>(std::cout, " "), [](int x) { return x % 2 != 0; }); std::cout << '\n'; std::cout << "to_vector contains these multiples of 3: "; to_vector.clear(); std::copy_if(from_vector.begin(), from_vector.end(), std::back_inserter(to_vector), [](int x) { return x % 3 == 0; }); for (const int x : to_vector) std::cout << x << ' '; std::cout << '\n'; }
出力例:
to_vector contains: 0 1 2 3 4 5 6 7 8 9 odd numbers in to_vector are: 1 3 5 7 9 to_vector contains these multiples of 3: 0 3 6 9
不具合報告
以下の動作変更の欠陥報告書は、以前に公開されたC++規格に対して遡及的に適用されました。
| DR | 適用対象 | 公開時の動作 | 正しい動作 |
|---|---|---|---|
| LWG 2039 | C++11 |
std::copy_ifの戻り値が規定されていなかった
|
規定された |
| LWG 2044 | C++11 |
std::copy_ifの安定性が定義されていなかった
|
定義された |
関連項目
| 要素の範囲を逆順にコピーする (関数テンプレート & アルゴリズム関数オブジェクト) | |
(C++20) |
|
| 範囲を反転させたコピーを作成する (関数テンプレート & アルゴリズム関数オブジェクト) | |
(C++20) |
|
(C++11) |
指定された個数の要素を新しい位置にコピーする (関数テンプレート & アルゴリズム関数オブジェクト) |
(C++20) |
|
| 範囲内のすべての要素に指定された値をコピー代入する (関数テンプレート & アルゴリズム関数オブジェクト) | |
(C++20) |
|
| 特定の条件を満たす要素を除外して要素の範囲をコピーする (関数テンプレート & アルゴリズム関数オブジェクト) | |
(C++20)(C++20) |
|
(C++20)(C++20) |
要素の範囲を新しい位置にコピーする (アルゴリズム関数オブジェクト) |