__gnu_debug_def::multimap(3)

NAME

__gnu_debug_def::multimap

SYNOPSIS

Inherits std::multimap< Key, Type, Compare,  Allocator  >,
and         __gnu_debug::Safe_sequence<        Sequence        ><
__gnu_debug_def::multimap< Key, Type, Compare, Allocator > >.
Public Types
typedef Key key_type
typedef Type mapped_type
typedef std::pair< const Key, Type > value_type
typedef Compare key_compare
typedef Allocator allocator_type
typedef Allocator::reference reference
typedef Allocator::const_reference const_reference
typedef        __gnu_debug::Safe_iterator<        typename

Base::iterator

typedef __gnu_debug::Safe_iterator< typename

Base::const_iterator

typedef Base::size_type size_type typedef Base::difference_type difference_type typedef Allocator::pointer pointer
typedef Allocator::const_pointer const_pointer typedef std::reverse_iterator< iterator > reverse_iterator typedef std::reverse_iterator< const_iterator >

const_reverse_iterator

Public Member Functions

multimap (const Compare &comp=Compare(), const Allocator

&a=Allocator())
template<typename InputIterator> multimap (InputIterator

first, InputIterator last, const Compare &comp=Compare(), const

Allocator &a=Allocator())
multimap (const multimap< Key, Type, Compare, Allocator >

&x)
multimap (const Base &x)
~multimap ()
multimap< Key, Type, Compare, Allocator > & operator=

(const multimap< Key, Type, Compare, Allocator > &x)
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
reverse_iterator rbegin () const_reverse_iterator rbegin () const reverse_iterator rend ()
const_reverse_iterator rend () const iterator insert (const value_type &x) iterator insert (iterator position, const value_type &x) template<typename InputIterator> void insert (InputItera

tor first, InputIterator last)

A template function that attemps to insert a range of

elements.

void erase (iterator position)
size_type erase (const key_type &x)

Erases elements according to the provided key.

void erase (iterator first, iterator last) void swap (multimap< Key, Type, Compare, Allocator > &x) void clear ()
iterator find (const key_type &x)

Tries to locate an element in a multimap.

const_iterator find (const key_type &x) const

Tries to locate an element in a multimap.

iterator lower_bound (const key_type &x)

Finds the beginning of a subsequence matching given

key.

const_iterator lower_bound (const key_type &x) const

Finds the beginning of a subsequence matching given

key.

iterator upper_bound (const key_type &x)

Finds the end of a subsequence matching given key.

const_iterator upper_bound (const key_type &x) const

Finds the end of a subsequence matching given key.

std::pair< iterator, iterator > equal_range (const

key_type &x)

Finds a subsequence matching given key.

std::pair< const_iterator, const_iterator > equal_range

(const key_type &x) const

Finds a subsequence matching given key.

Base & M_base ()
const Base & M_base () const
allocator_type get_allocator () const

Get a copy of the memory allocation object.

bool empty () const
size_type size () const
size_type max_size () const
iterator insert (const value_type &x)

Inserts a std::pair into the multimap.

iterator insert (iterator position, const value_type &x)

Inserts a std::pair into the multimap.

void erase (iterator position)

Erases an element from a multimap.

void erase (iterator first, iterator last)

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

multimap.

void swap (multimap &x)

Swaps data with another multimap.

key_compare key_comp () const value_compare value_comp () const size_type count (const key_type &x) const

Finds the number of elements with given key.

template<typename Predicate> void M_invalidate_if

(Predicate pred)
template<typename Iterator> void M_transfer_iter (const

Safe_iterator< Iterator, Sequence > &x)

void M_invalidate_all () const

Public Attributes

Safe_iterator_base * M_iterators

The list of mutable iterators that reference this

container.

Safe_iterator_base * M_const_iterators

The list of constant iterators that reference this

container.

unsigned int M_version

The container version number. This number may never be

0.

Protected Member Functions

void M_detach_all ()
void M_detach_singular ()
void M_revalidate_singular () void M_swap (Safe_sequence_base &x)

Private Types

typedef std::multimap< Key, Type, Compare, Allocator >

Base

typedef __gnu_debug::Safe_sequence< multimap > Safe_base

Private Member Functions

void M_invalidate_all ()

Detailed Description

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> class

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >

Definition at line 42 of file debug/multimap.h.

Member Function Documentation

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::begin

() [inline]

Returns a read/write iterator that points to the first

pair in the multimap. Iteration is done in ascending order ac

cording to the keys.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 104 of file debug/multimap.h.

Referenced by __gnu_debug_def::multimap< Key, Type, Com

pare, Allocator >::clear(), and __gnu_debug_def::multimap< Key,

Type, Compare, Allocator >::rend().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> const_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::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.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 108 of file debug/multimap.h.

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::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.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 112 of file debug/multimap.h.

Referenced by __gnu_debug_def::multimap< Key, Type, Com

pare, Allocator >::clear(), __gnu_debug_def::multimap< Key, Type,

Compare, Allocator >::M_invalidate_all(), and __gnu_de

bug_def::multimap< Key, Type, Compare, Allocator >::rbegin().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> const_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::end

() const [inline]

Returns a read-only (constant) iterator that points one

past the last pair in the multimap. Iteration is done in ascend

ing order according to the keys.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 116 of file debug/multimap.h.

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> reverse_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator

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

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 120 of file debug/multimap.h.

References __gnu_debug_def::multimap< Key, Type, Compare,

Allocator >::end().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >>

const_reverse_iterator __gnu_debug_def::multimap< Key, Type,

Compare, Allocator >::rbegin () const [inline]

Returns a read-only (constant) reverse iterator that

points to the last pair in the multimap. Iteration is done in de

scending order according to the keys.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 124 of file debug/multimap.h.

References __gnu_debug_def::multimap< Key, Type, Compare,

Allocator >::end().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> reverse_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::rend

() [inline]

Returns a read/write reverse iterator that points to one

before the first pair in the multimap. Iteration is done in de

scending order according to the keys.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 128 of file debug/multimap.h.

References __gnu_debug_def::multimap< Key, Type, Compare,

Allocator >::begin().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >>

const_reverse_iterator __gnu_debug_def::multimap< Key, Type,

Compare, Allocator >::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.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 132 of file debug/multimap.h.

References __gnu_debug_def::multimap< Key, Type, Compare,

Allocator >::begin().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> template<typename

InputIterator> void __gnu_debug_def::multimap< Key, Type,

Compare, Allocator >::insert (InputIterator first, InputIterator

last) [inline]
A template function that attemps to insert a range of ele

ments.

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.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 154 of file debug/multimap.h.

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> size_type

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::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 memo

ry is not touched in any way. Managing the pointer is the user's

responsibilty.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 169 of file debug/multimap.h.

References __gnu_debug::Safe_iterator< Iterator, Sequence

>::base(), __gnu_debug_def::multimap< Key, Type, Compare, Alloca

tor >::equal_range(), std::pair< T1, T2 >::first, and std::pair<

T1, T2 >::second.

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> void

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::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. Manag

ing the pointer is the user's responsibilty.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 201 of file debug/multimap.h.

References __gnu_debug_def::multimap< Key, Type, Compare,

Allocator >::begin(), __gnu_debug_def::multimap< Key, Type, Com

pare, Allocator >::end(), and __gnu_debug_def::multimap< Key,

Type, Compare, Allocator >::erase().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::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.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 210 of file debug/multimap.h.

References std::find().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> const_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator >::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 unsuc

cessful it returns the past-the-end ( end() ) iterator.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 214 of file debug/multimap.h.

References std::find().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator

>::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 re

turns an iterator pointing to the first element that has a

greater value than given key or end() if no such element exists.

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 220 of file debug/multimap.h.

References std::lower_bound().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> const_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator

>::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 ele

ment 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 iter

ator will point to the next greatest element or, if no such

greater element exists, to end().

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 224 of file debug/multimap.h.

References std::lower_bound().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator

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

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 228 of file debug/multimap.h.

References std::upper_bound().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >> const_iterator

__gnu_debug_def::multimap< Key, Type, Compare, Allocator

>::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 itera

tor greater than key, or end().

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 232 of file debug/multimap.h.

References std::upper_bound().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >>

std::pair<iterator,iterator> __gnu_debug_def::multimap< Key,

Type, Compare, Allocator >::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 subse

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

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 236 of file debug/multimap.h.

References std::equal_range(), std::pair< T1, T2 >::first,

std::make_pair(), and std::pair< T1, T2 >::second.

Referenced by __gnu_debug_def::multimap< Key, Type, Com

pare, Allocator >::erase().

template<typename Key, typename Type, typename Compare =

std::less<Key>, typename Allocator =

std::allocator<std::pair<const Key, Type> >>

std::pair<const_iterator,const_iterator>

__gnu_debug_def::multimap< Key, Type, Compare, Allocator

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

Reimplemented from std::multimap< Key, Type, Compare,

Allocator >

Definition at line 246 of file debug/multimap.h.

References std::equal_range(), std::pair< T1, T2 >::first,

std::make_pair(), and std::pair< T1, T2 >::second.

allocator_type std::multimap< Key , Type , Compare , Allocator

>::get_allocator () const [inline, inherited]

Get a copy of the memory allocation object.

Definition at line 241 of file stl_multimap.h.

References std::multimap< Key, Type, Compare, Alloc

>::get_allocator().

bool std::multimap< Key , Type , Compare , Allocator >::empty

() const [inline, inherited]

Returns true if the multimap is empty.

Definition at line 320 of file stl_multimap.h.

size_type std::multimap< Key , Type , Compare , Allocator

>::size () const [inline, inherited]

Returns the size of the multimap.

Definition at line 325 of file stl_multimap.h.

size_type std::multimap< Key , Type , Compare , Allocator

>::max_size (void) const [inline, inherited]

Returns the maximum size of the multimap.

Definition at line 330 of file stl_multimap.h.

iterator std::multimap< Key , Type , Compare , Allocator

>::insert (const value_type & x) [inline, inherited]

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 mul

timap. Contrary to a std::map the multimap does not rely on

unique keys and thus multiple pairs with the same key can be in

serted.

Insertion requires logarithmic time.

Definition at line 347 of file stl_multimap.h.

iterator std::multimap< Key , Type , Compare , Allocator

>::insert (iterator position, const value_type & x) [inline,

inherited]

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 mul

timap. Contrary to a std::map the multimap does not rely on

unique keys and thus multiple pairs with the same key can be in

serted. Note that the first parameter is only a hint and can po

tentially improve the performance of the insertion process. A bad

hint would cause no gains in efficiency.

See http://gcc.gnu.org/onlinedocs/libstdc++/23_contain

ers/howto.html#4 for more on 'hinting'.

Insertion requires logarithmic time (if the hint is not

taken).

Definition at line 371 of file stl_multimap.h.

void std::multimap< Key , Type , Compare , Allocator >::erase

(iterator position) [inline, inherited]

Erases an element from a multimap.

Parameters:

position An iterator pointing to the element to be

erased.

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

Definition at line 398 of file stl_multimap.h.

void std::multimap< Key , Type , Compare , Allocator >::erase

(iterator first, iterator last) [inline, inherited]

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.

This function erases a sequence of elements from a mul

timap. 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 re

sponsibilty.

Definition at line 428 of file stl_multimap.h.

void std::multimap< Key , Type , Compare , Allocator >::swap

(multimap< Key, Type, Compare, Allocator > & x) [inline,

inherited]

Swaps data with another multimap.

Parameters:

x A multimap of the same element and allocator types.

This exchanges the elements between two multimaps in con

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

key_compare std::multimap< Key , Type , Compare , Allocator

>::key_comp () const [inline, inherited]

Returns the key comparison object out of which the mul

timap was constructed.

Definition at line 462 of file stl_multimap.h.

value_compare std::multimap< Key , Type , Compare , Allocator

>::value_comp () const [inline, inherited]

Returns a value comparison object, built from the key com

parison object out of which the multimap was constructed.

Definition at line 470 of file stl_multimap.h.

size_type std::multimap< Key , Type , Compare , Allocator

>::count (const key_type & x) const [inline, inherited]

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

template<typename Sequence> template<typename Predicate> void

__gnu_debug::Safe_sequence< Sequence >::M_invalidate_if

(Predicate pred) [inherited]

Invalidates all iterators x that reference this sequence,

are not singular, and for which pred(x) returns true. The user of

this routine should be careful not to make copies of the itera

tors passed to pred, as the copies may interfere with the invali

dation.

Definition at line 120 of file safe_sequence.h.

template<typename Sequence> template<typename Iterator> void

__gnu_debug::Safe_sequence< Sequence >::M_transfer_iter (const

Safe_iterator< Iterator, Sequence > & x) [inherited]

Transfers all iterators that reference this memory loca

tion to this sequence from whatever sequence they are attached

to.

Definition at line 152 of file safe_sequence.h.

void __gnu_debug::Safe_sequence_base::M_detach_all ()

[protected, inherited]

Detach all iterators, leaving them singular.

Definition at line 114 of file debug.cc.

void __gnu_debug::Safe_sequence_base::M_detach_singular ()

[protected, inherited]

Detach all singular iterators.

Postcondition:

for all iterators i attached to this sequence,

i->M_version == M_version.

Definition at line 133 of file debug.cc.

void __gnu_debug::Safe_sequence_base::M_revalidate_singular ()

[protected, inherited]

Revalidates all attached singular iterators. This method

may be used to validate iterators that were invalidated before

(but for some reasion, such as an exception, need to become valid

again).

Definition at line 154 of file debug.cc.

void __gnu_debug::Safe_sequence_base::M_swap

(Safe_sequence_base & x) [protected, inherited]

Swap this sequence with the given sequence. This operation

also swaps ownership of the iterators, so that when the operation

is complete all iterators that originally referenced one contain

er now reference the other container.

Definition at line 172 of file debug.cc.

References __gnu_debug::swap().

void __gnu_debug::Safe_sequence_base::M_invalidate_all ()

const [inline, inherited]

Invalidates all iterators.

Definition at line 202 of file safe_base.h.

Member Data Documentation

Safe_iterator_base*

__gnu_debug::Safe_sequence_base::M_iterators [inherited]

The list of mutable iterators that reference this contain

er.

Definition at line 153 of file safe_base.h.

Safe_iterator_base*

__gnu_debug::Safe_sequence_base::M_const_iterators [inherited]

The list of constant iterators that reference this con

tainer.

Definition at line 156 of file safe_base.h.

unsigned int __gnu_debug::Safe_sequence_base::M_version

[mutable, inherited]

The container version number. This number may never be 0.

Definition at line 159 of file safe_base.h.

Author

Generated automatically by Doxygen for libstdc++-v3 Source

from the source code.

libstdc++-v3 Source 1 Jan 2007 __gnu_de

bug_def::multimap(3)