std::ranges::remove_copy、std::ranges::remove_copy_if、std::ranges::remove_copy_result、std::ranges::remove_copy_if_result

 

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)

 

制約付きアルゴリズム

このメニューのすべての名前は名前空間 `std::ranges` に属します

シーケンスを変更しない操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

シーケンスを変更する操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

パーティション操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

ソート操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分探索操作 (ソート済み範囲)

lower_bound         upper_bound         binary_search      equal_range

集合操作 (ソート済み範囲)

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

ヒープ操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大操作

max max_element         min min_element         minmax minmax_element     clamp

順列操作

is_permutation      next_permutation    prev_permutation

畳み込み操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

数値演算 iota (C++23)             乱数生成 generate_random (C++26)

未初期化ストレージに対する操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

戻り値の型

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

ヘッダー <algorithm> で定義
呼び出しシグネチャ
	(1)
template< std::input_iterator I, std::sentinel_for<I> S,           std::weakly_incrementable O, class T, class Proj = std::identity > requires std::indirectly_copyable<I, O> &&          std::indirect_binary_predicate              <ranges::equal_to, std::projected<I, Proj>, const T*> constexpr remove_copy_result<I, O>     remove_copy( I first, S last, O result, const T& value, Proj proj = {} );			(C++20以降) (C++26まで)
template< std::input_iterator I, std::sentinel_for<I> S,           std::weakly_incrementable O, class Proj = std::identity,           class T = std::projected_value_t<I, Proj> > requires std::indirectly_copyable<I, O> &&          std::indirect_binary_predicate              <ranges::equal_to, std::projected<I, Proj>, const T*> constexpr remove_copy_result<I, O>     remove_copy( I first, S last, O result, const T& value, Proj proj = {} );			(C++26以降)
		(2)
template< ranges::input_range R,           std::weakly_incrementable O, class T, class Proj = std::identity > requires std::indirectly_copyable<ranges::iterator_t<R>, O> &&          std::indirect_binary_predicate              <ranges::equal_to,               std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr remove_copy_result<ranges::borrowed_iterator_t<R>, O>     remove_copy( R&& r, O result, const T& value, Proj proj = {} );				(C++20以降) (C++26まで)
template< ranges::input_range R,           std::weakly_incrementable O, class Proj = std::identity,           class T = std::projected_value_t<ranges::iterator_t<R>, Proj> > requires std::indirectly_copyable<ranges::iterator_t<R>, O> &&          std::indirect_binary_predicate              <ranges::equal_to,               std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr remove_copy_result<ranges::borrowed_iterator_t<R>, O>     remove_copy( R&& r, O result, const T& value, Proj proj = {} );				(C++26以降)
template< std::input_iterator I, std::sentinel_for<I> S,           std::weakly_incrementable O, class Proj = std::identity,           std::indirect_unary_predicate<std::projected<I, Proj>> Pred > requires std::indirectly_copyable<I, O> constexpr remove_copy_if_result<I, O>     remove_copy_if( I first, S last, O result, Pred pred, Proj proj = {} );			(3)	(C++20以降)
template< ranges::input_range R,           std::weakly_incrementable O, class Proj = std::identity,           std::indirect_unary_predicate<               std::projected<ranges::iterator_t<R>, Proj>> Pred > requires std::indirectly_copyable<ranges::iterator_t<R>, O> constexpr remove_copy_if_result<ranges::borrowed_iterator_t<R>, O>     remove_copy_if( R&& r, O result, Pred pred, Proj proj = {} );			(4)	(C++20以降)
ヘルパー型
template< class I, class O > using remove_copy_result = ranges::in_out_result<I, O>;			(5)	(C++20以降)
template< class I, class O > using remove_copy_if_result = ranges::in_out_result<I, O>;			(6)	(C++20以降)

ソース範囲 [first, last) から、送信先範囲の result を開始点として要素をコピーしますが、proj によって投影された後、特定の基準を満たす要素は省略されます。ソース範囲と送信先範囲が重複する場合の動作は未定義です。

1) value と等しいすべての要素を無視します。

3) 述語 pred が true を返すすべての要素を無視します。

2,4) (1,3) と同じですが、ソース範囲として r を使用し、ranges::begin(r) を first、ranges::end(r) を last として扱います。

このページで説明されている関数のようなエンティティは、アルゴリズム関数オブジェクト（非公式にはニーブロイドとして知られている）です。つまり、

• これらのいずれかを呼び出す際に、明示的なテンプレート引数リストを指定することはできません。
• これらのいずれも実引数依存の名前探索には見えません。
• これらのいずれかが関数呼び出し演算子の左側の名前として通常の非修飾名探索によって見つかった場合、実引数依存の名前探索は抑制されます。

Parameters

first, last	-	処理する要素のソース 範囲 を定義するイテレータ・センチネルのペア
r	-	ソース範囲
結果	-	コピー先範囲の先頭
value	-	コピーされない要素の値
comp	-	射影された要素を比較するための二項述語
proj	-	要素に適用される射影

Return value

{last, result + N}、ここで N はコピーされた要素の数です。

Complexity

対応する述語 comp と投影 proj の適用回数は、ranges::distance(first, last) 回です。

Notes

このアルゴリズムは安定であり、コピーされた要素の相対順序を保持します。

機能テストマクロ	値	規格	機能
__cpp_lib_algorithm_default_value_type	202403	(C++26)	アルゴリズム (1,2) のためのリスト初期化

Possible implementation

remove_copy (1,2)
struct remove_copy_fn { template<std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O, class Proj = std::identity, class T = std::projected_value_t<I, Proj>> requires std::indirectly_copyable<I, O> && std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>, const T*> constexpr ranges::remove_copy_result<I, O> operator()(I first, S last, O result, const T& value, Proj proj = {}) const { for (; !(first == last); ++first) if (value != std::invoke(proj, *first)) { *result = *first; ++result; } return {std::move(first), std::move(result)}; }   template<ranges::input_range R, std::weakly_incrementable O, class Proj = std::identity, class T = std::projected_value_t<ranges::iterator_t<R>, Proj>> requires std::indirectly_copyable<ranges::iterator_t<R>, O> && std::indirect_binary_predicate<ranges::equal_to, std::projected<ranges::iterator_t<R>, Proj>, const T*> constexpr ranges::remove_copy_result<ranges::borrowed_iterator_t<R>, O> operator()(R&& r, O result, const T& value, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(result), value, std::move(proj)); } };   inline constexpr remove_copy_fn remove_copy {};
remove_copy_if (3,4)
struct remove_copy_if_fn { template<std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O, class Proj = std::identity, std::indirect_unary_predicate<std::projected<I, Proj>> Pred> requires std::indirectly_copyable<I, O> constexpr ranges::remove_copy_if_result<I, O> operator()(I first, S last, O result, Pred pred, Proj proj = {}) const { for (; first != last; ++first) if (false == std::invoke(pred, std::invoke(proj, *first))) { *result = *first; ++result; } return {std::move(first), std::move(result)}; }   template<ranges::input_range R, std::weakly_incrementable O, class Proj = std::identity, std::indirect_unary_predicate< std::projected<ranges::iterator_t<R>, Proj>> Pred> requires std::indirectly_copyable<ranges::iterator_t<R>, O> constexpr ranges::remove_copy_if_result<ranges::borrowed_iterator_t<R>, O> operator()(R&& r, O result, Pred pred, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(result), std::move(pred), std::move(proj)); } };   inline constexpr remove_copy_if_fn remove_copy_if {};

Example

このコードを実行

#include <algorithm>
#include <array>
#include <complex>
#include <iomanip>
#include <iostream>
#include <iterator>
#include <string_view>
#include <vector>
 
void println(const auto rem, const auto& v)
{
    std::cout << rem << ' ';
    for (const auto& e : v)
        std::cout << e << ' ';
    std::cout << '\n';
}
 
int main()
{
    // Filter out the hash symbol from the given string.
    const std::string_view str{"#Small #Buffer #Optimization"};
    std::cout << "before: " << std::quoted(str) << '\n';
 
    std::cout << "after:  \"";
    std::ranges::remove_copy(str.begin(), str.end(),
                             std::ostream_iterator<char>(std::cout), '#');
    std::cout << "\"\n";
 
    // Copy only the complex numbers with positive imaginary part.
    using Ci = std::complex<int>;
    constexpr std::array<Ci, 5> source
    {
        Ci{1, 0}, Ci{0, 1}, Ci{2, -1}, Ci{3, 2}, Ci{4, -3}
    };
    std::vector<std::complex<int>> target;
 
    std::ranges::remove_copy_if
    (
        source,
        std::back_inserter(target),
        [](int imag) { return imag <= 0; },
        [](Ci z) { return z.imag(); }
    );
 
    println("source:", source);
    println("target:", target);
 
    std::vector<std::complex<float>> nums{{2, 2}, {1, 3}, {4, 8}, {1, 3}};
    std::vector<std::complex<double>> outs;
    #ifdef __cpp_lib_algorithm_default_value_type
        std::remove_copy(nums.cbegin(), nums.cend(), std::back_inserter(outs),
                         {1, 3}); // T gets deduced to std::complex<float>
    #else
        std::remove_copy(nums.cbegin(), nums.cend(), std::back_inserter(outs),
                         std::complex<float>{1, 3});
    #endif
    println("nums:  ", nums);
    println("outs:  ", outs);
}

出力

before: "#Small #Buffer #Optimization"
after:  "Small Buffer Optimization"
source: (1,0) (0,1) (2,-1) (3,2) (4,-3)
target: (0,1) (3,2)
nums:   (2,2) (1,3) (4,8) (1,3)
outs:   (2,2) (4,8)

See also

ranges::removeranges::remove_if (C++20)(C++20)	特定の基準を満たす要素を削除する (アルゴリズム関数オブジェクト)
ranges::copyranges::copy_if (C++20)(C++20)	要素の範囲を新しい場所にコピーする (アルゴリズム関数オブジェクト)
ranges::copy_n (C++20)	指定された数の要素を新しい場所にコピーする (アルゴリズム関数オブジェクト)
ranges::copy_backward (C++20)	要素の範囲を逆順にコピーする (アルゴリズム関数オブジェクト)
ranges::replace_copyranges::replace_copy_if (C++20)(C++20)	特定の基準を満たす要素を別の値に置き換えながら範囲をコピーする (アルゴリズム関数オブジェクト)
ranges::reverse_copy (C++20)	逆順になった範囲のコピーを作成する (アルゴリズム関数オブジェクト)
ranges::rotate_copy (C++20)	要素の範囲をコピーして回転させる (アルゴリズム関数オブジェクト)
ranges::unique_copy (C++20)	連続する重複を含まない要素の範囲のコピーを作成する (アルゴリズム関数オブジェクト)
remove_copyremove_copy_if	特定の基準を満たす要素を除外して範囲をコピーする (関数テンプレート)