Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/container/set"

From cppreference.com
< cpp‎ | container
(→‎Non-member functions: +)
m (→‎Member types: ~Type)
 
(28 intermediate revisions by 12 users not shown)
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header|set}}
 
{{dcl header|set}}
−
{{dcl |num=1|
+
{{dcl|num=1|1=
 
template<
 
template<
 
     class Key,
 
     class Key,
−
     class Compare {{=}} std::less<Key>,
+
     class Compare = std::less<Key>,
−
     class Allocator {{=}} std::allocator<Key>
+
     class Allocator = std::allocator<Key>
 
> class set;
 
> class set;
−
}}  
+
}}
 
{{dcl|num=2|since=c++17|1=
 
{{dcl|num=2|since=c++17|1=
 
namespace pmr {
 
namespace pmr {
−
     template <class Key, class Compare = std::less<Key>>
+
     template<
−
     using set = std::set<Key, Compare, std::pmr::polymorphic_allocator<Key>>;
+
        class Key,
 +
        class Compare = std::less<Key>
 +
     > using set = std::set<Key, Compare, std::pmr::polymorphic_allocator<Key>>;
 
}
 
}
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
{{tt|std::set}} is an associative container that contains a sorted set of unique objects of type {{tt|Key}}. Sorting is done using the key comparison function {{named req|Compare}}. Search, removal, and insertion operations have logarithmic complexity. Sets are usually implemented as [[enwiki:Red–black_tree|red-black trees]].
+
{{tt|std::set}} is an associative container that contains a sorted set of unique objects of type {{tt|Key}}. Sorting is done using the key comparison function {{named req|Compare}}. Search, removal, and insertion operations have logarithmic complexity. Sets are usually implemented as {{enwiki|Red–black tree}}s.
  
−
Everywhere the standard library uses the {{named req|Compare}} requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objects {{tt|a}} and {{tt|b}} are considered equivalent if neither compares less than the other: {{tt|!comp(a, b) && !comp(b, a)}}.
+
Everywhere the standard library uses the {{named req|Compare}} requirements, uniqueness is determined by using the equivalence relation. In imprecise terms, two objects {{c|a}} and {{c|b}} are considered equivalent if neither compares less than the other: {{c|!comp(a, b) && !comp(b, a)}}.
  
 
{{tt|std::set}} meets the requirements of {{named req|Container}}, {{named req|AllocatorAwareContainer}}, {{named req|AssociativeContainer}} and {{named req|ReversibleContainer}}.
 
{{tt|std::set}} meets the requirements of {{named req|Container}}, {{named req|AllocatorAwareContainer}}, {{named req|AssociativeContainer}} and {{named req|ReversibleContainer}}.
 +
 +
===Template parameters===
 +
{{todo|Add descriptions of the template parameters.}}
  
 
===Member types===
 
===Member types===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc hitem | Member type | Definition}}
+
{{dsc hitem|Type|Definition}}
−
{{dsc inc | cpp/container/dsc key_type | set}}
+
{{dsc inc|cpp/container/dsc key_type|set}}
−
{{dsc inc | cpp/container/dsc value_type | set}}
+
{{dsc inc|cpp/container/dsc value_type|set}}
−
{{dsc inc | cpp/container/dsc size_type | set}}
+
{{dsc inc|cpp/container/dsc size_type|set}}
−
{{dsc inc | cpp/container/dsc difference_type | set}}
+
{{dsc inc|cpp/container/dsc difference_type|set}}
−
{{dsc inc | cpp/container/dsc key_compare | set}}
+
{{dsc inc|cpp/container/dsc key_compare|set}}
−
{{dsc inc | cpp/container/dsc value_compare2 | set}}
+
{{dsc inc|cpp/container/dsc value_compare2|set}}
−
{{dsc inc | cpp/container/dsc allocator_type | set}}
+
{{dsc inc|cpp/container/dsc allocator_type|set}}
−
{{dsc inc | cpp/container/dsc reference | set}}
+
{{dsc inc|cpp/container/dsc reference|set}}
−
{{dsc inc | cpp/container/dsc const_reference | set}}
+
{{dsc inc|cpp/container/dsc const_reference|set}}
−
{{dsc inc | cpp/container/dsc pointer | set}}
+
{{dsc inc|cpp/container/dsc pointer|set}}
−
{{dsc inc | cpp/container/dsc const_pointer | set}}
+
{{dsc inc|cpp/container/dsc const_pointer|set}}
−
{{dsc inc | cpp/container/dsc iterator | set}}
+
{{dsc inc|cpp/container/dsc iterator|set}}
−
{{dsc inc | cpp/container/dsc const_iterator | set}}
+
{{dsc inc|cpp/container/dsc const_iterator|set}}
−
{{dsc inc | cpp/container/dsc reverse_iterator | set}}
+
{{dsc inc|cpp/container/dsc reverse_iterator|set}}
−
{{dsc inc | cpp/container/dsc const_reverse_iterator | set}}
+
{{dsc inc|cpp/container/dsc const_reverse_iterator|set}}
−
{{dsc inc | cpp/container/dsc node_type | set}}
+
{{dsc inc|cpp/container/dsc node_type|set}}
−
{{dsc inc | cpp/container/dsc insert_return_type | set}}
+
{{dsc inc|cpp/container/dsc insert_return_type|set}}
 
{{dsc end}}
 
{{dsc end}}
  
 
===Member functions===
 
===Member functions===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/container/dsc constructor | set}}
+
{{dsc inc|cpp/container/dsc constructor|set}}
−
{{dsc inc | cpp/container/dsc destructor | set}}
+
{{dsc inc|cpp/container/dsc destructor|set}}
−
{{dsc inc | cpp/container/dsc operator{{=}} | set}}
+
{{dsc inc|cpp/container/dsc operator{{=}}|set}}
−
{{dsc inc | cpp/container/dsc get_allocator | set}}
+
{{dsc inc|cpp/container/dsc get_allocator|set}}
  
−
{{dsc h2 | Iterators}}
+
{{dsc h2|Iterators}}
−
{{dsc inc | cpp/container/dsc begin | set}}
+
{{dsc inc|cpp/container/dsc begin|set}}
−
{{dsc inc | cpp/container/dsc end | set}}
+
{{dsc inc|cpp/container/dsc end|set}}
−
{{dsc inc | cpp/container/dsc rbegin | set}}
+
{{dsc inc|cpp/container/dsc rbegin|set}}
−
{{dsc inc | cpp/container/dsc rend | set}}
+
{{dsc inc|cpp/container/dsc rend|set}}
  
−
{{dsc h2 | Capacity}}
+
{{dsc h2|Capacity}}
−
{{dsc inc | cpp/container/dsc empty | set}}
+
{{dsc inc|cpp/container/dsc empty|set}}
−
{{dsc inc | cpp/container/dsc size | set}}
+
{{dsc inc|cpp/container/dsc size|set}}
−
{{dsc inc | cpp/container/dsc max_size | set}}
+
{{dsc inc|cpp/container/dsc max_size|set}}
  
−
{{dsc h2 | Modifiers}}
+
{{dsc h2|Modifiers}}
−
{{dsc inc | cpp/container/dsc clear | set}}
+
{{dsc inc|cpp/container/dsc clear|set}}
−
{{dsc inc | cpp/container/dsc insert | set}}
+
{{dsc inc|cpp/container/dsc insert|set}}
−
{{dsc inc | cpp/container/dsc emplace | set}}
+
{{dsc inc|cpp/container/dsc insert_range|set}}
−
{{dsc inc | cpp/container/dsc emplace_hint | set}}
+
{{dsc inc|cpp/container/dsc emplace|set}}
−
{{dsc inc | cpp/container/dsc erase | set}}
+
{{dsc inc|cpp/container/dsc emplace_hint|set}}
−
{{dsc inc | cpp/container/dsc swap | set}}
+
{{dsc inc|cpp/container/dsc erase|set}}
−
{{dsc inc | cpp/container/dsc extract | set}}
+
{{dsc inc|cpp/container/dsc swap|set}}
−
{{dsc inc | cpp/container/dsc merge | set}}
+
{{dsc inc|cpp/container/dsc extract|set}}
 +
{{dsc inc|cpp/container/dsc merge|set}}
  
−
{{dsc h2 | Lookup}}
+
{{dsc h2|Lookup}}
−
{{dsc inc | cpp/container/dsc count | set}}
+
{{dsc inc|cpp/container/dsc count|set}}
−
{{dsc inc | cpp/container/dsc find | set}}
+
{{dsc inc|cpp/container/dsc find|set}}
−
{{dsc inc | cpp/container/dsc contains | set }}
+
{{dsc inc|cpp/container/dsc contains|set}}
−
{{dsc inc | cpp/container/dsc equal_range | set}}
+
{{dsc inc|cpp/container/dsc equal_range|set}}
−
{{dsc inc | cpp/container/dsc lower_bound | set}}
+
{{dsc inc|cpp/container/dsc lower_bound|set}}
−
{{dsc inc | cpp/container/dsc upper_bound | set}}
+
{{dsc inc|cpp/container/dsc upper_bound|set}}
  
−
{{dsc h2 | Observers}}
+
{{dsc h2|Observers}}
−
{{dsc inc | cpp/container/dsc key_comp | set}}
+
{{dsc inc|cpp/container/dsc key_comp|set}}
−
{{dsc inc | cpp/container/dsc value_comp | set}}
+
{{dsc inc|cpp/container/dsc value_comp|set}}
 
{{dsc end}}
 
{{dsc end}}
  
 
===Non-member functions===
 
===Non-member functions===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/container/dsc operator_cmp | set}}
+
{{dsc inc|cpp/container/dsc operator_cmp|set}}
−
{{dsc inc | cpp/container/dsc swap2 | set}}
+
{{dsc inc|cpp/container/dsc swap2|set}}
−
{{dsc inc | cpp/container/dsc erase_if | set}}
+
{{dsc inc|cpp/container/dsc erase_if|set}}
 
{{dsc end}}
 
{{dsc end}}
  
−
===[[cpp/container/set/deduction_guides|Deduction guides]]{{mark since c++17}}===
+
{{rrev|since=c++17|
 +
==={{rl|deduction guides|Deduction guides}}===
 +
}}
  
 
===Notes===
 
===Notes===
 
{{cpp/container/assoc_note}}
 
{{cpp/container/assoc_note}}
  
−
===Defect Reports===
+
{{ftm begin|std=1|comment=1}}
 +
{{ftm|__cpp_lib_containers_ranges|value=202202L|std=C++23|Ranges construction and insertion for containers}}
 +
{{ftm end}}
 +
 
 +
===Example===
 +
{{example
 +
|code=
 +
#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';
 +
        else
 +
            std::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 }
 +
}}
 +
 
 +
===Defect reports===
 
{{dr list begin}}
 
{{dr list begin}}
 
{{dr list item|wg=lwg|dr=103|std=C++98|before=iterator allows modification of keys|after=iterator made constant}}
 
{{dr list item|wg=lwg|dr=103|std=C++98|before=iterator allows modification of keys|after=iterator made constant}}
 +
{{dr list item|wg=lwg|dr=230|std=C++98|before={{tt|Key}} was not required to be {{named req|CopyConstructible}}<br>(a key of type {{tt|Key}} might not be able to be constructed)|after={{tt|Key}} is also required to<br>be {{named req|CopyConstructible}}}}
 
{{dr list end}}
 
{{dr list end}}
 +
 +
===See also===
 +
{{dsc begin}}
 +
{{dsc inc|cpp/container/dsc multiset}}
 +
{{dsc inc|cpp/container/dsc unordered_set}}
 +
{{dsc inc|cpp/container/dsc flat_set}}
 +
{{dsc end}}
  
 
{{langlinks|cs|de|es|fr|it|ja|pl|pt|ru|zh}}
 
{{langlinks|cs|de|es|fr|it|ja|pl|pt|ru|zh}}

Latest revision as of 15:47, 1 November 2024

 
C++
 
Containers library
 
std::set
Member functions
Non-member functions
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)
Deduction guides(C++17)
 
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 requirements, 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.

Contents

[edit] Template parameters

This section is incomplete
Reason: Add descriptions of the template parameters.

[edit] Member types

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 value_type&[edit]
const_reference const value_type&[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 Constant LegacyBidirectionalIterator to value_type[edit]
const_iterator LegacyBidirectionalIterator to const 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 of node handle representing a container node[edit]
insert_return_type (since C++17) type describing the result of inserting a node_type, a specialization of

template<class Iter, class NodeType>
struct /*unspecified*/
{
    Iter     position;
    bool     inserted;
    NodeType node;
};
instantiated with template arguments iterator and node_type.[edit]

[edit] Member functions

 constructs the set
(public member function) [edit]
destructs the set
(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 elements or 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 element not less than the given key
(public member function) [edit]
returns an iterator to the first element greater 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 type value_type
(public member function) [edit]

[edit] Non-member functions

(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 two sets
(function template) [edit]
specializes the std::swap algorithm
(function template) [edit]
(C++20)
 erases all elements satisfying specific criteria
(function template) [edit]

Deduction guides

 (since C++17)

[edit] Notes

The member types iterator and const_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 the One Definition Rule. Since iterator is convertible to const_iterator, a single function with a const_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

[edit] Example

Run this code
#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';
        else
            std::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 }

[edit] Defect reports

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 be CopyConstructible
(a key of type Key might not be able to be constructed) 		Key is also required to
be CopyConstructible

[edit] See also

 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]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/set&oldid=177453"