(C++17) | ||||
Sequence | ||||
(C++11) | ||||
(C++26) | ||||
(C++26) | ||||
(C++11) | ||||
Associative | ||||
set | ||||
Unordered associative | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
Adaptors | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
Views | ||||
(C++20) | ||||
(C++23) | ||||
Tables | ||||
Iterator invalidation | ||||
Member function table | ||||
Non-member function table |
Member functions | |||||||
Non-member functions | |||||||
| |||||||
Deduction guides(C++17) |
Defined in header <set> | ||
template< class Key, | (1) | |
namespace pmr{ template< | (2) | (since C++17) |
std::set
is an associative container that contains a sorted set of unique objects of typeKey
. Sorting is done using the key comparison functionCompare. Search, removal, and insertion operations have logarithmic complexity. Sets are usually implemented asRed–black trees.
Everywhere the standard library uses theCompare requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objectsa andb are considered equivalent if neither compares less than the other:!comp(a, b)&&!comp(b, a).
std::set
meets the requirements ofContainer,AllocatorAwareContainer,AssociativeContainer andReversibleContainer.
All member functions ofstd::set areconstexpr: it is possible to create and usestd::set objects in the evaluation of a constant expression.However, | (since C++26) |
Contents |
This section is incomplete Reason: Add descriptions of the template parameters. |
Type | Definition | ||||
key_type | Key [edit] | ||||
value_type | Key [edit] | ||||
size_type | Unsigned integer type (usuallystd::size_t)[edit] | ||||
difference_type | Signed integer type (usuallystd::ptrdiff_t)[edit] | ||||
key_compare | Compare [edit] | ||||
value_compare | Compare [edit] | ||||
allocator_type | Allocator [edit] | ||||
reference | value_type&[edit] | ||||
const_reference | const value_type&[edit] | ||||
pointer |
| ||||
const_pointer |
| ||||
iterator | ConstantLegacyBidirectionalIterator andConstexprIterator(since C++26) tovalue_type [edit] | ||||
const_iterator | LegacyBidirectionalIterator andConstexprIterator(since C++26) toconst value_type[edit] | ||||
reverse_iterator | std::reverse_iterator<iterator>[edit] | ||||
const_reverse_iterator | std::reverse_iterator<const_iterator>[edit] | ||||
node_type (since C++17) | a specialization ofnode handle representing a container node[edit] | ||||
insert_return_type (since C++17) | type describing the result of inserting anode_type , a specialization oftemplate<class Iter,class NodeType> |
constructs theset (public member function)[edit] | |
destructs theset (public member function)[edit] | |
assigns values to the container (public member function)[edit] | |
returns the associated allocator (public member function)[edit] | |
Iterators | |
(C++11) | returns an iterator to the beginning (public member function)[edit] |
(C++11) | returns an iterator to the end (public member function)[edit] |
(C++11) | returns a reverse iterator to the beginning (public member function)[edit] |
(C++11) | returns a reverse iterator to the end (public member function)[edit] |
Capacity | |
checks whether the container is empty (public member function)[edit] | |
returns the number of elements (public member function)[edit] | |
returns the maximum possible number of elements (public member function)[edit] | |
Modifiers | |
clears the contents (public member function)[edit] | |
inserts elementsor nodes(since C++17) (public member function)[edit] | |
(C++23) | inserts a range of elements (public member function)[edit] |
(C++11) | constructs element in-place (public member function)[edit] |
(C++11) | constructs elements in-place using a hint (public member function)[edit] |
erases elements (public member function)[edit] | |
swaps the contents (public member function)[edit] | |
(C++17) | extracts nodes from the container (public member function)[edit] |
(C++17) | splices nodes from another container (public member function)[edit] |
Lookup | |
returns the number of elements matching specific key (public member function)[edit] | |
finds element with specific key (public member function)[edit] | |
(C++20) | checks if the container contains element with specific key (public member function)[edit] |
returns range of elements matching a specific key (public member function)[edit] | |
returns an iterator to the first elementnot less than the given key (public member function)[edit] | |
returns an iterator to the first elementgreater than the given key (public member function)[edit] | |
Observers | |
returns the function that compares keys (public member function)[edit] | |
returns the function that compares keys in objects of typevalue_type (public member function)[edit] |
(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(C++20) | lexicographically compares the values of twoset s(function template)[edit] |
specializes thestd::swap algorithm (function template)[edit] | |
(C++20) | erases all elements satisfying specific criteria (function template)[edit] |
Deduction guides | (since C++17) |
The member typesiterator
andconst_iterator
may be aliases to the same type. This means defining a pair of function overloads using the two types as parameter types may violate theOne Definition Rule. Sinceiterator
is convertible toconst_iterator
, a single function with aconst_iterator
as parameter type will work instead.
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_containers_ranges | 202202L | (C++23) | Ranges construction and insertion for containers |
__cpp_lib_constexpr_set | 202502L | (C++26) | constexprstd::set |
#include <algorithm>#include <iomanip>#include <iostream>#include <iterator>#include <set>#include <string_view> template<typename T>std::ostream& operator<<(std::ostream& out,const std::set<T>& set){if(set.empty())return out<<"{}"; out<<"{ "<<*set.begin();std::for_each(std::next(set.begin()), set.end(),[&out](const T& element){ out<<", "<< element;});return out<<" }";} int main(){ std::set<int> set{1,5,3};std::cout<< set<<'\n'; set.insert(2);std::cout<< set<<'\n'; set.erase(1);std::cout<< set<<"\n\n"; std::set<int> keys{3,4};for(int key: keys){if(set.contains(key))std::cout<< set<<" does contain "<< key<<'\n';elsestd::cout<< set<<" doesn't contain "<< key<<'\n';}std::cout<<'\n'; std::string_view word="element"; std::set<char> characters(word.begin(), word.end());std::cout<<"There are "<< characters.size()<<" unique characters in "<<std::quoted(word)<<":\n"<< characters<<'\n';}
Output:
{ 1, 3, 5 }{ 1, 2, 3, 5 }{ 2, 3, 5 } { 2, 3, 5 } does contain 3{ 2, 3, 5 } doesn't contain 4 There are 5 unique characters in "element":{ e, l, m, n, t }
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 103 | C++98 | iterator allows modification of keys | iterator made constant |
LWG 230 | C++98 | Key was not required to beCopyConstructible(a key of type Key might not be able to be constructed) | Key is also required tobeCopyConstructible |
collection of keys, sorted by keys (class template)[edit] | |
(C++11) | collection of unique keys, hashed by keys (class template)[edit] |
(C++23) | adapts a container to provide a collection of unique keys, sorted by keys (class template)[edit] |