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

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

Views

span (C++20)

 

std::set

Member functions

set::set

set::~set

set::operator=

set::get_allocator

Iterators

set::beginset::cbegin (C++11)

set::endset::cend (C++11)

set::rbeginset::crbegin (C++11)

set::rendset::crend (C++11)

Capacity

set::empty

set::size

set::max_size

Modifiers

set::clear

set::insert

set::emplace (C++11)

set::emplace_hint (C++11)

set::erase

set::swap

set::extract (C++17)

set::merge (C++17)

Lookup

set::count

set::find

set::contains (C++20)

set::equal_range

set::lower_bound

set::upper_bound

Observers

set::key_comp

set::value_comp

Non-member functions

std::swap

erase_if (C++20)

operator==operator!=operator<operator>operator<=operator>=operator<=> (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::set<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

value_comp

returns the function that compares keys in objects of type value_type (public member function)