Public Types

typedef _Alloc allocator_type
typedef _Rep_type::const_iterator const_iterator
typedef
_Pair_alloc_type::const_pointer const_pointer
typedef
_Pair_alloc_type::const_reference const_reference
typedef
_Rep_type::const_reverse_iterator const_reverse_iterator
typedef _Rep_type::difference_type difference_type
typedef _Rep_type::iterator iterator
typedef _Compare key_compare
typedef _Key key_type
typedef _Tp mapped_type
typedef _Pair_alloc_type::pointer pointer
typedef _Pair_alloc_type::reference reference
typedef _Rep_type::reverse_iterator reverse_iterator
typedef _Rep_type::size_type size_type
typedef std::pair< const _Key,
_Tp > value_type

Public Member Functions

multimap ()
multimap (const _Compare &__comp, const allocator_type &__a=allocator_type())
multimap (const multimap &__x)
multimap (multimap &&__x)
multimap (initializer_list< value_type > __l, const _Compare &__comp=_Compare(), const allocator_type &__a=allocator_type())
template<typename _InputIterator > multimap (_InputIterator __first, _InputIterator __last)
template<typename _InputIterator > multimap (_InputIterator __first, _InputIterator __last, const _Compare &__comp, const allocator_type &__a=allocator_type())
iterator begin ()
const_iterator begin () const
const_iterator cbegin () const
const_iterator cend () const
void clear ()
size_type count (const key_type &__x) const
const_reverse_iterator crbegin () const
const_reverse_iterator crend () const
bool empty () const
iterator end ()
const_iterator end () const
std::pair< iterator, iterator > equal_range (const key_type &__x)
std::pair< const_iterator,
const_iterator > equal_range (const key_type &__x) const
iterator erase (const_iterator __position)
size_type erase (const key_type &__x)
iterator erase (const_iterator __first, const_iterator __last)
iterator find (const key_type &__x)
const_iterator find (const key_type &__x) const
allocator_type get_allocator () const
iterator insert (const value_type &__x)
template<typename _Pair , typename = typename std::enable_if<std::is_convertible<_Pair, value_type>::value>::type> iterator insert (_Pair &&__x)
iterator insert (const_iterator __position, const value_type &__x)
template<typename _Pair , typename = typename std::enable_if<std::is_convertible<_Pair, value_type>::value>::type> iterator insert (const_iterator __position, _Pair &&__x)
template<typename _InputIterator > void insert (_InputIterator __first, _InputIterator __last)
void insert (initializer_list< value_type > __l)
key_compare key_comp () const
iterator lower_bound (const key_type &__x)
const_iterator lower_bound (const key_type &__x) const
size_type max_size () const
multimap & operator= (const multimap &__x)
multimap & operator= (multimap &&__x)
multimap & operator= (initializer_list< value_type > __l)
reverse_iterator rbegin ()
const_reverse_iterator rbegin () const
reverse_iterator rend ()
const_reverse_iterator rend () const
size_type size () const
void swap (multimap &__x)
iterator upper_bound (const key_type &__x)
const_iterator upper_bound (const key_type &__x) const
value_compare value_comp () const

Friends

template<typename _K1 , typename _T1 , typename _C1 , typename _A1 > bool operator< (const multimap< _K1, _T1, _C1, _A1 > &, const multimap< _K1, _T1, _C1, _A1 > &)
template<typename _K1 , typename _T1 , typename _C1 , typename _A1 > bool operator== (const multimap< _K1, _T1, _C1, _A1 > &, const multimap< _K1, _T1, _C1, _A1 > &)

Detailed Description

A standard container made up of (key,value) pairs, which can be retrieved based on a key, in logarithmic time.

Meets the requirements of a container, a reversible container, and an associative container (using equivalent keys). For a multimap<Key,T> the key_type is Key, the mapped_type is T, and the value_type is std::pair<const Key,T>.

Multimaps support bidirectional iterators.

The private tree data is declared exactly the same way for map and multimap; the distinction is made entirely in how the tree functions are called (*_unique versus *_equal, same as the standard).

Constructor & Destructor Documentation

std::multimap::multimap ( ) [inline]

Default constructor creates no elements.

Definition at line 150 of file stl_multimap.h.

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

Creates a multimap with no elements.

Parameters:

comp	A comparison object.
a	An allocator object.

Definition at line 159 of file stl_multimap.h.

std::multimap::multimap ( const multimap & __x ) [inline]

Multimap copy constructor.

Parameters:

x	A multimap of identical element and allocator types.

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

Definition at line 170 of file stl_multimap.h.

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

Multimap move constructor.

Parameters:

x	A multimap of identical element and allocator types.

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

Definition at line 181 of file stl_multimap.h.

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

Builds a multimap from an initializer_list.

Parameters:

l	An initializer_list.
comp	A comparison functor.
a	An allocator object.

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

Definition at line 194 of file stl_multimap.h.

template<typename _InputIterator >

std::multimap::multimap	(	_InputIterator	__first,
		_InputIterator	__last
	)		`[inline]`

Builds a multimap from a range.

Parameters:

first	An input iterator.
last	An input iterator.

Create a multimap 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 211 of file stl_multimap.h.

template<typename _InputIterator >

std::multimap::multimap	(	_InputIterator	__first,
		_InputIterator	__last,
		const _Compare &	__comp,
		const allocator_type &	__a = `allocator_type()`
	)		`[inline]`

Builds a multimap from a range.

Parameters:

first	An input iterator.
last	An input iterator.
comp	A comparison functor.
a	An allocator object.

Create a multimap 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 227 of file stl_multimap.h.

Member Function Documentation

iterator std::multimap::begin ( ) [inline]

Returns a read/write iterator that points to the first pair in the multimap. Iteration is done in ascending order according to the keys.

Definition at line 306 of file stl_multimap.h.

const_iterator std::multimap::begin ( ) const [inline]

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

Definition at line 315 of file stl_multimap.h.

const_iterator std::multimap::cbegin ( ) const [inline]

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

Definition at line 379 of file stl_multimap.h.

const_iterator std::multimap::cend ( ) const [inline]

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

Definition at line 388 of file stl_multimap.h.

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

Erases all elements in a multimap. 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 628 of file stl_multimap.h.

Referenced by operator=().

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

Finds the number of elements with given key.

Parameters:

x	Key of (key, value) pairs to be located.

Returns:: Number of elements with specified key.

Definition at line 685 of file stl_multimap.h.

const_reverse_iterator std::multimap::crbegin ( ) const [inline]

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

Definition at line 397 of file stl_multimap.h.

const_reverse_iterator std::multimap::crend ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to one before the first pair in the multimap. Iteration is done in descending order according to the keys.

Definition at line 406 of file stl_multimap.h.

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

Returns true if the multimap is empty.

Definition at line 413 of file stl_multimap.h.

iterator std::multimap::end ( ) [inline]

Returns a read/write iterator that points one past the last pair in the multimap. Iteration is done in ascending order according to the keys.

Definition at line 324 of file stl_multimap.h.

const_iterator std::multimap::end ( ) const [inline]

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

Definition at line 333 of file stl_multimap.h.

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

Finds a subsequence matching given key.

Parameters:

x	Key of (key, value) pairs 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).

Definition at line 752 of file stl_multimap.h.

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

Finds a subsequence matching given key.

Parameters:

x	Key of (key, value) pairs to be located.

Returns:: Pair of read-only (constant) 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).

Definition at line 769 of file stl_multimap.h.

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

Erases an element from a multimap.

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 multimap. 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 534 of file stl_multimap.h.

size_type std::multimap::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 elements located by the given key from a multimap. 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 564 of file stl_multimap.h.

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

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

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 multimap. 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 584 of file stl_multimap.h.

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

Tries to locate an element in a multimap.

Parameters:

x	Key of (key, value) pair 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 pair. If unsuccessful it returns the past-the-end ( end() ) iterator.

Definition at line 661 of file stl_multimap.h.

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

Tries to locate an element in a multimap.

Parameters:

x	Key of (key, value) pair to be located.

Returns:: Read-only (constant) 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 a constant iterator pointing to the sought after pair. If unsuccessful it returns the past-the-end ( end() ) iterator.

Definition at line 676 of file stl_multimap.h.

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

Get a copy of the memory allocation object.

Definition at line 296 of file stl_multimap.h.

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

Inserts a std::pair into the multimap.

Parameters:

x	Pair to be inserted (see std::make_pair for easy creation of pairs).

Returns:: An iterator that points to the inserted (key,value) pair.

This function inserts a (key, value) pair into the multimap. Contrary to a std::map the multimap does not rely on unique keys and thus multiple pairs with the same key can be inserted.

Insertion requires logarithmic time.

Definition at line 440 of file stl_multimap.h.

Referenced by operator=().

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

Inserts a std::pair into the multimap.

Parameters:

position	An iterator that serves as a hint as to where the pair should be inserted.
x	Pair to be inserted (see std::make_pair for easy creation of pairs).

Returns:: An iterator that points to the inserted (key,value) pair.

This function inserts a (key, value) pair into the multimap. Contrary to a std::map the multimap does not rely on unique keys and thus multiple pairs with the same key 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.

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 474 of file stl_multimap.h.

template<typename _InputIterator >

void std::multimap::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 501 of file stl_multimap.h.

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

Attempts to insert a list of std::pairs into the multimap.

Parameters:

list	A std::initializer_list<value_type> of pairs to be inserted.

Complexity similar to that of the range constructor.

Definition at line 513 of file stl_multimap.h.

References insert().

Referenced by insert().

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

Returns the key comparison object out of which the multimap was constructed.

Definition at line 637 of file stl_multimap.h.

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

Finds the beginning of a subsequence matching given key.

Parameters:

x	Key of (key, value) pair 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 700 of file stl_multimap.h.

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

Finds the beginning of a subsequence matching given key.

Parameters:

x	Key of (key, value) pair to be located.

Returns:: Read-only (constant) 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 the iterator will point to the next greatest element or, if no such greater element exists, to end().

Definition at line 715 of file stl_multimap.h.

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

Returns the maximum size of the multimap.

Definition at line 423 of file stl_multimap.h.

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

Multimap assignment operator.

The dtor only erases the elements, and note 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.

Parameters:

x	A multimap 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 250 of file stl_multimap.h.

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

Multimap move assignment operator.

Parameters:

x	A multimap of identical element and allocator types.

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

Definition at line 265 of file stl_multimap.h.

References clear(), and swap().

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

Multimap list assignment operator.

Parameters:

l	An initializer_list.

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

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

Definition at line 286 of file stl_multimap.h.

References clear(), and insert().

reverse_iterator std::multimap::rbegin ( ) [inline]

Returns a read/write reverse iterator that points to the last pair in the multimap. Iteration is done in descending order according to the keys.

Definition at line 342 of file stl_multimap.h.

const_reverse_iterator std::multimap::rbegin ( ) const [inline]

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

Definition at line 351 of file stl_multimap.h.

reverse_iterator std::multimap::rend ( ) [inline]

Returns a read/write reverse iterator that points to one before the first pair in the multimap. Iteration is done in descending order according to the keys.

Definition at line 360 of file stl_multimap.h.

const_reverse_iterator std::multimap::rend ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to one before the first pair in the multimap. Iteration is done in descending order according to the keys.

Definition at line 369 of file stl_multimap.h.

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

Returns the size of the multimap.

Definition at line 418 of file stl_multimap.h.

void std::multimap::swap ( multimap & __x ) [inline]

Swaps data with another multimap.

Parameters:

x	A multimap of the same element and allocator types.

This exchanges the elements between two multimaps 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(m1,m2) will feed to this function.

Definition at line 618 of file stl_multimap.h.

Referenced by operator=().

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

Finds the end of a subsequence matching given key.

Parameters:

x	Key of (key, value) pair to be located.

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

Definition at line 725 of file stl_multimap.h.

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

Finds the end of a subsequence matching given key.

Parameters:

x	Key of (key, value) pair to be located.

Returns:: Read-only (constant) iterator pointing to first iterator greater than key, or end().

Definition at line 735 of file stl_multimap.h.

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

Returns a value comparison object, built from the key comparison object out of which the multimap was constructed.

Definition at line 645 of file stl_multimap.h.

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

stl_multimap.h