libstdc++
std::set Class Reference
Inheritance diagram for std::set:

List of all members.

Public Types

Public Member Functions

Friends


Detailed Description

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:
KeyType of key objects.
CompareComparison function object type, defaults to less<Key>.
AllocAllocator 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::allocator_type

Public typedefs.

Definition at line 106 of file stl_set.h.

typedef _Rep_type::const_iterator std::set::const_iterator

Iterator-related typedefs.

Definition at line 127 of file stl_set.h.

typedef _Key_alloc_type::const_pointer std::set::const_pointer

Iterator-related typedefs.

Definition at line 120 of file stl_set.h.

typedef _Key_alloc_type::const_reference std::set::const_reference

Iterator-related typedefs.

Definition at line 122 of file stl_set.h.

Iterator-related typedefs.

Definition at line 129 of file stl_set.h.

typedef _Rep_type::difference_type std::set::difference_type

Iterator-related typedefs.

Definition at line 131 of file stl_set.h.

typedef _Rep_type::const_iterator std::set::iterator

Iterator-related typedefs.

Definition at line 126 of file stl_set.h.

typedef _Compare std::set::key_compare

Public typedefs.

Definition at line 104 of file stl_set.h.

typedef _Key std::set::key_type

Public typedefs.

Definition at line 102 of file stl_set.h.

typedef _Key_alloc_type::pointer std::set::pointer

Iterator-related typedefs.

Definition at line 119 of file stl_set.h.

typedef _Key_alloc_type::reference std::set::reference

Iterator-related typedefs.

Definition at line 121 of file stl_set.h.

Iterator-related typedefs.

Definition at line 128 of file stl_set.h.

typedef _Rep_type::size_type std::set::size_type

Iterator-related typedefs.

Definition at line 130 of file stl_set.h.

typedef _Compare std::set::value_compare

Public typedefs.

Definition at line 105 of file stl_set.h.

typedef _Key std::set::value_type

Public typedefs.

Definition at line 103 of file stl_set.h.


Constructor & Destructor Documentation

std::set::set ( ) [inline]

Default constructor creates no elements.

Definition at line 138 of file stl_set.h.

std::set::set ( const _Compare &  __comp,
const allocator_type __a = allocator_type() 
) [inline, explicit]

Creates a set with no elements.

Parameters:
compComparator to use.
aAn allocator object.

Definition at line 147 of file stl_set.h.

template<typename _InputIterator >
std::set::set ( _InputIterator  __first,
_InputIterator  __last 
) [inline]

Builds a set from a range.

Parameters:
firstAn input iterator.
lastAn 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 161 of file stl_set.h.

template<typename _InputIterator >
std::set::set ( _InputIterator  __first,
_InputIterator  __last,
const _Compare &  __comp,
const allocator_type __a = allocator_type() 
) [inline]

Builds a set from a range.

Parameters:
firstAn input iterator.
lastAn input iterator.
compA comparison functor.
aAn 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 177 of file stl_set.h.

std::set::set ( const set __x) [inline]

Set copy constructor.

Parameters:
xA set of identical element and allocator types.

The newly-created set uses a copy of the allocation object used by x.

Definition at line 190 of file stl_set.h.

std::set::set ( set &&  __x) [inline]

Set move constructor

Parameters:
xA 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 201 of file stl_set.h.

std::set::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:
lAn initializer_list.
compA comparison functor.
aAn 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 214 of file stl_set.h.


Member Function Documentation

iterator std::set::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 294 of file stl_set.h.

iterator std::set::cbegin ( ) 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 331 of file stl_set.h.

iterator std::set::cend ( ) 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 340 of file stl_set.h.

void std::set::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 572 of file stl_set.h.

Referenced by std::set< _StateIdT >::operator=().

size_type std::set::count ( const key_type __x) const [inline]

Finds the number of elements.

Parameters:
xElement 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 586 of file stl_set.h.

reverse_iterator std::set::crbegin ( ) 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 349 of file stl_set.h.

reverse_iterator std::set::crend ( ) 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 358 of file stl_set.h.

bool std::set::empty ( ) const [inline]

Returns true if the set is empty.

Definition at line 364 of file stl_set.h.

iterator std::set::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 303 of file stl_set.h.

std::pair<iterator, iterator> std::set::equal_range ( const key_type __x) [inline]

Finds a subsequence matching given key.

Parameters:
xKey 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 666 of file stl_set.h.

std::pair<const_iterator, const_iterator> std::set::equal_range ( const key_type __x) const [inline]

Finds a subsequence matching given key.

Parameters:
xKey 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 670 of file stl_set.h.

iterator std::set::erase ( const_iterator  __position) [inline]

Erases an element from a set.

Parameters:
positionAn 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 497 of file stl_set.h.

size_type std::set::erase ( const key_type __x) [inline]

Erases elements according to the provided key.

Parameters:
xKey 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 527 of file stl_set.h.

iterator std::set::erase ( const_iterator  __first,
const_iterator  __last 
) [inline]

Erases a [first,last) range of elements from a set.

Parameters:
firstIterator pointing to the start of the range to be erased.
lastIterator 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 546 of file stl_set.h.

iterator std::set::find ( const key_type __x) [inline]

Tries to locate an element in a set.

Parameters:
xElement 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 604 of file stl_set.h.

const_iterator std::set::find ( const key_type __x) const [inline]

Tries to locate an element in a set.

Parameters:
xElement 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 608 of file stl_set.h.

allocator_type std::set::get_allocator ( ) const [inline]

Returns the allocator object with which the set was constructed.

Definition at line 285 of file stl_set.h.

std::pair<iterator, bool> std::set::insert ( const value_type __x) [inline]

Attempts to insert an element into the set.

Parameters:
xElement 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 407 of file stl_set.h.

Referenced by std::set< _StateIdT >::operator=().

iterator std::set::insert ( const_iterator  __position,
const value_type __x 
) [inline]

Attempts to insert an element into the set.

Parameters:
positionAn iterator that serves as a hint as to where the element should be inserted.
xElement 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 444 of file stl_set.h.

template<typename _InputIterator >
void std::set::insert ( _InputIterator  __first,
_InputIterator  __last 
) [inline]

A template function that attempts to insert a range of elements.

Parameters:
firstIterator pointing to the start of the range to be inserted.
lastIterator pointing to the end of the range.

Complexity similar to that of the range constructor.

Definition at line 464 of file stl_set.h.

void std::set::insert ( initializer_list< value_type __l) [inline]

Attempts to insert a list of elements into the set.

Parameters:
listA std::initializer_list<value_type> of elements to be inserted.

Complexity similar to that of the range constructor.

Definition at line 476 of file stl_set.h.

Referenced by std::set< _StateIdT >::insert().

key_compare std::set::key_comp ( ) const [inline]

Returns the comparison object with which the set was constructed.

Definition at line 277 of file stl_set.h.

iterator std::set::lower_bound ( const key_type __x) [inline]

Finds the beginning of a subsequence matching given key.

Parameters:
xKey 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 625 of file stl_set.h.

const_iterator std::set::lower_bound ( const key_type __x) const [inline]

Finds the beginning of a subsequence matching given key.

Parameters:
xKey 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 629 of file stl_set.h.

size_type std::set::max_size ( ) const [inline]

Returns the maximum size of the set.

Definition at line 374 of file stl_set.h.

set& std::set::operator= ( const set __x) [inline]

Set assignment operator.

Parameters:
xA 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 229 of file stl_set.h.

set& std::set::operator= ( set &&  __x) [inline]

Set move assignment operator.

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

set& std::set::operator= ( initializer_list< value_type __l) [inline]

Set list assignment operator.

Parameters:
lAn 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 265 of file stl_set.h.

reverse_iterator std::set::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 312 of file stl_set.h.

reverse_iterator std::set::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 321 of file stl_set.h.

size_type std::set::size ( ) const [inline]

Returns the size of the set.

Definition at line 369 of file stl_set.h.

void std::set::swap ( set __x) [inline]

Swaps data with another set.

Parameters:
xA 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 389 of file stl_set.h.

Referenced by std::set< _StateIdT >::operator=().

iterator std::set::upper_bound ( const key_type __x) [inline]

Finds the end of a subsequence matching given key.

Parameters:
xKey to be located.
Returns:
Iterator pointing to the first element greater than key, or end().

Definition at line 641 of file stl_set.h.

const_iterator std::set::upper_bound ( const key_type __x) const [inline]

Finds the end of a subsequence matching given key.

Parameters:
xKey to be located.
Returns:
Iterator pointing to the first element greater than key, or end().

Definition at line 645 of file stl_set.h.

value_compare std::set::value_comp ( ) const [inline]

Returns the comparison object with which the set was constructed.

Definition at line 281 of file stl_set.h.


The documentation for this class was generated from the following file: