std::set - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# std::set

From cppreference.com
< cpp‎ | container

Defined in header `<set>` |  |
template< class Key, class Compare = std::less<Key>, class Allocator = std::allocator<Key> > class set; | (1) |
namespace pmr { template <class Key, class Compare = std::less<Key>> using set = std::set<Key, Compare, std::pmr::polymorphic_allocator<Key>>; } | (2) | (since C++17)

`std::set` is an associative container that contains a sorted set of unique objects of type `Key`. Sorting is done using the key comparison function `Compare`. Search, removal, and insertion operations have logarithmic complexity. Sets are usually implemented as red-black trees.

Everywhere the standard library uses the `Compare` concept, uniqueness is determined by using the equivalence relation. In imprecise terms, two objects `a` and `b` are considered equivalent if neither compares less than the other: `!comp(a, b) && !comp(b, a)`.

`std::set` meets the requirements of `Container`, `AllocatorAwareContainer`, `AssociativeContainer` and `ReversibleContainer`.

### [edit] Member types

Member type | Definition
`key_type` | `Key` [edit]
`value_type` | `Key` [edit]
`size_type` | Unsigned integer type (usually std::size_t) [edit]
`difference_type` | Signed integer type (usually std::ptrdiff_t) [edit]
`key_compare` | `Compare` [edit]
`value_compare` | `Compare` [edit]
`allocator_type` | `Allocator` [edit]
`reference` |
`Allocator::reference` | (until C++11)
`value_type&` | (since C++11)
[edit]
`const_reference` |
`Allocator::const_reference` | (until C++11)
`const value_type&` | (since C++11)
[edit]
`pointer` |
`Allocator::pointer` | (until C++11)
std::allocator_traits<Allocator>::pointer | (since C++11)
[edit]
`const_pointer` |
`Allocator::const_pointer` | (until C++11)
std::allocator_traits<Allocator>::const_pointer | (since C++11)
[edit]
`iterator` |
`BidirectionalIterator` | (until C++11)
Constant `BidirectionalIterator` | (since C++11)
[edit]
`const_iterator` | Constant bidirectional iterator [edit]
`reverse_iterator` | std::reverse_iterator<iterator> [edit]
`const_reverse_iterator` | std::reverse_iterator<const_iterator> [edit]
`node_type` | a specialization of node handle representing a container node (since C++17) [edit]
`insert_return_type` | type describing the result of inserting a `node_type`, a specialization of
    template <class Iterator, class NodeType> struct /*unspecified*/ {
        Iterator position;
        bool     inserted;
        NodeType node;
    };
instantiated with template arguments `iterator` and `node_type`. (since C++17) [edit]

### [edit] Member functions

(constructor) | constructs the `set` (public member function) [edit]
(destructor) | destructs the `set` (public member function) [edit]
operator= | assigns values to the container (public member function) [edit]
get_allocator | returns the associated allocator (public member function) [edit]
##### Iterators
begin cbegin | returns an iterator to the beginning (public member function) [edit]
end cend | returns an iterator to the end (public member function) [edit]
rbegin crbegin | returns a reverse iterator to the beginning (public member function) [edit]
rend crend | returns a reverse iterator to the end (public member function) [edit]
##### Capacity
empty | checks whether the container is empty (public member function) [edit]
size | returns the number of elements (public member function) [edit]
max_size | returns the maximum possible number of elements (public member function) [edit]
##### Modifiers
clear | clears the contents (public member function) [edit]
insert | inserts elements or nodes (since C++17) (public member function) [edit]
emplace (C++11) | constructs element in-place (public member function) [edit]
emplace_hint (C++11) | constructs elements in-place using a hint (public member function) [edit]
erase | erases elements (public member function) [edit]
swap | swaps the contents (public member function) [edit]
extract (C++17) | extracts nodes from the container (public member function) [edit]
merge (C++17) | splices nodes from another container (public member function) [edit]
##### Lookup
count | returns the number of elements matching specific key (public member function) [edit]
find | finds element with specific key (public member function) [edit]
equal_range | returns range of elements matching a specific key (public member function) [edit]
lower_bound | returns an iterator to the first element not less than the given key (public member function) [edit]
upper_bound | returns an iterator to the first element greater than the given key (public member function) [edit]
##### Observers
key_comp | returns the function that compares keys (public member function) [edit]
value_comp | returns the function that compares keys in objects of type value_type (public member function) [edit]

### [edit] Non-member functions

operator==operator!=operator<operator<=operator>operator>= | lexicographically compares the values in the set (function template) [edit]
std::swap(std::set) | specializes the std::swap algorithm (function template) [edit]

### [edit] Notes

The member types `iterator` and `const_iterator` may be aliases to the same type. Since `iterator` is convertible to `const_iterator`, `const_iterator` should be used in function parameter lists to avoid violations of the One Definition Rule.

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/container/set&oldid=89159"
Hidden category:

- Pages with unreviewed LWG DR marker