Public Types
- typedef _Key key_type
- typedef _Key value_type
- typedef _Compare key_compare
- typedef _Compare value_compare
- typedef _Alloc allocator_type
- typedef _Key_alloc_type::pointer pointer
- typedef
_Key_alloc_type::const_pointer const_pointer - typedef _Key_alloc_type::reference reference
- typedef
_Key_alloc_type::const_reference const_reference - typedef _Rep_type::const_iterator iterator
- typedef _Rep_type::const_iterator const_iterator
- typedef
_Rep_type::const_reverse_iterator reverse_iterator - typedef
_Rep_type::const_reverse_iterator const_reverse_iterator - typedef _Rep_type::size_type size_type
- typedef _Rep_type::difference_type difference_type
Public Member Functions
- set ()
- set (const _Compare &__comp, const allocator_type &__a=allocator_type())
- template<typename _InputIterator > set (_InputIterator __first, _InputIterator __last)
- template<typename _InputIterator > set (_InputIterator __first, _InputIterator __last, const _Compare &__comp, const allocator_type &__a=allocator_type())
- set (const set &__x)
- set (set &&__x) noexcept(is_nothrow_copy_constructible< _Compare >
- set (initializer_list< value_type > __l, const _Compare &__comp=_Compare(), const allocator_type &__a=allocator_type())
- iterator begin () const _GLIBCXX_NOEXCEPT
- iterator cbegin () const noexcept
- iterator cend () const noexcept
- void clear () _GLIBCXX_NOEXCEPT
- size_type count (const key_type &__x) const
- reverse_iterator crbegin () const noexcept
- reverse_iterator crend () const noexcept
- bool empty () const _GLIBCXX_NOEXCEPT
- iterator end () const _GLIBCXX_NOEXCEPT
- iterator erase (const_iterator __position)
- size_type erase (const key_type &__x)
- iterator erase (const_iterator __first, const_iterator __last)
- allocator_type get_allocator () const _GLIBCXX_NOEXCEPT
- std::pair< iterator, bool > insert (const value_type &__x)
- std::pair< iterator, bool > insert (value_type &&__x)
- iterator insert (const_iterator __position, const value_type &__x)
- iterator insert (const_iterator __position, value_type &&__x)
- template<typename _InputIterator > void insert (_InputIterator __first, _InputIterator __last)
- void insert (initializer_list< value_type > __l)
- key_compare key_comp () const
- size_type max_size () const _GLIBCXX_NOEXCEPT
- set & operator= (const set &__x)
- set & operator= (set &&__x)
- set & operator= (initializer_list< value_type > __l)
- reverse_iterator rbegin () const _GLIBCXX_NOEXCEPT
- reverse_iterator rend () const _GLIBCXX_NOEXCEPT
- size_type size () const _GLIBCXX_NOEXCEPT
- void swap (set &__x)
- value_compare value_comp () const
- iterator lower_bound (const key_type &__x)
- const_iterator lower_bound (const key_type &__x) const
- iterator upper_bound (const key_type &__x)
- const_iterator upper_bound (const key_type &__x) const
- std::pair< iterator, iterator > equal_range (const key_type &__x)
- std::pair< const_iterator,
const_iterator > equal_range (const key_type &__x) const
Friends
- template<typename _K1 , typename _C1 , typename _A1 > bool operator< (const set< _K1, _C1, _A1 > &, const set< _K1, _C1, _A1 > &)
- template<typename _K1 , typename _C1 , typename _A1 > bool operator== (const set< _K1, _C1, _A1 > &, const set< _K1, _C1, _A1 > &)
Detailed Description
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>>
class std::set< _Key, _Compare, _Alloc >
A standard container made up of unique keys, which can be retrieved in logarithmic time.
Meets the requirements of a container, a reversible container, and an associative container (using unique keys).
Sets support bidirectional iterators.
- Template Parameters:
-
_Key Type of key objects. _Compare Comparison function object type, defaults to less<Key>. _Alloc Allocator type, defaults to allocator<Key>.
The private tree data is declared exactly the same way for set and multiset; the distinction is made entirely in how the tree functions are called (*_unique versus *_equal, same as the standard).
Member Typedef Documentation
| typedef _Alloc std::set< _Key, _Compare, _Alloc >::allocator_type |
| typedef _Rep_type::const_iterator std::set< _Key, _Compare, _Alloc >::const_iterator |
| typedef _Key_alloc_type::const_pointer std::set< _Key, _Compare, _Alloc >::const_pointer |
| typedef _Key_alloc_type::const_reference std::set< _Key, _Compare, _Alloc >::const_reference |
| typedef _Rep_type::const_reverse_iterator std::set< _Key, _Compare, _Alloc >::const_reverse_iterator |
| typedef _Rep_type::difference_type std::set< _Key, _Compare, _Alloc >::difference_type |
| typedef _Compare std::set< _Key, _Compare, _Alloc >::key_compare |
| typedef _Rep_type::const_reverse_iterator std::set< _Key, _Compare, _Alloc >::reverse_iterator |
| typedef _Compare std::set< _Key, _Compare, _Alloc >::value_compare |
| typedef _Key std::set< _Key, _Compare, _Alloc >::value_type |
Constructor & Destructor Documentation
| std::set< _Key, _Compare, _Alloc >::set | ( | const _Compare & | __comp, |
| const allocator_type & | __a = allocator_type() |
||
| ) | [inline, explicit] |
| std::set< _Key, _Compare, _Alloc >::set | ( | _InputIterator | __first, |
| _InputIterator | __last | ||
| ) | [inline] |
Builds a set from a range.
- Parameters:
-
__first An input iterator. __last An input iterator.
Create a set consisting of copies of the elements from [first,last). This is linear in N if the range is already sorted, and NlogN otherwise (where N is distance(first,last)).
| std::set< _Key, _Compare, _Alloc >::set | ( | _InputIterator | __first, |
| _InputIterator | __last, | ||
| const _Compare & | __comp, | ||
| const allocator_type & | __a = allocator_type() |
||
| ) | [inline] |
Builds a set from a range.
- Parameters:
-
__first An input iterator. __last An input iterator. __comp A comparison functor. __a An allocator object.
Create a set consisting of copies of the elements from [first,last). This is linear in N if the range is already sorted, and NlogN otherwise (where N is distance(first,last)).
| std::set< _Key, _Compare, _Alloc >::set | ( | initializer_list< value_type > | __l, |
| const _Compare & | __comp = _Compare(), |
||
| const allocator_type & | __a = allocator_type() |
||
| ) | [inline] |
Builds a set from an initializer_list.
- Parameters:
-
__l An initializer_list. __comp A comparison functor. __a An allocator object.
Create a set consisting of copies of the elements in the list. This is linear in N if the list is already sorted, and NlogN otherwise (where N is __l.size()).
Member Function Documentation
| void std::set< _Key, _Compare, _Alloc >::clear | ( | ) | [inline] |
Erases all elements in a set. Note that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 580 of file stl_set.h.
Referenced by std::set< _StateIdT >::operator=().
| reverse_iterator std::set< _Key, _Compare, _Alloc >::crbegin | ( | ) | const [inline] |
| reverse_iterator std::set< _Key, _Compare, _Alloc >::crend | ( | ) | const [inline] |
| std::pair<iterator, iterator> std::set< _Key, _Compare, _Alloc >::equal_range | ( | const key_type & | __x | ) | [inline] |
Finds a subsequence matching given key.
- Parameters:
-
__x Key to be located.
- Returns:
- Pair of iterators that possibly points to the subsequence matching given key.
This function is equivalent to
std::make_pair(c.lower_bound(val), c.upper_bound(val))
(but is faster than making the calls separately).
This function probably only makes sense for multisets.
| std::pair<const_iterator, const_iterator> std::set< _Key, _Compare, _Alloc >::equal_range | ( | const key_type & | __x | ) | const [inline] |
Finds a subsequence matching given key.
- Parameters:
-
__x Key to be located.
- Returns:
- Pair of iterators that possibly points to the subsequence matching given key.
This function is equivalent to
std::make_pair(c.lower_bound(val), c.upper_bound(val))
(but is faster than making the calls separately).
This function probably only makes sense for multisets.
| iterator std::set< _Key, _Compare, _Alloc >::erase | ( | const_iterator | __position | ) | [inline] |
Erases an element from a set.
- Parameters:
-
__position An iterator pointing to the element to be erased.
- Returns:
- An iterator pointing to the element immediately following __position prior to the element being erased. If no such element exists, end() is returned.
This function erases an element, pointed to by the given iterator, from a set. Note that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
| size_type std::set< _Key, _Compare, _Alloc >::erase | ( | const key_type & | __x | ) | [inline] |
Erases elements according to the provided key.
- Parameters:
-
__x Key of element to be erased.
- Returns:
- The number of elements erased.
This function erases all the elements located by the given key from a set. Note that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
| iterator std::set< _Key, _Compare, _Alloc >::erase | ( | const_iterator | __first, |
| const_iterator | __last | ||
| ) | [inline] |
Erases a [first,last) range of elements from a set.
- Parameters:
-
__first Iterator pointing to the start of the range to be erased. __last Iterator pointing to the end of the range to be erased.
- Returns:
- The iterator __last.
This function erases a sequence of elements from a set. Note that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
| iterator std::set< _Key, _Compare, _Alloc >::find | ( | const key_type & | __x | ) | [inline] |
Tries to locate an element in a set.
- Parameters:
-
__x Element to be located.
- Returns:
- Iterator pointing to sought-after element, or end() if not found.
This function takes a key and tries to locate the element with which the key matches. If successful the function returns an iterator pointing to the sought after element. If unsuccessful it returns the past-the-end ( end() ) iterator.
| const_iterator std::set< _Key, _Compare, _Alloc >::find | ( | const key_type & | __x | ) | const [inline] |
Tries to locate an element in a set.
- Parameters:
-
__x Element to be located.
- Returns:
- Iterator pointing to sought-after element, or end() if not found.
This function takes a key and tries to locate the element with which the key matches. If successful the function returns an iterator pointing to the sought after element. If unsuccessful it returns the past-the-end ( end() ) iterator.
| allocator_type std::set< _Key, _Compare, _Alloc >::get_allocator | ( | ) | const [inline] |
| std::pair<iterator, bool> std::set< _Key, _Compare, _Alloc >::insert | ( | const value_type & | __x | ) | [inline] |
Attempts to insert an element into the set.
- Parameters:
-
__x Element to be inserted.
- Returns:
- A pair, of which the first element is an iterator that points to the possibly inserted element, and the second is a bool that is true if the element was actually inserted.
This function attempts to insert an element into the set. A set relies on unique keys and thus an element is only inserted if it is not already present in the set.
Insertion requires logarithmic time.
Definition at line 412 of file stl_set.h.
Referenced by std::set< _StateIdT >::operator=().
| iterator std::set< _Key, _Compare, _Alloc >::insert | ( | const_iterator | __position, |
| const value_type & | __x | ||
| ) | [inline] |
Attempts to insert an element into the set.
- Parameters:
-
__position An iterator that serves as a hint as to where the element should be inserted. __x Element to be inserted.
- Returns:
- An iterator that points to the element with key of __x (may or may not be the element passed in).
This function is not concerned about whether the insertion took place, and thus does not return a boolean like the single-argument insert() does. Note that the first parameter is only a hint and can potentially improve the performance of the insertion process. A bad hint would cause no gains in efficiency.
For more on hinting, see: http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
Insertion requires logarithmic time (if the hint is not taken).
| void std::set< _Key, _Compare, _Alloc >::insert | ( | initializer_list< value_type > | __l | ) | [inline] |
Attempts to insert a list of elements into the set.
- Parameters:
-
__l A std::initializer_list<value_type> of elements to be inserted.
Complexity similar to that of the range constructor.
Definition at line 481 of file stl_set.h.
Referenced by std::set< _StateIdT >::insert().
| key_compare std::set< _Key, _Compare, _Alloc >::key_comp | ( | ) | const [inline] |
| iterator std::set< _Key, _Compare, _Alloc >::lower_bound | ( | const key_type & | __x | ) | [inline] |
Finds the beginning of a subsequence matching given key.
- Parameters:
-
__x Key to be located.
- Returns:
- Iterator pointing to first element equal to or greater than key, or end().
This function returns the first element of a subsequence of elements that matches the given key. If unsuccessful it returns an iterator pointing to the first element that has a greater value than given key or end() if no such element exists.
| const_iterator std::set< _Key, _Compare, _Alloc >::lower_bound | ( | const key_type & | __x | ) | const [inline] |
Finds the beginning of a subsequence matching given key.
- Parameters:
-
__x Key to be located.
- Returns:
- Iterator pointing to first element equal to or greater than key, or end().
This function returns the first element of a subsequence of elements that matches the given key. If unsuccessful it returns an iterator pointing to the first element that has a greater value than given key or end() if no such element exists.
| set& std::set< _Key, _Compare, _Alloc >::operator= | ( | initializer_list< value_type > | __l | ) | [inline] |
Set list assignment operator.
- Parameters:
-
__l An initializer_list.
This function fills a set with copies of the elements in the initializer list __l.
Note that the assignment completely changes the set and that the resulting set's size is the same as the number of elements assigned. Old data may be lost.
| reverse_iterator std::set< _Key, _Compare, _Alloc >::rbegin | ( | ) | const [inline] |
| reverse_iterator std::set< _Key, _Compare, _Alloc >::rend | ( | ) | const [inline] |
| void std::set< _Key, _Compare, _Alloc >::swap | ( | set< _Key, _Compare, _Alloc > & | __x | ) | [inline] |
Swaps data with another set.
- Parameters:
-
__x A set of the same element and allocator types.
This exchanges the elements between two sets in constant time. (It is only swapping a pointer, an integer, and an instance of the Compare type (which itself is often stateless and empty), so it should be quite fast.) Note that the global std::swap() function is specialized such that std::swap(s1,s2) will feed to this function.
Definition at line 394 of file stl_set.h.
Referenced by std::set< _StateIdT >::operator=(), and std::swap().
| iterator std::set< _Key, _Compare, _Alloc >::upper_bound | ( | const key_type & | __x | ) | [inline] |
| const_iterator std::set< _Key, _Compare, _Alloc >::upper_bound | ( | const key_type & | __x | ) | const [inline] |
| value_compare std::set< _Key, _Compare, _Alloc >::value_comp | ( | ) | const [inline] |
The documentation for this class was generated from the following file:
