std::set_difference

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
Partitioning operations
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
set_difference
堆操作
(C++11)
最小/最大操作
(C++11)
(C++17)

排列
数值运算
未初始化存储上的操作
(C++17)
(C++17)
(C++17)
C 库
 
在标头 <algorithm> 定义
(1)
template< class InputIt1, class InputIt2, class OutputIt >

OutputIt set_difference( InputIt1 first1, InputIt1 last1,

                         InputIt2 first2, InputIt2 last2, OutputIt d_first );
(C++20 前)
template< class InputIt1, class InputIt2, class OutputIt >

constexpr OutputIt set_difference( InputIt1 first1, InputIt1 last1,
                                   InputIt2 first2, InputIt2 last2,

                                   OutputIt d_first );
(C++20 起)
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 起)
(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 );
(C++20 前)
template< class InputIt1, class InputIt2, class OutputIt, class Compare >

constexpr OutputIt set_difference( InputIt1 first1, InputIt1 last1,
                                   InputIt2 first2, InputIt2 last2,

                                   OutputIt d_first, Compare comp );
(C++20 起)
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 个与它们等价的元素,那么将从 [first1, last1) 保持顺序复制最后 std::max(m - n, 0) 个元素到输出范围。

1)operator< 比较元素,而范围必须相对于相同标准已排序。
3) 用给定的二元比较函数 comp 比较元素,而范围必须相对相同标准已排序。
2,4)(1,3),但按照 policy 执行。这些重载只有在

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>

(C++20 前)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>

(C++20 起)
true 时才会参与重载决议。

如果任一输入范围没有(分别按照 operator<comp)排序,或者与输出范围重叠,那么行为未定义。

参数

first1, last1 - 要检验的元素范围
first2, last2 - 要搜索的元素范围
d_first - 输出范围的起始
policy - 所用的执行策略。细节见执行策略
comp - 比较函数对象(即满足比较 (Compare) 概念的对象),在第一参数小于(即 序于)第二参数时返回 ​true

比较函数的签名应等价于如下:

bool cmp(const Type1 &a, const Type2 &b);

虽然签名不必有 const&,函数也不能修改传递给它的对象,而且必须接受(可为 const 的)类型 Type1Type2 的值,无关乎值类别(从而不允许 Type1& ,也不允许 Type1,除非 Type1 的移动等价于复制 (C++11 起))。
类型 Type1Type2 必须使得 InputIt1InputIt2 类型的对象在解引用后能隐式转换到 Type1Type2 两者。 ​

类型要求
-
InputIt1, InputIt2 必须符合老式输入迭代器 (LegacyInputIterator) 的要求。
-
OutputIt 必须符合老式输出迭代器 (LegacyOutputIterator) 的要求。
-
ForwardIt1, ForwardIt2, ForwardIt3 必须符合老式向前迭代器 (LegacyForwardIterator) 的要求。

返回值

构造的范围的尾后迭代器。

复杂度

分别给定 MNstd::distance(first1, last1)std::distance(first2, last2)

1,2) 最多应用 2·(M + N) - 1operator< 进行比较
3,4) 最多应用 2·(M + N) - 1 次谓词 p

异常

拥有名为 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 <string_view>
#include <vector>
 
auto print = [](const auto& v, std::string_view end = "")
{
    std::cout << "{ ";
    for (auto i : v) std::cout << i << ' ';
    std::cout << "} " << end;
};
 
struct Order // 拥有某些有趣数据的类
{
    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()));
    print(v1, "∖ ");
    print(v2, "= ");
    print(diff, "\n");
 
    // 我们想知道新订单和旧订单相比“砍掉了”哪些:
    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 << "旧订单     = "; print(old_orders, "\n");
    std::cout << "新订单     = "; print(new_orders, "\n");
    std::cout << "砍掉的订单 = "; print(cut_orders, "\n");
}

输出:

{ 1 2 5 5 5 9 } ∖ { 2 5 7 } = { 1 5 5 9 }
旧订单     = { 1, 2, 5, 9, } 
新订单     = { 2, 5, 7, } 
砍掉的订单 = { 1, 9, }

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 291 C++98 未指定如何处理输入范围中等价的值 已指定处理方法

参阅

若一个序列是另一个的子列则返回 true
(函数模板)
计算两个集合的对称差
(函数模板)
计算两个集合的差集
(niebloid)