std::equal_range

ヘッダ `<algorithm>`
template< class ForwardIt, class T > std::pair<ForwardIt, ForwardIt> equal_range( ForwardIt first, ForwardIt last, const T& value );	で定義 (1)	(C++26 まで) (C++20 から constexpr)
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 );	で定義 (1)		(C++26 から)
template< class ForwardIt, class T, class Compare > std::pair<ForwardIt, ForwardIt> equal_range( ForwardIt first, ForwardIt last, const T& value, Compare comp );	(2)	(C++26 まで) (C++20 から constexpr)
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 );	(2)		(C++26 から)

分割された範囲 value 内の [first, last) と同等なすべての要素を含む範囲を返します。

1) 同値性は operator< を使用してチェックされます:

std::lower_bound(first, last, value) と std::upper_bound(first, last, value) の結果を返します。

以下の条件のいずれかが満たされる場合、動作は未定義です:

elem の任意の要素 [first, last) について、bool(elem < value) は !bool(value < elem) を意味しません。
elem の要素 [first, last) は、式とに関して bool(elem < value) 分割されていません。!bool(value < elem)

(C++20 まで)

std::equal_range(first, last, value, std::less{}) と同等です。

(C++20 から)

2) 同値性は comp を使用してチェックされます:

std::lower_bound(first, last, value, comp) と std::upper_bound(first, last, value, comp) の結果を返します。

以下の条件のいずれかが満たされる場合、動作は未定義です:

elem の任意の要素 [first, last) について、bool(comp(elem, value)) は !bool(comp(value, elem)) を意味しません。
elem の要素 [first, last) は、式とに関して bool(comp(elem, value)) 分割されていません。!bool(comp(value, elem))目次

first, last

-	調査する分割された	範囲の要素のイテレータ対 value
-	要素と比較する値	comp
-	最初の引数が2番目の引数より前に順序付けられる場合に	を返す二項述語。 `true`述語関数のシグネチャは以下と同等であるべきです: シグネチャに `bool pred(const Type1 &a, const Type2 &b);` が含まれている必要はありませんが、関数は渡されたオブジェクトを変更してはならず、型 (const) `const &` および `Type1` のすべての値を `Type2` 値カテゴリに関係なく受け入れられなければなりません (したがって、は許可されません、また `Type1 &` も許可されません。ただしの場合、ムーブがコピーと同等である場合を除く`Type1` (C++11 から)`Type1`)。型およびは、型 `Type1` のオブジェクトが `Type2` と `T` の両方に暗黙的に変換可能であり、型 `Type1` のオブジェクトが逆参照されて `Type2` と `ForwardIt` の両方に暗黙的に変換可能である必要があります。 `Type1`型要件 `Type2`-
は
LegacyForwardIterator `ForwardIt` の要件を満たさなければなりません。 - は
BinaryPredicate `Compare` の要件を満たさなければなりません。 Compare を満たす必要はありません。戻り値A

std::pair

イテレータのペアを含みます。ここでは範囲内で

first より前に順序付けられていない最初の要素へのイテレータ (そのような要素が見つからない場合は [first, last))、およびvalue は範囲 last 内で
second より後に順序付けられた最初の要素へのイテレータ (そのような要素が見つからない場合は [first, last)) です。value計算量lastGiven

$\scriptsize N$

N as $:$ 1)std::distance(first, last)

$\scriptsize 2\log_{2}(N)+O(1)$2log

(N)+O(1) max 回の比較を を使用して行います

(C++20 まで)value(C++20 から)operator<。std::less{}2)

$\scriptsize 2\log_{2}(N)+O(1)$2log

(N)+O(1) max 回の比較子 の適用を行います。

ただし、comp が

LegacyRandomAccessIteratorForwardIt でない場合、イテレータのインクリメント回数は $\scriptsize N$N $std::set$ および std::multiset のイテレータはランダムアクセスではないため、それらのメンバ関数 std::set::equal_range (それぞれ std::multiset::equal_range) を使用するべきです。注記

は

が分割されていることのみを要求しますが、このアルゴリズムは通常 std::equal_range がソートされている場合に使用され、任意の [first, last) に対して二分探索が有効になります。 [first, last)valuestd::lower_bound

および std::upper_bound の要件に加えて、はまたは std::equal_range が非対称であること (すなわち、operator< と comp が常に異なる結果を持つこと) も要求します。 a < bしたがって、二分探索の中間結果は b < astd::lower_bound

と std::upper_bound で共有できます。例えば、std::lower_bound 呼び出しの結果を std::upper_bound 呼び出しの引数として使用できます。 first機能テストマクロ値

Std機能	(C++26)	アルゴリズムのリスト初期化	(
`__cpp_lib_algorithm_default_value_type`	`202403`	1,2	)実装例equal_range (1)equal_range (2)例

このコードを実行する

出力:

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{});
}

欠陥報告

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));
}

以下の動作変更欠陥報告は、以前に公開された C++ 標準に遡及的に適用されました。

DR

#include <algorithm>
#include <complex>
#include <iostream>
#include <vector>

struct S
{
    int number;
    char name;
    // note: name is ignored by this comparison operator
    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()
{
    // note: not ordered, only partitioned w.r.t. S defined below
    const std::vector<S> vec{{1, 'A'}, {2, 'B'}, {2, 'C'},
                             {2, 'D'}, {4, 'G'}, {3, 'F'}};
    const S value{2, '?'};
    
    std::cout << "Compare using 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 << "Using heterogeneous comparison: ";
    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';
}

適用先

Compare using S::operator<(): B C D 
Using heterogeneous comparison: B C D
(2,2) (2, 1)

公開された動作

正しい動作

LWG 270	C++98	は	Compare
を満たす必要があり、	は	`Compare`LessThanComparable である必要がありました (狭義の弱順序が必要) 分割のみが必要; `T`異種比較が許可される LWG 384C++98 最大	$\scriptsize 2\log_{2}(N)+1$ 2log
2	(N)+1	回の比較が許可されていましたが、実装不可能でした1 $$\scriptsize 2\log_{2}(N)+O(1)$2log$ 2 (N)+O(1)^{[ に修正されました]}	↑ $を単一要素範囲に適用するには 2 回の比較が必要ですが、計算量要件では最大 1 回の比較しか許可されていません。関連項目 lower_bound$

二分探索を使用して、指定された値より小さくない最初の要素を見つける (関数テンプレート equal_range アルゴリズム関数オブジェクト)

ranges::lower_bound

(C++20)	upper_bound 二分探索を使用して、指定された値より大きい最初の要素を見つける&(関数テンプレート
アルゴリズム関数オブジェクト) ranges::upper_bound	upper_bound 二分探索を使用して、指定された値より大きい最初の要素を見つける&(関数テンプレート
(C++20)	binary_search 二分探索を使用して、範囲内に要素が存在するかどうかを判定する&(関数テンプレート
アルゴリズム関数オブジェクト) ranges::binary_search	binary_search 二分探索を使用して、範囲内に要素が存在するかどうかを判定する&(関数テンプレート
(C++20)	partition 要素の範囲を2つのグループに分割する&(関数テンプレート
アルゴリズム関数オブジェクト) ranges::partition	partition 要素の範囲を2つのグループに分割する&(関数テンプレート
(C++20)	equal 2つの要素の集合が同じかどうかを判定する&(関数テンプレート
アルゴリズム関数オブジェクト) ranges::equal	equal 2つの要素の集合が同じかどうかを判定する&(関数テンプレート
(C++20)	equal_range 特定のキーに一致する要素の範囲を返す &(
の公開メンバ関数) equal_range	equal_range 特定のキーに一致する要素の範囲を返す &(
特定のキーに一致する要素の範囲を返す	( の公開メンバ関数)`std::set<Key,Compare,Allocator>`ranges::equal_range
(C++20)	二分探索を使用して指定された値に一致する要素の範囲を見つける (アルゴリズム関数オブジェクト)`std::multiset<Key,Compare,Allocator>`
ranges::equal_range (C++20)	二分探索を使用して指定された値に一致する要素の範囲を見つける (アルゴリズム関数オブジェクト)

[1] 二分探索を使用して、指定された値より小さくない最初の要素を見つける (関数テンプレート equal_range アルゴリズム関数オブジェクト)

[ に修正されました]

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
一般ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
レンジライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日時ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボルインデックス
外部ライブラリ

ja.cppreference.net

Namespaces

Variants