std::set_difference

 

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 InputIt1, class InputIt2, class OutputIt > OutputIt set_difference( InputIt1 first1, InputIt1 last1,                          InputIt2 first2, InputIt2 last2,                          OutputIt d_first );	(1)	(C++20 以降 constexpr)
template< class ExecutionPolicy,           class ForwardIt1, class ForwardIt2, class ForwardIt3 > ForwardIt3 set_difference( ExecutionPolicy&& policy,                            ForwardIt1 first1, ForwardIt1 last1,                            ForwardIt2 first2, ForwardIt2 last2,                            ForwardIt3 d_first );	(2)	(C++17以降)
template< class InputIt1, class InputIt2,           class OutputIt, class Compare > OutputIt set_difference( InputIt1 first1, InputIt1 last1,                          InputIt2 first2, InputIt2 last2,                          OutputIt d_first, Compare comp );	(3)	(C++20 以降 constexpr)
template< class ExecutionPolicy,           class ForwardIt1, class ForwardIt2,           class ForwardIt3, class Compare > ForwardIt3 set_difference( ExecutionPolicy&& policy,                            ForwardIt1 first1, ForwardIt1 last1,                            ForwardIt2 first2, ForwardIt2 last2,                            ForwardIt3 d_first, Compare comp );	(4)	(C++17以降)

ソート済みの範囲 [first1, last1) から、ソート済みの範囲 [first2, last2) には存在しない要素を、 d_first で始まる範囲にコピーします。出力範囲もソートされます。

もし [first1, last1) が互いに等価な m 個の要素を含み、 [first2, last2) がそれらに等価な n 個の要素を含む場合、 std::max(m - n, 0) 個の要素が [first1, last1) から出力範囲にコピーされ、順序が保持されます。

1) もし [first1, last1) または [first2, last2) が operator<(until C++20)std::less{}(since C++20) に対して ソートされていない場合、動作は未定義です。

3) もし [first1, last1) または [first2, last2) が comp に関してソートされていない場合、動作は未定義です。

2,4) (1,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以降)

出力範囲が [first1, last1) または [first2, last2) と重複する場合、動作は未定義です。

パラメータ

first1, last1	-	調べる最初の入力ソート済み 範囲を定義するイテレータのペア
first2, last2	-	検索対象となる2番目の入力ソート済み 範囲を定義するイテレータのペア
d_first	-	出力範囲の開始位置
policy	-	使用する 実行ポリシー
comp	-	比較関数オブジェクト（つまり、Compare の要件を満たすオブジェクト）。最初の引数が2番目の引数より小さい（つまり、前に順序付けられる）場合に true を返します。 比較関数のシグネチャは、以下と同等でなければならない。 bool cmp(const Type1& a, const Type2& b); シグネチャは const& を持つ必要はありませんが、関数は渡されたオブジェクトを変更してはならず、値カテゴリ に関係なく、(おそらく const の) Type1 と Type2 のすべての値を受け入れられる必要があります (したがって、Type1& は許可されません。また、Type1 のムーブがコピーと同等でない限り、Type1 も許可されません(C++11以降))。 Type1 および Type2 は、 InputIt1 および InputIt2 のオブジェクトを逆参照し、その後両方の Type1 および Type2 に暗黙的に変換できる必要があります。
型要件
- InputIt1, InputIt2 は LegacyInputIterator の要件を満たす必要がある。
- OutputIt は LegacyOutputIterator の要件を満たさなければなりません。
- ForwardIt1, ForwardIt2, ForwardIt3 は LegacyForwardIterator の要件を満たしている必要があります。
- CompareはCompareの要件を満たす必要がある。

戻り値

構築された範囲の終了位置の次を指すイテレータ。

計算量

std::distance(first1, last1) を \(\scriptsize N_1\)N1 とし、std::distance(first2, last2) を \(\scriptsize N_2\)N2 とする。

1,2) \(\scriptsize 2 \cdot (N_1+N_2)-1\)2⋅(N1+N2)-1 回以下の比較 (operator<(until C++20)std::less{}(since C++20)).

3,4) 比較関数 comp の適用は \(\scriptsize 2 \cdot (N_1+N_2)-1\)2⋅(N1+N2)-1 回以下。

例外

ExecutionPolicy というテンプレートパラメータを持つオーバーロードは、次のようにエラーを報告します。

• アルゴリズムの一部として呼び出された関数の実行が例外をスローし、ExecutionPolicy が 標準ポリシー のいずれかである場合、std::terminate が呼び出されます。その他の ExecutionPolicy の場合、動作は実装定義です。
• アルゴリズムがメモリの割り当てに失敗した場合、std::bad_alloc がスローされます。

可能な実装

set_difference (1)
template<class InputIt1, class InputIt2, class OutputIt> OutputIt set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt d_first) { while (first1 != last1) { if (first2 == last2) return std::copy(first1, last1, d_first);   if (*first1 < *first2) *d_first++ = *first1++; else { if (! (*first2 < *first1)) ++first1; ++first2; } } return d_first; }
set_difference (3)
template<class InputIt1, class InputIt2, class OutputIt, class Compare> OutputIt set_difference(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, OutputIt d_first, Compare comp) { while (first1 != last1) { if (first2 == last2) return std::copy(first1, last1, d_first);   if (comp(*first1, *first2)) *d_first++ = *first1++; else { if (!comp(*first2, *first1)) ++first1; ++first2; } } return d_first; }

例

このコードを実行

#include <algorithm>
#include <iostream>
#include <iterator>
#include <vector>
 
template<typename T>
std::ostream& operator<<(std::ostream& os, const std::vector<T>& v)
{
    os << '{';
    for (auto n{v.size()}; const auto& e : v)
        os << e << (--n ? ", " : "");
    return os << '}';
}
 
struct Order // a struct with very interesting data
{
    int order_id{};
 
    friend std::ostream& operator<<(std::ostream& os, const Order& ord)
    {
        return os << ord.order_id;
    }
};
 
int main()
{
    const std::vector<int> v1{1, 2, 5, 5, 5, 9};
    const std::vector<int> v2{2, 5, 7};
    std::vector<int> diff;
 
    std::set_difference(v1.begin(), v1.end(), v2.begin(), v2.end(),
                        std::inserter(diff, diff.begin()));
 
    std::cout << v1 << " ∖ " << v2 << " == " << diff << "\n\n";
 
    // we want to know which orders "cut" between old and new states:
    std::vector<Order> old_orders{{1}, {2}, {5}, {9}};
    std::vector<Order> new_orders{{2}, {5}, {7}};
    std::vector<Order> cut_orders;
 
    std::set_difference(old_orders.begin(), old_orders.end(),
                        new_orders.begin(), new_orders.end(),
                        std::back_inserter(cut_orders),
                        [](auto& a, auto& b) { return a.order_id < b.order_id; });
 
    std::cout << "old orders: " << old_orders << '\n'
              << "new orders: " << new_orders << '\n'
              << "cut orders: " << cut_orders << '\n';
}

出力

{1, 2, 5, 5, 5, 9} ∖ {2, 5, 7} == {1, 5, 5, 9}
 
old orders: {1, 2, 5, 9}
new orders: {2, 5, 7}
cut orders: {1, 9}

不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 291	C++98	入力範囲における等価な要素の扱いが未指定でした。	指定された

関連項目

includes	あるシーケンスが別のシーケンスの部分シーケンスである場合に true を返す (関数テンプレート)
set_symmetric_difference	2つの集合の対称差を計算する (関数テンプレート)
ranges::set_difference (C++20)	2つの集合の差を計算する (アルゴリズム関数オブジェクト)