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

> C++ Atlas: `cppatlas.com/w/cpp/container/set/key_comp` | Source: https://en.cppreference.com/w/cpp/container/set/key_comp | Domain: Containers | Standards: C++98

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.

## Official Specification Summary (cppreference)

```cpp
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

```cpp
#include <iostream>
#include <set>
#include <utility>

// Example module 97 key compare function
struct ModCmp
{
    bool operator()(int lhs, 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 (const int key : cont)
    {
        const bool before = comp_func(key, 100);
        const bool after = comp_func(100, key);

        std::cout << '(' << key << ") ";
        if (!before && !after)
            std::cout << "equivalent to key (100)\n";
        else if (before)
            std::cout << "goes before key (100)\n";
        else if (after)
            std::cout << "goes after key (100)\n";
        else
            std::unreachable();
    }
}
```

Output:

```text
Key (1) goes before key (100)
Key (2) goes before key (100)
Key (3) equivalent to key (100)
Key (4) goes after key (100)
Key (5) goes after key (100)
```

### See also

- [`value_comp`](https://en.cppreference.com/w/cpp/container/set/value_comp): returns the function that compares keys in objects of type `value_type` (public member function)

---
Attribution: content from https://en.cppreference.com/w/cpp/container/set/key_comp (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.