std::multiset<Key,Compare,Allocator>::key_comp

From cppreference.com
< cpp‎ | container‎ | multiset

 
C++
 
Containers library
 
std::multiset
Member functions
Iterators
(C++11)
(C++11)
(C++11)
(C++11)
Capacity
Modifiers
(C++23)
(C++11)
(C++11)
(C++17)
(C++17)
Lookup
(C++20)
Observers
multiset::key_comp
Non-member functions
(C++20)
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)
Deduction guides(C++17)
 
key_compare key_comp() const;

Returns the function object that compares the keys, which is a copy of this container's constructor argument comp. It is the same as value_comp.

Parameters

(none)

Return value

The key comparison function object.

Complexity

Constant.

Example

Run this code
#include <cassert>
#include <iostream>
#include <set>
 
// Example module 97 key compare function
struct ModCmp {
    bool operator()(const int lhs, const int rhs) const
    {
        return (lhs % 97) < (rhs % 97);
    }
};
 
int main()
{
    std::multiset<int, ModCmp> cont{1, 2, 3, 4, 5};
 
    auto comp_func = cont.key_comp();
 
    for (int key : cont) {
        bool before = comp_func(key, 100);
        bool after = comp_func(100, key);
        if (!before && !after)
            std::cout << key << " equivalent to key 100\n";
        else if (before)
            std::cout << key << " goes before key 100\n";
        else if (after)
            std::cout << key << " goes after key 100\n";
        else
            assert(0); // Cannot happen
    }
}

Output: 

1 goes before key 100
2 goes before key 100
3 equivalent to key 100
4 goes after key 100
5 goes after key 100

See also

 returns the function that compares keys in objects of type value_type
(public member function)
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/multiset/key_comp&oldid=135955"