std::set< _Key, _Compare, _Alloc > Class Template Reference
[ContainersAssociative Containers]

List of all members.

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.

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).

Definition at line 92 of file stl_set.h.

Public Types

Public Member Functions

Friends


Member Typedef Documentation

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 105 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 122 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 141 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.

Definition at line 150 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 
) [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.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::_M_insert_unique().

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 180 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::_M_insert_unique().

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 193 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 261 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::begin().

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 471 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::clear().

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 485 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::end(), and std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::find().

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 331 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::empty().

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 270 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::end().

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 565 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::equal_range().

template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>>
void std::set< _Key, _Compare, _Alloc >::erase ( iterator  __first,
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.
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 461 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::erase().

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 446 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::erase().

template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>>
void std::set< _Key, _Compare, _Alloc >::erase ( iterator  __position  )  [inline]

Erases an element from a set.

Parameters:
position An iterator pointing to the element to be erased.
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 431 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::erase().

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 503 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::find().

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 252 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::get_allocator().

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 418 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::_M_insert_unique().

template<typename _Key, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<_Key>>
iterator std::set< _Key, _Compare, _Alloc >::insert ( 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.

See http://gcc.gnu.org/onlinedocs/libstdc++/23_containers/howto.html#4 for more on "hinting".

Insertion requires logarithmic time (if the hint is not taken).

Definition at line 405 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::_M_insert_unique_().

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 378 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::_M_insert_unique(), std::pair< _T1, _T2 >::first, and std::pair< _T1, _T2 >::second.

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 244 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::key_comp().

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 524 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::lower_bound().

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 341 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::max_size().

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 216 of file stl_set.h.

References std::set< _Key, _Compare, _Alloc >::_M_t.

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 279 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::rbegin().

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 288 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::rend().

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 336 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::size().

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 359 of file stl_set.h.

References std::set< _Key, _Compare, _Alloc >::_M_t, and std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::swap().

Referenced by 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().

Definition at line 540 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::upper_bound().

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 248 of file stl_set.h.

References std::_Rb_tree< _Key, _Val, _KeyOfValue, _Compare, _Alloc >::key_comp().


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 00:44:50 2008 for libstdc++ by  doxygen 1.5.1