C++ STLのmultimap::key_comp()関数の使い方を徹底解説

本記事では、C++ STLにおけるmultimap::key_comp()関数の仕組み、構文、そして具体的なコード例について詳しく解説します。

C++ STLにおけるmultimapとは？

multimapは連想コンテナの一種で、mapコンテナとよく似た性質を持っています。キー値（key）とマップ値（mapped value）の組み合わせからなる要素を、特定の順序で格納することができます。multimapコンテナの最大の特徴は、同じキーに対して複数の要素を関連付けられる点です。また、データは内部的に常に、関連付けられたキーに基づいて自動的にソートされます。

multimap::key_comp()とは？

multimap::key_comp()は、<map>ヘッダーファイルに含まれる関数です。この関数は、キー比較オブジェクトのコピーを返します。デフォルトでは「より小さい（less than）」を表すオブジェクトであり、比較演算子<と同じように動作します。このオブジェクトは、multimapコンテナ内の要素キーの順序を判定するために使用されます。関数は2つの引数を受け取ってそれぞれのキーを比較し、最初の要素が小さくて2番目の要素の前に配置されるべき場合はtrueを、そうでない場合はfalseを返します。

構文

Key_compare.key_comp();

パラメータ

この関数は引数を受け取りません。

戻り値

キー比較用のオブジェクトを返します。

入力例

multimap<char, int> newmap;
multimap<char, int> :: key_compare cmp = newmap.key_comp();
newmap.insert(make_pair('A', 1));
newmap.insert(make_pair('B', 2));
newmap.insert(make_pair('C', 3));

出力例

A= 1
B= 2
C= 3

使用例

#include <iostream>
#include <map>
using namespace std;
int main(){
    multimap<int, char> mul;
    multimap<int, char>::key_compare cmp = mul.key_comp();
    //指定したキーに要素を挿入
    mul.insert(make_pair(0, 'A'));
    mul.insert(make_pair(1, 'B'));
    mul.insert(make_pair(2, 'C'));
    mul.insert(make_pair(3, 'D'));
    int a = mul.rbegin()->first;
    multimap<int, char>::iterator it = mul.begin();
    cout<<"Elements at given key is : "<<'\n';
    do {
        cout << it->first << " = " << it->second << '\n';
    }
    while (cmp((*it++).first, a));
    return 0;
}

出力結果

上記のコードを実行すると、以下のような出力が得られます。

Elements at given key is :
0 = A
1 = B
2 = C
3 = D

このように、key_comp()で取得した比較オブジェクトを使うことで、コンテナ内部のソート順序と同じ基準でキーを比較しながら要素を走査することができます。multimapを活用した実装において、キーの順序判定をカスタマイズしたい場合にも非常に便利な機能です。