std::copy, std::copy_if

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (C++20)
制約付きアルゴリズム、例: ranges::copy, ranges::sort, ...
実行ポリシー (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
シーケンスを変更しない操作 一括操作 for_each for_each_n (C++17) 検索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n シーケンスを変更する操作 コピー操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) スワップ操作 swap iter_swap swap_ranges 変換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 削除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序変更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17まで)(C++11) shift_leftshift_right (C++20)(C++20) サンプリング操作 sample (C++17)	ソートおよび関連操作 パーティション操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) ソート操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分探索操作 (パーティション化された範囲) lower_bound upper_bound equal_range binary_search 集合操作 (ソート済み範囲) includes set_union set_intersection set_difference set_symmetric_difference マージ操作 (ソート済み範囲) merge inplace_merge ヒープ操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 辞書順比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 順列操作 next_permutation prev_permutation is_permutation (C++11) Cライブラリ qsort bsearch
数値演算
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初期化メモリに対する操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

ヘッダー <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 から始まる別の範囲 (コピー先範囲) にコピーします。

1) [first, last) の範囲のすべての要素を、first から last へ順にコピーします。

d_first が [first, last) にある場合、動作は未定義です。この場合、代わりに std::copy_backward を使用できます。

2) 要素をコピーしますが、policy に従って実行されます。

このオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加します。

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である。	(C++20まで)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> が true である。	(C++20以降)

[first, last) とコピー先範囲が重なる場合、動作は未定義です。

3) 述語 pred が true を返す要素のみをコピーします。このコピーアルゴリズムは安定しています。コピーされる要素の相対順序は保持されます。

[first, last) とコピー先範囲が重なる場合、動作は未定義です。

4) (3) と同じですが、policy に従って実行されます。

このオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加します。

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である。	(C++20まで)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> が true である。	(C++20以降)

パラメーター

first, last	-	コピーする要素のソース 範囲 を定義するイテレータペア
d_first	-	コピー先範囲の先頭
policy	-	使用する 実行ポリシー
pred	-	必要な要素に対して true を返す単項述語。 式 pred(v) は、型 (const の可能性あり) VT のすべての引数 v に対して bool に変換可能でなければならず、v を変更してはなりません。ここで、VT は InputIt の値型であり、値カテゴリ に関係なく、VT& のパラメータ型は許可されません。また、VT の移動がコピーと同じでない限り VT も許可されません(C++11 以降)。
型要件
- InputIt は LegacyInputIterator の要件を満たす必要があります。
- OutputIt は LegacyOutputIterator の要件を満たさなければなりません。
- ForwardIt1, ForwardIt2 は LegacyForwardIterator の要件を満たさなければなりません。
- UnaryPred は Predicate の要件を満たさなければなりません。

戻り値

コピーされた最後の要素の次を指す、コピー先範囲の出力イテレータ。

計算量

std::distance(first, last) を \(\scriptsize N\)N とする

1,2) 正確に \(\scriptsize N\)N 回の代入。

3,4) 述語 pred の適用が正確に \(\scriptsize N\)N 回、代入は最大 \(\scriptsize N\)N 回。

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::vector の内容を別の std::vector にコピーし、その結果の std::vector を表示するために、std::copy を使用しています。

このコードを実行

#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 の安定性が定義されていなかった	defined

関連項目

copy_backward	要素の範囲を逆順にコピーする (関数テンプレート)
reverse_copy	逆順になった範囲のコピーを作成する (関数テンプレート)
copy_n (C++11)	指定された数の要素を新しい場所にコピーする (関数テンプレート)
fill	範囲内のすべての要素に指定された値をコピー代入する (関数テンプレート)
remove_copyremove_copy_if	特定の基準を満たす要素を除外して範囲をコピーする (関数テンプレート)
ranges::copyranges::copy_if (C++20)(C++20)	要素の範囲を新しい場所にコピーする (アルゴリズム関数オブジェクト)