libstdc++
std::multiset Class Reference

List of all members.

Public Types

Public Member Functions


Detailed Description

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

Meets the requirements of a container, a reversible container, and an associative container (using equivalent keys). For a multiset<Key> the key_type and value_type are Key.

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


Constructor & Destructor Documentation

std::multiset::multiset ( ) [inline]

Default constructor creates no elements.

Definition at line 131 of file stl_multiset.h.

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

Creates a multiset with no elements.

Parameters:
compComparator to use.
aAn allocator object.

Definition at line 140 of file stl_multiset.h.

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

Builds a multiset from a range.

Parameters:
firstAn input iterator.
lastAn input iterator.

Create a multiset 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 154 of file stl_multiset.h.

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

Builds a multiset from a range.

Parameters:
firstAn input iterator.
lastAn input iterator.
compA comparison functor.
aAn allocator object.

Create a multiset 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 170 of file stl_multiset.h.

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

Multiset copy constructor.

Parameters:
xA multiset of identical element and allocator types.

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

Definition at line 183 of file stl_multiset.h.

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

Multiset move constructor.

Parameters:
xA multiset of identical element and allocator types.

The newly-created multiset contains the exact contents of x. The contents of x are a valid, but unspecified multiset.

Definition at line 194 of file stl_multiset.h.

std::multiset::multiset ( initializer_list< value_type >  __l,
const _Compare &  __comp = _Compare(),
const allocator_type &  __a = allocator_type() 
) [inline]

Builds a multiset from an initializer_list.

Parameters:
lAn initializer_list.
compA comparison functor.
aAn allocator object.

Create a multiset consisting of copies of the elements from the list. This is linear in N if the list is already sorted, and NlogN otherwise (where N is l.size()).

Definition at line 207 of file stl_multiset.h.


Member Function Documentation

iterator std::multiset::begin ( ) const [inline]

Returns a read-only (constant) iterator that points to the first element in the multiset. Iteration is done in ascending order according to the keys.

Definition at line 287 of file stl_multiset.h.

iterator std::multiset::cbegin ( ) const [inline]

Returns a read-only (constant) iterator that points to the first element in the multiset. Iteration is done in ascending order according to the keys.

Definition at line 324 of file stl_multiset.h.

iterator std::multiset::cend ( ) const [inline]

Returns a read-only (constant) iterator that points one past the last element in the multiset. Iteration is done in ascending order according to the keys.

Definition at line 333 of file stl_multiset.h.

void std::multiset::clear ( ) [inline]

Erases all elements in a multiset. 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 557 of file stl_multiset.h.

Referenced by operator=().

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

Finds the number of elements with given key.

Parameters:
xKey of elements to be located.
Returns:
Number of elements with specified key.

Definition at line 568 of file stl_multiset.h.

reverse_iterator std::multiset::crbegin ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to the last element in the multiset. Iteration is done in descending order according to the keys.

Definition at line 342 of file stl_multiset.h.

reverse_iterator std::multiset::crend ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to the last element in the multiset. Iteration is done in descending order according to the keys.

Definition at line 351 of file stl_multiset.h.

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

Returns true if the set is empty.

Definition at line 357 of file stl_multiset.h.

iterator std::multiset::end ( ) const [inline]

Returns a read-only (constant) iterator that points one past the last element in the multiset. Iteration is done in ascending order according to the keys.

Definition at line 296 of file stl_multiset.h.

std::pair<iterator, iterator> std::multiset::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 648 of file stl_multiset.h.

std::pair<const_iterator, const_iterator> std::multiset::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 652 of file stl_multiset.h.

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

Erases an element from a multiset.

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 multiset. 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 480 of file stl_multiset.h.

size_type std::multiset::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 elements located by the given key from a multiset. 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 510 of file stl_multiset.h.

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

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

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 multiset. 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 530 of file stl_multiset.h.

iterator std::multiset::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 586 of file stl_multiset.h.

const_iterator std::multiset::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 590 of file stl_multiset.h.

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

Returns the memory allocation object.

Definition at line 278 of file stl_multiset.h.

iterator std::multiset::insert ( const value_type &  __x) [inline]

Inserts an element into the multiset.

Parameters:
xElement to be inserted.
Returns:
An iterator that points to the inserted element.

This function inserts an element into the multiset. Contrary to a std::set the multiset does not rely on unique keys and thus multiple copies of the same element can be inserted.

Insertion requires logarithmic time.

Definition at line 398 of file stl_multiset.h.

Referenced by operator=().

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

Inserts an element into the multiset.

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 inserted element.

This function inserts an element into the multiset. Contrary to a std::set the multiset does not rely on unique keys and thus multiple copies of the same element can be inserted.

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++/manual/bk01pt07ch17.html for more on hinting.

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

Definition at line 428 of file stl_multiset.h.

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

A template function that tries 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 447 of file stl_multiset.h.

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

Attempts to insert a list of elements into the multiset.

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

Complexity similar to that of the range constructor.

Definition at line 459 of file stl_multiset.h.

References insert().

Referenced by insert().

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

Returns the comparison object.

Definition at line 270 of file stl_multiset.h.

iterator std::multiset::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 607 of file stl_multiset.h.

const_iterator std::multiset::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 611 of file stl_multiset.h.

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

Returns the maximum size of the set.

Definition at line 367 of file stl_multiset.h.

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

Multiset assignment operator.

Parameters:
xA multiset 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 222 of file stl_multiset.h.

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

Multiset move assignment operator.

Parameters:
xA multiset of identical element and allocator types.

The contents of x are moved into this multiset (without copying). x is a valid, but unspecified multiset.

Definition at line 237 of file stl_multiset.h.

References clear(), and swap().

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

Multiset list assignment operator.

Parameters:
lAn initializer_list.

This function fills a multiset with copies of the elements in the initializer list l.

Note that the assignment completely changes the multiset and that the resulting multiset's size is the same as the number of elements assigned. Old data may be lost.

Definition at line 258 of file stl_multiset.h.

References clear(), and insert().

reverse_iterator std::multiset::rbegin ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to the last element in the multiset. Iteration is done in descending order according to the keys.

Definition at line 305 of file stl_multiset.h.

reverse_iterator std::multiset::rend ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to the last element in the multiset. Iteration is done in descending order according to the keys.

Definition at line 314 of file stl_multiset.h.

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

Returns the size of the set.

Definition at line 362 of file stl_multiset.h.

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

Swaps data with another multiset.

Parameters:
xA multiset of the same element and allocator types.

This exchanges the elements between two multisets 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 382 of file stl_multiset.h.

Referenced by operator=().

iterator std::multiset::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 623 of file stl_multiset.h.

const_iterator std::multiset::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 627 of file stl_multiset.h.

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

Returns the comparison object.

Definition at line 274 of file stl_multiset.h.


Friends And Related Function Documentation

template<typename _K1 , typename _C1 , typename _A1 >
bool operator< ( const multiset< _K1, _C1, _A1 > &  ,
const multiset< _K1, _C1, _A1 > &   
) [friend]

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.

template<typename _K1 , typename _C1 , typename _A1 >
bool operator== ( const multiset< _K1, _C1, _A1 > &  ,
const multiset< _K1, _C1, _A1 > &   
) [friend]

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.


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