std::map::equal_range

pair<iterator, iterator> equal_range(const key_type& x); // (1)

template <class K>
pair<iterator, iterator> equal_range(const K& x);        // (2) C++14

pair<const_iterator, const_iterator>
  equal_range(const key_type& x) const;                  // (3)

template <class K>
pair<const_iterator, const_iterator>
  equal_range(const K& x) const;                         // (4) C++14

概要

コンテナ内の、x と等しいキー要素を全て含む範囲の境界を返す。map コンテナではキーの重複は無いため、この範囲は最大一つの要素を含む。

もし x がコンテナ内のどのキーともマッチしなかった場合、戻り値の範囲は長さ 0 になり、両方のイテレータは x より大きく最も近い値を指す。そうでない場合、x がコンテナ内の全ての要素よりも大きい場合は end を指す。

• (1) : key_type型のキーを受け取り、そのキーと等価なキー要素を全て含むイテレータ範囲を取得する。
• (2) : key_typeと比較可能なK型のキーを受け取り、そのキーと等価なキー要素を全て含むイテレータ範囲を取得する。
• (3) : constな*thisオブジェクトにおいて、key_type型のキーを受け取り、そのキーと等価なキー要素を全て含むイテレータ範囲を取得する。
• (4) : constな*thisオブジェクトにおいて、key_typeと比較可能なK型のキーを受け取り、そのキーと等価なキー要素を全て含むイテレータ範囲を取得する。

戻り値

この関数は pair を返す。ここで pair::first は lower_bound(x) が返すであろう値と同じ値で範囲の下境界にあたり、pair::second は upper_bound(x) が返すであろう値と同じ値で範囲の上境界にあたる。

計算量

size について対数時間。

備考

• (2), (4) : この関数がオーバーロード解決に参加する条件は、find()メンバ関数の備考欄を参照。

例

#include <iostream>
#include <string>
#include <map>

int main()
{
  std::map<std::string, int> m = {
    {"A", 3},
    {"B", 1},
    {"C", 4},
    {"D", 5}
  };

  using iterator = decltype(m)::iterator;
  std::pair<iterator, iterator> ret = m.equal_range("B");

  for (iterator it = ret.first; it != ret.second; ++it) {
    std::cout << it->first << "," << it->second << std::endl;
  }
}

出力

B,1

関連項目

参照

• N3657 Adding heterogeneous comparison lookup to associative containers (rev 4)