GNU g++  v5.2.1
GNU Standard C++
stl_set.h File Reference

This is an internal header file, included by other library headers. More...

Include dependency graph for stl_set.h:

Functions

namespace std _GLIBCXX_VISIBILITY (default)
 

Detailed Description

This is an internal header file, included by other library headers.

Do not attempt to use it directly. {set}

Function Documentation

namespace std _GLIBCXX_VISIBILITY ( default  )

A standard container made up of unique keys, which can be retrieved in logarithmic time.

Template Parameters
_KeyType of key objects.
_CompareComparison function object type, defaults to less<_Key>.
_AllocAllocator type, defaults to allocator<_Key>.

Meets the requirements of a container, a reversible container, and an associative container (using unique keys).

Sets support bidirectional iterators.

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

Public typedefs.

Iterator-related typedefs.

Default constructor creates no elements.

Creates a set with no elements.

Parameters
__compComparator to use.
__aAn allocator object.

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

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

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.

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.

Returns the comparison object with which the set was constructed.

Returns the comparison object with which the set was constructed.

Returns the allocator object with which the set was constructed.

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.

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.

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.

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.

Returns true if the set is empty.

Returns the size of the set.

Returns the maximum size of the set.

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.

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.

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: https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints

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

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.

Erases an element from a set.

Parameters
positionAn 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.

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.

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.

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.

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.

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

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.

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.

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

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

1 std::make_pair(c.lower_bound(val),
2  c.upper_bound(val))

(but is faster than making the calls separately).

This function probably only makes sense for multisets.

Set equality comparison.

Parameters
__xA set.
__yA set of the same type as x.
Returns
True iff the size and elements of the sets are equal.

This is an equivalence relation. It is linear in the size of the sets. Sets are considered equivalent if their sizes are equal, and if corresponding elements compare equal.

Set ordering relation.

Parameters
__xA set.
__yA set of the same type as x.
Returns
True iff __x is lexicographically less than __y.

This is a total ordering relation. It is linear in the size of the sets. The elements must be comparable with <.

See std::lexicographical_compare() for how the determination is made.

Returns !(x == y).

Returns y < x.

Returns !(y < x)

Returns !(x < y)

See std::set::swap().

References __glibcxx_class_requires, __glibcxx_class_requires2, __glibcxx_class_requires4, std::__exception_ptr::operator!=(), std::__exception_ptr::operator==(), __gnu_debug::operator>(), __gnu_debug::operator>=(), and std::__exception_ptr::swap().

Here is the call graph for this function: