Standard library header <set> - cppreference.com

From cppreference.com

This header is part of the containers library.

Includes
<compare> (C++20)	Three-way comparison operator support[edit]
<initializer_list> (C++11)	std::initializer_list class template[edit]
Classes
set	collection of unique keys, sorted by keys (class template) [edit]
multiset	collection of keys, sorted by keys (class template) [edit]
Functions
operator==operator!=operator<operator<=operator>operator>=operator<=> (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 `set`s (function template) [edit]
std::swap(std::set)	specializes the std::swap algorithm (function template) [edit]
erase_if(std::set) (C++20)	erases all elements satisfying specific criteria (function template) [edit]
operator==operator!=operator<operator<=operator>operator>=operator<=> (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 `multiset`s (function template) [edit]
std::swap(std::multiset)	specializes the std::swap algorithm (function template) [edit]
erase_if(std::multiset) (C++20)	erases all elements satisfying specific criteria (function template) [edit]
Range access
begincbegin (C++11)(C++14)	returns an iterator to the beginning of a container or array (function template) [edit]
endcend (C++11)(C++14)	returns an iterator to the end of a container or array (function template) [edit]
rbegincrbegin (C++14)	returns a reverse iterator to the beginning of a container or array (function template) [edit]
rendcrend (C++14)	returns a reverse end iterator for a container or array (function template) [edit]
sizessize (C++17)(C++20)	returns the size of a container or array (function template) [edit]
empty (C++17)	checks whether the container is empty (function template) [edit]
data (C++17)	obtains the pointer to the underlying array (function template) [edit]

Synopsis

#include <compare>
#include <initializer_list>

namespace std {
  // class template set
  template<class Key, class Compare = less<Key>, class Allocator = allocator<Key>>
  class set;

  template<class Key, class Compare, class Allocator>
  constexpr bool operator==(const set<Key, Compare, Allocator>& x,
                            const set<Key, Compare, Allocator>& y);
  template<class Key, class Compare, class Allocator>
  constexpr /*synth-three-way-result*/<Key> operator<=>(
    const set<Key, Compare, Allocator>& x, const set<Key, Compare, Allocator>& y);

  template<class Key, class Compare, class Allocator>
  constexpr void swap(set<Key, Compare, Allocator>& x,
                      set<Key, Compare, Allocator>& y) noexcept(noexcept(x.swap(y)));

  // erasure for set
  template<class Key, class Compare, class Allocator, class Predicate>
  constexpr typename set<Key, Compare, Allocator>::size_type erase_if(
    set<Key, Compare, Allocator>& c, Predicate pred);

  // class template multiset
  template<class Key, class Compare = less<Key>, class Allocator = allocator<Key>>
  class multiset;

  template<class Key, class Compare, class Allocator>
  constexpr bool operator==(const multiset<Key, Compare, Allocator>& x,
                            const multiset<Key, Compare, Allocator>& y);
  template<class Key, class Compare, class Allocator>
  constexpr /*synth-three-way-result*/<Key> operator<=>(
    const multiset<Key, Compare, Allocator>& x,
    const multiset<Key, Compare, Allocator>& y);

  template<class Key, class Compare, class Allocator>
  constexpr void swap(multiset<Key, Compare, Allocator>& x,
                      multiset<Key, Compare, Allocator>& y) noexcept(noexcept(x.swap(y)));

  // erasure for multiset
  template<class Key, class Compare, class Allocator, class Predicate>
  constexpr typename multiset<Key, Compare, Allocator>::size_type erase_if(
    multiset<Key, Compare, Allocator>& c, Predicate pred);

  namespace pmr {
    template<class Key, class Compare = less<Key>>
    using set = std::set<Key, Compare, polymorphic_allocator<Key>>;

    template<class Key, class Compare = less<Key>>
    using multiset = std::multiset<Key, Compare, polymorphic_allocator<Key>>;
  }
}

Class template std::set

namespace std {
  template<class Key, class Compare = less<Key>, class Allocator = allocator<Key>>
  class set
  {
  public:
    // types
    using key_type = Key;
    using key_compare = Compare;
    using value_type = Key;
    using value_compare = Compare;
    using allocator_type = Allocator;
    using pointer = allocator_traits<Allocator>::pointer;
    using const_pointer = allocator_traits<Allocator>::const_pointer;
    using reference = value_type&;
    using const_reference = const value_type&;
    using size_type = /* implementation-defined */;
    using difference_type = /* implementation-defined */;
    using iterator = /* implementation-defined */;
    using const_iterator = /* implementation-defined */;
    using reverse_iterator = std::reverse_iterator<iterator>;
    using const_reverse_iterator = std::reverse_iterator<const_iterator>;
    using node_type = /* unspecified */;
    using insert_return_type = /*insert-return-type*/<iterator, node_type>;

    // construct/copy/destroy
    constexpr set()
      : set(Compare())
    {
    }
    constexpr explicit set(const Compare& comp, const Allocator& = Allocator());
    template<class InputIter>
    constexpr set(InputIter first,
                  InputIter last,
                  const Compare& comp = Compare(),
                  const Allocator& = Allocator());
    template<container-compatible-range<value_type> R>
    constexpr set(from_range_t,
                  R&& rg,
                  const Compare& comp = Compare(),
                  const Allocator& = Allocator());
    constexpr set(const set& x);
    constexpr set(set&& x);
    constexpr explicit set(const Allocator&);
    constexpr set(const set&, const type_identity_t<Allocator>&);
    constexpr set(set&&, const type_identity_t<Allocator>&);
    constexpr set(initializer_list<value_type>,
                  const Compare& = Compare(),
                  const Allocator& = Allocator());
    template<class InputIter>
    constexpr set(InputIter first, InputIter last, const Allocator& a)
      : set(first, last, Compare(), a)
    {
    }
    template<container-compatible-range<value_type> R>
    constexpr set(from_range_t, R&& rg, const Allocator& a)
      : set(from_range, std::forward<R>(rg), Compare(), a)
    {
    }
    constexpr set(initializer_list<value_type> il, const Allocator& a)
      : set(il, Compare(), a)
    {
    }
    constexpr ~set();
    constexpr set& operator=(const set& x);
    constexpr set& operator=(set&& x) noexcept(
      allocator_traits<Allocator>::is_always_equal::value&&
        is_nothrow_move_assignable_v<Compare>);
    constexpr set& operator=(initializer_list<value_type>);
    constexpr allocator_type get_allocator() const noexcept;

    // iterators
    constexpr iterator begin() noexcept;
    constexpr const_iterator begin() const noexcept;
    constexpr iterator end() noexcept;
    constexpr const_iterator end() const noexcept;

    constexpr reverse_iterator rbegin() noexcept;
    constexpr const_reverse_iterator rbegin() const noexcept;
    constexpr reverse_iterator rend() noexcept;
    constexpr const_reverse_iterator rend() const noexcept;

    constexpr const_iterator cbegin() const noexcept;
    constexpr const_iterator cend() const noexcept;
    constexpr const_reverse_iterator crbegin() const noexcept;
    constexpr const_reverse_iterator crend() const noexcept;

    // capacity
    constexpr bool empty() const noexcept;
    constexpr size_type size() const noexcept;
    constexpr size_type max_size() const noexcept;

    // modifiers
    template<class... Args> constexpr pair<iterator, bool> emplace(Args&&... args);
    template<class... Args>
    constexpr iterator emplace_hint(const_iterator position, Args&&... args);
    constexpr pair<iterator, bool> insert(const value_type& x);
    constexpr pair<iterator, bool> insert(value_type&& x);
    template<class K> constexpr pair<iterator, bool> insert(K&& x);
    constexpr iterator insert(const_iterator position, const value_type& x);
    constexpr iterator insert(const_iterator position, value_type&& x);
    template<class K> constexpr iterator insert(const_iterator position, K&& x);
    template<class InputIter> constexpr void insert(InputIter first, InputIter last);
    template<container-compatible-range<value_type> R>
    constexpr void insert_range(R&& rg);
    constexpr void insert(initializer_list<value_type>);

    constexpr node_type extract(const_iterator position);
    constexpr node_type extract(const key_type& x);
    template<class K> constexpr node_type extract(K&& x);
    constexpr insert_return_type insert(node_type&& nh);
    constexpr iterator insert(const_iterator hint, node_type&& nh);

    constexpr iterator erase(iterator position)
      requires(!same_as<iterator, const_iterator>);
    constexpr iterator erase(const_iterator position);
    constexpr size_type erase(const key_type& x);
    template<class K> constexpr size_type erase(K&& x);
    constexpr iterator erase(const_iterator first, const_iterator last);
    constexpr void swap(set&) noexcept(
      allocator_traits<Allocator>::is_always_equal::value&&
        is_nothrow_swappable_v<Compare>);
    constexpr void clear() noexcept;

    template<class C2> constexpr void merge(set<Key, C2, Allocator>& source);
    template<class C2> constexpr void merge(set<Key, C2, Allocator>&& source);
    template<class C2> constexpr void merge(multiset<Key, C2, Allocator>& source);
    template<class C2> constexpr void merge(multiset<Key, C2, Allocator>&& source);

    // observers
    constexpr key_compare key_comp() const;
    constexpr value_compare value_comp() const;

    // set operations
    constexpr iterator find(const key_type& x);
    constexpr const_iterator find(const key_type& x) const;
    template<class K> constexpr iterator find(const K& x);
    template<class K> constexpr const_iterator find(const K& x) const;

    constexpr size_type count(const key_type& x) const;
    template<class K> constexpr size_type count(const K& x) const;

    constexpr bool contains(const key_type& x) const;
    template<class K> constexpr bool contains(const K& x) const;

    constexpr iterator lower_bound(const key_type& x);
    constexpr const_iterator lower_bound(const key_type& x) const;
    template<class K> constexpr iterator lower_bound(const K& x);
    template<class K> constexpr const_iterator lower_bound(const K& x) const;

    constexpr iterator upper_bound(const key_type& x);
    constexpr const_iterator upper_bound(const key_type& x) const;
    template<class K> constexpr iterator upper_bound(const K& x);
    template<class K> constexpr const_iterator upper_bound(const K& x) const;

    constexpr pair<iterator, iterator> equal_range(const key_type& x);
    constexpr pair<const_iterator, const_iterator> equal_range(const key_type& x) const;
    template<class K> constexpr pair<iterator, iterator> equal_range(const K& x);
    template<class K>
    constexpr pair<const_iterator, const_iterator> equal_range(const K& x) const;
  };

  template<class InputIter,
           class Compare = less</*iter-value-type*/<InputIter>>,
           class Allocator = allocator</*iter-value-type*/<InputIter>>>
  set(InputIter, InputIter, Compare = Compare(), Allocator = Allocator())
    -> set</*iter-value-type*/<InputIter>, Compare, Allocator>;

  template<ranges::input_range R,
           class Compare = less<ranges::range_value_t<R>>,
           class Allocator = allocator<ranges::range_value_t<R>>>
  set(from_range_t, R&&, Compare = Compare(), Allocator = Allocator())
    -> set<ranges::range_value_t<R>, Compare, Allocator>;

  template<class Key, class Compare = less<Key>, class Allocator = allocator<Key>>
  set(initializer_list<Key>, Compare = Compare(), Allocator = Allocator())
    -> set<Key, Compare, Allocator>;

  template<class InputIter, class Allocator>
  set(InputIter, InputIter, Allocator) -> set</*iter-value-type*/<InputIter>,
                                              less</*iter-value-type*/<InputIter>>,
                                              Allocator>;

  template<ranges::input_range R, class Allocator>
  set(from_range_t, R&&, Allocator)
    -> set<ranges::range_value_t<R>, less<ranges::range_value_t<R>>, Allocator>;

  template<class Key, class Allocator>
  set(initializer_list<Key>, Allocator) -> set<Key, less<Key>, Allocator>;
}

Class template std::multiset

namespace std {
  template<class Key, class Compare = less<Key>, class Allocator = allocator<Key>>
  class multiset
  {
  public:
    // types
    using key_type = Key;
    using key_compare = Compare;
    using value_type = Key;
    using value_compare = Compare;
    using allocator_type = Allocator;
    using pointer = allocator_traits<Allocator>::pointer;
    using const_pointer = allocator_traits<Allocator>::const_pointer;
    using reference = value_type&;
    using const_reference = const value_type&;
    using size_type = /* implementation-defined */;
    using difference_type = /* implementation-defined */;
    using iterator = /* implementation-defined */;
    using const_iterator = /* implementation-defined */;
    using reverse_iterator = std::reverse_iterator<iterator>;
    using const_reverse_iterator = std::reverse_iterator<const_iterator>;
    using node_type = /* unspecified */;

    // construct/copy/destroy
    constexpr multiset()
      : multiset(Compare())
    {
    }
    constexpr explicit multiset(const Compare& comp, const Allocator& = Allocator());
    template<class InputIter>
    constexpr multiset(InputIter first,
                       InputIter last,
                       const Compare& comp = Compare(),
                       const Allocator& = Allocator());
    template<container-compatible-range<value_type> R>
    constexpr multiset(from_range_t,
                       R&& rg,
                       const Compare& comp = Compare(),
                       const Allocator& = Allocator());
    constexpr multiset(const multiset& x);
    constexpr multiset(multiset&& x);
    constexpr explicit multiset(const Allocator&);
    constexpr multiset(const multiset&, const type_identity_t<Allocator>&);
    constexpr multiset(multiset&&, const type_identity_t<Allocator>&);
    constexpr multiset(initializer_list<value_type>,
                       const Compare& = Compare(),
                       const Allocator& = Allocator());
    template<class InputIter>
    constexpr multiset(InputIter first, InputIter last, const Allocator& a)
      : multiset(first, last, Compare(), a)
    {
    }
    template<container-compatible-range<value_type> R>
    constexpr multiset(from_range_t, R&& rg, const Allocator& a)
      : multiset(from_range, std::forward<R>(rg), Compare(), a)
    {
    }
    constexpr multiset(initializer_list<value_type> il, const Allocator& a)
      : multiset(il, Compare(), a)
    {
    }
    constexpr ~multiset();
    constexpr multiset& operator=(const multiset& x);
    constexpr multiset& operator=(multiset&& x) noexcept(
      allocator_traits<Allocator>::is_always_equal::value&&
        is_nothrow_move_assignable_v<Compare>);
    constexpr multiset& operator=(initializer_list<value_type>);
    constexpr allocator_type get_allocator() const noexcept;

    // iterators
    constexpr iterator begin() noexcept;
    constexpr const_iterator begin() const noexcept;
    constexpr iterator end() noexcept;
    constexpr const_iterator end() const noexcept;

    constexpr reverse_iterator rbegin() noexcept;
    constexpr const_reverse_iterator rbegin() const noexcept;
    constexpr reverse_iterator rend() noexcept;
    constexpr const_reverse_iterator rend() const noexcept;

    constexpr const_iterator cbegin() const noexcept;
    constexpr const_iterator cend() const noexcept;
    constexpr const_reverse_iterator crbegin() const noexcept;
    constexpr const_reverse_iterator crend() const noexcept;

    // capacity
    constexpr bool empty() const noexcept;
    constexpr size_type size() const noexcept;
    constexpr size_type max_size() const noexcept;

    // modifiers
    template<class... Args> constexpr iterator emplace(Args&&... args);
    template<class... Args>
    constexpr iterator emplace_hint(const_iterator position, Args&&... args);
    constexpr iterator insert(const value_type& x);
    constexpr iterator insert(value_type&& x);
    constexpr iterator insert(const_iterator position, const value_type& x);
    constexpr iterator insert(const_iterator position, value_type&& x);
    template<class InputIter> constexpr void insert(InputIter first, InputIter last);
    template<container-compatible-range<value_type> R>
    constexpr void insert_range(R&& rg);
    constexpr void insert(initializer_list<value_type>);

    constexpr node_type extract(const_iterator position);
    constexpr node_type extract(const key_type& x);
    template<class K> constexpr node_type extract(K&& x);
    constexpr iterator insert(node_type&& nh);
    constexpr iterator insert(const_iterator hint, node_type&& nh);

    constexpr iterator erase(iterator position)
      requires(!same_as<iterator, const_iterator>);
    constexpr iterator erase(const_iterator position);
    constexpr size_type erase(const key_type& x);
    template<class K> constexpr size_type erase(K&& x);
    constexpr iterator erase(const_iterator first, const_iterator last);
    constexpr void swap(multiset&) noexcept(
      allocator_traits<Allocator>::is_always_equal::value&&
        is_nothrow_swappable_v<Compare>);
    constexpr void clear() noexcept;

    template<class C2> constexpr void merge(multiset<Key, C2, Allocator>& source);
    template<class C2> constexpr void merge(multiset<Key, C2, Allocator>&& source);
    template<class C2> constexpr void merge(set<Key, C2, Allocator>& source);
    template<class C2> constexpr void merge(set<Key, C2, Allocator>&& source);

    // observers
    constexpr key_compare key_comp() const;
    constexpr value_compare value_comp() const;

    // set operations
    constexpr iterator find(const key_type& x);
    constexpr const_iterator find(const key_type& x) const;
    template<class K> constexpr iterator find(const K& x);
    template<class K> constexpr const_iterator find(const K& x) const;

    constexpr size_type count(const key_type& x) const;
    template<class K> constexpr size_type count(const K& x) const;

    constexpr bool contains(const key_type& x) const;
    template<class K> constexpr bool contains(const K& x) const;

    constexpr iterator lower_bound(const key_type& x);
    constexpr const_iterator lower_bound(const key_type& x) const;
    template<class K> constexpr iterator lower_bound(const K& x);
    template<class K> constexpr const_iterator lower_bound(const K& x) const;

    constexpr iterator upper_bound(const key_type& x);
    constexpr const_iterator upper_bound(const key_type& x) const;
    template<class K> constexpr iterator upper_bound(const K& x);
    template<class K> constexpr const_iterator upper_bound(const K& x) const;

    constexpr pair<iterator, iterator> equal_range(const key_type& x);
    constexpr pair<const_iterator, const_iterator> equal_range(const key_type& x) const;
    template<class K> constexpr pair<iterator, iterator> equal_range(const K& x);
    template<class K>
    constexpr pair<const_iterator, const_iterator> equal_range(const K& x) const;
  };

  template<class InputIter,
           class Compare = less</*iter-value-type*/<InputIter>>,
           class Allocator = allocator</*iter-value-type*/<InputIter>>>
  multiset(InputIter, InputIter, Compare = Compare(), Allocator = Allocator())
    -> multiset</*iter-value-type*/<InputIter>, Compare, Allocator>;

  template<ranges::input_range R,
           class Compare = less<ranges::range_value_t<R>>,
           class Allocator = allocator<ranges::range_value_t<R>>>
  multiset(from_range_t, R&&, Compare = Compare(), Allocator = Allocator())
    -> multiset<ranges::range_value_t<R>, Compare, Allocator>;

  template<class Key, class Compare = less<Key>, class Allocator = allocator<Key>>
  multiset(initializer_list<Key>, Compare = Compare(), Allocator = Allocator())
    -> multiset<Key, Compare, Allocator>;

  template<class InputIter, class Allocator>
  multiset(InputIter, InputIter, Allocator)
    -> multiset</*iter-value-type*/<InputIter>,
                less</*iter-value-type*/<InputIter>>,
                Allocator>;

  template<ranges::input_range R, class Allocator>
  multiset(from_range_t, R&&, Allocator)
    -> multiset<ranges::range_value_t<R>, less<ranges::range_value_t<R>>, Allocator>;

  template<class Key, class Allocator>
  multiset(initializer_list<Key>, Allocator) -> multiset<Key, less<Key>, Allocator>;
}

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 214	C++98	the declarations of the members `find`, `lower_bound`, `upper_bound` and `equal_range` of std::set and std::multiset in the synopsis did not match the requirements on associative containers	corrected

Standard library header <set> - cppreference.com

Includes

Classes

Functions

Range access

Synopsis

Class template std::set

Class template std::multiset

Defect reports