| std::set< _Key, _Compare, _Alloc >(3cxx) | std::set< _Key, _Compare, _Alloc >(3cxx) |
NAME¶
std::set< _Key, _Compare, _Alloc > -SYNOPSIS¶
Public Types¶
typedef _Key key_type
typedef _Key_alloc_type::pointer pointer
Public Member Functions¶
set ()
iterator find (const key_type &__x)
iterator lower_bound (const key_type &__x)
iterator upper_bound (const key_type &__x)
std::pair< iterator, iterator > equal_range (const key_type &__x)
Friends¶
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._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).
Definition at line 91 of file stl_set.h.
Member Typedef Documentation¶
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Alloc std::set< _Key, _Compare, _Alloc >::allocator_type¶
Public typedefs. Definition at line 108 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Rep_type::const_iterator std::set< _Key, _Compare, _Alloc >:: const_iterator¶
Iterator-related typedefs. Definition at line 129 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Key_alloc_type::const_pointer std::set< _Key, _Compare, _Alloc >:: const_pointer¶
Iterator-related typedefs. Definition at line 122 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Key_alloc_type::const_reference std::set< _Key, _Compare, _Alloc >:: const_reference¶
Iterator-related typedefs. Definition at line 124 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Rep_type::const_reverse_iterator std::set< _Key, _Compare, _Alloc >:: const_reverse_iterator¶
Iterator-related typedefs. Definition at line 131 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Rep_type::difference_type std::set< _Key, _Compare, _Alloc >:: difference_type¶
Iterator-related typedefs. Definition at line 133 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Rep_type::const_iterator std::set< _Key, _Compare, _Alloc >:: iterator¶
Iterator-related typedefs. Definition at line 128 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Compare std::set< _Key, _Compare, _Alloc >::key_compare¶
Public typedefs. Definition at line 106 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Key std::set< _Key, _Compare, _Alloc >::key_type¶
Public typedefs. Definition at line 104 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Key_alloc_type::pointer std::set< _Key, _Compare, _Alloc >:: pointer¶
Iterator-related typedefs. Definition at line 121 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Key_alloc_type::reference std::set< _Key, _Compare, _Alloc >:: reference¶
Iterator-related typedefs. Definition at line 123 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Rep_type::const_reverse_iterator std::set< _Key, _Compare, _Alloc >:: reverse_iterator¶
Iterator-related typedefs. Definition at line 130 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Rep_type::size_type std::set< _Key, _Compare, _Alloc >::size_type¶
Iterator-related typedefs. Definition at line 132 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Compare std::set< _Key, _Compare, _Alloc >::value_compare¶
Public typedefs. Definition at line 107 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> typedef _Key std::set< _Key, _Compare, _Alloc >::value_type¶
Public typedefs. Definition at line 105 of file stl_set.h.Constructor & Destructor Documentation¶
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> std::set< _Key, _Compare, _Alloc >:: set () [inline]¶
Default constructor creates no elements. Definition at line 140 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> std::set< _Key, _Compare, _Alloc >:: set (const _Compare &__comp, const allocator_type &__a = allocator_type()) [inline] , [explicit]¶
Creates a set with no elements. Parameters:__comp Comparator to use.
__a An allocator object.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> template<typename _InputIterator > 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)).
Definition at line 164 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> template<typename _InputIterator > 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)).
Definition at line 181 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> std::set< _Key, _Compare, _Alloc >:: set (const set< _Key, _Compare, _Alloc > &__x) [inline]¶
Set copy constructor. Parameters:__x A set of identical element and
allocator types.
The newly-created set uses a copy of the allocation object used by __x.
Definition at line 194 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> std::set< _Key, _Compare, _Alloc >:: set (set< _Key, _Compare, _Alloc > &&__x) [inline], [noexcept]¶
Set move constructor Parameters:__x A set of identical element and
allocator types.
The newly-created set contains the exact contents of x. The contents of
x are a valid, but unspecified set.
Definition at line 205 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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() ).
Definition at line 219 of file stl_set.h.
Member Function Documentation¶
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> iterator std::set< _Key, _Compare, _Alloc >::begin () const [inline]¶
Returns a read-only (constant) iterator that points to the first element in the set. Iteration is done in ascending order according to the keys. Definition at line 299 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> iterator std::set< _Key, _Compare, _Alloc >::cbegin () const [inline], [noexcept]¶
Returns a read-only (constant) iterator that points to the first element in the set. Iteration is done in ascending order according to the keys. Definition at line 336 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> iterator std::set< _Key, _Compare, _Alloc >::cend () const [inline], [noexcept]¶
Returns a read-only (constant) iterator that points one past the last element in the set. Iteration is done in ascending order according to the keys. Definition at line 345 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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=().template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> size_type std::set< _Key, _Compare, _Alloc >::count (const key_type &__x) const [inline]¶
Finds the number of elements. Parameters:__x Element to located.
Returns:
Number of elements with specified key.
This function only makes sense for multisets; for set the result will either be
0 (not present) or 1 (present).
Definition at line 594 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> reverse_iterator std::set< _Key, _Compare, _Alloc >::crbegin () const [inline], [noexcept]¶
Returns a read-only (constant) iterator that points to the last element in the set. Iteration is done in descending order according to the keys. Definition at line 354 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> reverse_iterator std::set< _Key, _Compare, _Alloc >::crend () const [inline], [noexcept]¶
Returns a read-only (constant) reverse iterator that points to the last pair in the set. Iteration is done in descending order according to the keys. Definition at line 363 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> bool std::set< _Key, _Compare, _Alloc >::empty () const [inline]¶
Returns true if the set is empty. Definition at line 369 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> iterator std::set< _Key, _Compare, _Alloc >::end () const [inline]¶
Returns a read-only (constant) iterator that points one past the last element in the set. Iteration is done in ascending order according to the keys. Definition at line 308 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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. Definition at line 674 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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. Definition at line 678 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 502 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 532 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 553 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 612 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 616 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> allocator_type std::set< _Key, _Compare, _Alloc >::get_allocator () const [inline]¶
Returns the allocator object with which the set was constructed. Definition at line 290 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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=().
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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).
Definition at line 449 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> template<typename _InputIterator > void std::set< _Key, _Compare, _Alloc >::insert (_InputIterator__first, _InputIterator__last) [inline]¶
A template function that attempts to insert a range of elements. Parameters:__first Iterator pointing to the start
of the range to be inserted.
__last Iterator pointing to the end of the range.
Complexity similar to that of the range constructor.
Definition at line 469 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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().
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> key_compare std::set< _Key, _Compare, _Alloc >::key_comp () const [inline]¶
Returns the comparison object with which the set was constructed. Definition at line 282 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 633 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 637 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> size_type std::set< _Key, _Compare, _Alloc >::max_size () const [inline]¶
Returns the maximum size of the set. Definition at line 379 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> set& std::set< _Key, _Compare, _Alloc >::operator= (const set< _Key, _Compare, _Alloc > &__x) [inline]¶
Set assignment operator. Parameters:__x A set of identical element and
allocator types.
All the elements of __x are copied, but unlike the copy constructor, the
allocator object is not copied.
Definition at line 234 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> set& std::set< _Key, _Compare, _Alloc >::operator= (set< _Key, _Compare, _Alloc > &&__x) [inline]¶
Set move assignment operator. Parameters:__x A set of identical element and
allocator types.
The contents of __x are moved into this set (without copying). __x
is a valid, but unspecified set.
Definition at line 249 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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.
Definition at line 270 of file stl_set.h.
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> reverse_iterator std::set< _Key, _Compare, _Alloc >::rbegin () const [inline]¶
Returns a read-only (constant) iterator that points to the last element in the set. Iteration is done in descending order according to the keys. Definition at line 317 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> reverse_iterator std::set< _Key, _Compare, _Alloc >::rend () const [inline]¶
Returns a read-only (constant) reverse iterator that points to the last pair in the set. Iteration is done in descending order according to the keys. Definition at line 326 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> size_type std::set< _Key, _Compare, _Alloc >::size () const [inline]¶
Returns the size of the set. Definition at line 374 of file stl_set.h.template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> 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().
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> iterator std::set< _Key, _Compare, _Alloc >::upper_bound (const key_type &__x) [inline]¶
Finds the end of a subsequence matching given key. Parameters:__x Key to be located.
Returns:
Iterator pointing to the first element greater
than key, or end().
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> const_iterator std::set< _Key, _Compare, _Alloc >::upper_bound (const key_type &__x) const [inline]¶
Finds the end of a subsequence matching given key. Parameters:__x Key to be located.
Returns:
Iterator pointing to the first element greater
than key, or end().
template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>> value_compare std::set< _Key, _Compare, _Alloc >::value_comp () const [inline]¶
Returns the comparison object with which the set was constructed. Definition at line 286 of file stl_set.h.Author¶
Generated automatically by Doxygen for libstdc++ from the source code.| Sun Jan 6 2013 | libstdc++ |