std::equal_range

来自cppreference.com
< cpp‎ | algorithm
 
C++
 
算法库
受约束算法及范围上的算法 (C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作（在已划分范围上）
equal_range
集合操作（在有序范围上）
归并操作（在有序范围上）
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
(C++20)
排列操作
C 库

数值运算
(C++11)                       
在未初始化内存上的操作
 
在标头 <algorithm> 定义
(1)
template< class ForwardIt, class T >

std::pair<ForwardIt, ForwardIt>

    equal_range( ForwardIt first, ForwardIt last, const T& value );
 (C++20 起为 constexpr)
(C++26 前)
template< class ForwardIt, class T = typename std::iterator_traits

                                         <ForwardIt>::value_type >
constexpr std::pair<ForwardIt, ForwardIt>

    equal_range( ForwardIt first, ForwardIt last, const T& value );
 (C++26 起)
(2)
template< class ForwardIt, class T, class Compare >

std::pair<ForwardIt, ForwardIt>
    equal_range( ForwardIt first, ForwardIt last,

                 const T& value, Compare comp );
 (C++20 起为 constexpr)
(C++26 前)
template< class ForwardIt, class T = typename std::iterator_traits

                                         <ForwardIt>::value_type,
          class Compare >
constexpr std::pair<ForwardIt, ForwardIt>
    equal_range( ForwardIt first, ForwardIt last,

                 const T& value, Compare comp );
 (C++26 起)

返回范围 [first, last) 中包含所有等价于 value 的元素的范围。

1) 通过 operator< 检查元素是否等价：

返回 std::lower_bound(first, last, value) 和 std::upper_bound(first, last, value) 的结果。

如果满足以下任意条件，那么行为未定义：

  • [first, last) 的某些元素 elem 使得无法通过 bool(elem < value) 得出 !bool(value < elem)。
  • [first, last) 的元素 elem 没有按表达式 bool(elem < value) 和 !bool(value < elem) 划分。
(C++20 前)

等价于 std::binary_search(first, last, value, std::less{})。

(C++20 起)
2) 通过 comp 检查元素是否等价：
返回 std::lower_bound(first, last, value, comp) 和 std::upper_bound(first, last, value, comp) 的结果。
如果满足以下任意条件，那么行为未定义：
  • [first, last) 的某些元素 elem 使得无法通过 bool(comp(elem, value)) 得出 !bool(comp(value, elem))。
  • [first, last) 的元素 elem 没有按表达式 bool(comp(elem, value)) 和 !bool(comp(value, elem)) 划分。

参数

first, last - 要检验的已划分元素范围
value - 要与元素比较的值
comp - 如果第一个实参先序于第二个则返回 ​true 的二元谓词。

谓词函数的签名应等价于如下：

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

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

类型要求
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator) 。
-
Compare 必须满足二元谓词 (BinaryPredicate) 。不要求满足比较 (Compare) 。

返回值

包含一对迭代器的 std::pair，其中：

  • first 是到范围 [first, last) 的第一个不先序于 value 的元素的迭代器（或者在找不到这种元素时是 last）。
  • second 是到范围 [first, last) 的第一个后序于 value 的元素的迭代器（或者在找不到这种元素时是 last）。

复杂度

给定 N 为 std::distance(first, last)：

1,2) 最多应用 2log
2(N)+O(1) 次 operator< (C++20 前)std::less{} (C++20 起) 进行比较。
3,4) 最多应用 2log
2(N)+O(1) 次比较函数 comp。

然而，如果 ForwardIt 不是老式随机访问迭代器 (LegacyRandomAccessIterator) ，那么迭代器自增次数与 N 成线性。要注意 std::set 和 std::multiset 的迭代器不是随机访问的，因此应当优先使用它们的成员函数std::set::equal_range 和 std::multiset::equal_range。

功能特性测试宏 值 标准 功能特性
__cpp_lib_algorithm_default_value_type 202403 (C++26) 算法中的列表初始化 (1,2)

可能的实现

equal_range (1) 
template<class ForwardIt,
         class T = typename std::iterator_traits<ForwardIt>::value_type>
constexpr std::pair<ForwardIt, ForwardIt> 
    equal_range(ForwardIt first, ForwardIt last, const T& value)
{
    return std::equal_range(first, last, value, std::less{});
}
equal_range (2) 
template<class ForwardIt,
         class T = typename std::iterator_traits<ForwardIt>::value_type,
         class Compare>
constexpr std::pair<ForwardIt, ForwardIt>
    equal_range(ForwardIt first, ForwardIt last, const T& value, Compare comp)
{
    return std::make_pair(std::lower_bound(first, last, value, comp),
                          std::upper_bound(first, last, value, comp));
}

示例

运行此代码
#include <algorithm>
#include <complex>
#include <iostream>
#include <vector>
 
struct S
{
    int number;
    char name;
    // 注意：此比较运算符会忽略 name
    bool operator< ( const S& s ) const { return number < s.number; }
};
 
struct Comp
{
    bool operator() ( const S& s, int i ) const { return s.number < i; }
    bool operator() ( int i, const S& s ) const { return i < s.number; }
};
 
int main()
{
    // 注意：无序，只按下面定义的 S 划分
    const std::vector<S> vec{{1, 'A'}, {2, 'B'}, {2, 'C'},
                             {2, 'D'}, {4, 'G'}, {3, 'F'}};
    const S value = {2, '?'};
 
    std::cout << "使用 S::operator<() 进行比较：";
    const auto p = std::equal_range(vec.begin(), vec.end(), value);
 
    for (auto it = p.first; it != p.second; ++it)
        std::cout << it->name << ' ';
    std::cout << '\n';
 
    std::cout << "使用异相比较：";
    const auto p2 = std::equal_range(vec.begin(), vec.end(), 2, Comp{});
 
    for (auto it = p2.first; it != p2.second; ++it)
        std::cout << it->name << ' ';
    std::cout << '\n';
 
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 0}, {2, 2}, {2, 1}, {3, 0}, {3, 1}};
    auto cmpz = [](CD x, CD y) { return x.real() < y.real(); };
    #ifdef __cpp_lib_algorithm_default_value_type
        auto p3 = std::equal_range(nums.cbegin(), nums.cend(), {2, 0}, cmpz);
    #else
        auto p3 = std::equal_range(nums.cbegin(), nums.cend(), CD{2, 0}, cmpz);
    #endif
 
    for (auto it = p3.first; it != p3.second; ++it)
        std::cout << *it << ' ';
    std::cout << '\n';
}

输出： 

使用 S::operator<() 进行比较：B C D 
使用异相比较：B C D 
(2,2) (2, 1)

缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
LWG 270 C++98 Compare 需要满足比较 (Compare) ，并且 T 需要是
可小于比较 (LessThanComparable) 的（要求严格弱序） 		只需要划分；
允许异相比较
LWG 384 C++98 最多允许 2log
2(N)+1 次比较，但是无法实现[1] 		改成 2log
2(N)+O(1) 次
  1. ↑ 对包含单个元素的范围应用 equal_range 至少需要 2 次比较，但是复杂度要求最多只允许 1 次比较

参阅

 返回指向第一个不小于 给定值的元素的迭代器
(函数模板)
返回指向第一个大于 给定值的元素的迭代器
(函数模板)
确定元素是否存在于某部分有序的范围中
(函数模板)
将范围中的元素分为两组
(函数模板)
确定两个元素集合是否是相同的
(函数模板)
返回匹配特定键的元素范围
(std::set<Key,Compare,Allocator> 的公开成员函数)
返回匹配特定键的元素范围
(std::multiset<Key,Compare,Allocator> 的公开成员函数)
(C++20)
 返回匹配特定键的元素范围
(niebloid)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/algorithm/equal_range&oldid=91302”