std::map< _Key, _Tp, _Compare, _Alloc > Class Template Reference
[ContainersAssociative Containers]

List of all members.

Detailed Description

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
class std::map< _Key, _Tp, _Compare, _Alloc >

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 unique keys). For a map<Key,T> the key_type is Key, the mapped_type is T, and the value_type is std::pair<const Key,T>.

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

Definition at line 91 of file stl_map.h.

Public Types

Public Member Functions

Friends

Classes


Constructor & Destructor Documentation

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
std::map< _Key, _Tp, _Compare, _Alloc >::map (  )  [inline]

Default constructor creates no elements.

Definition at line 155 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
std::map< _Key, _Tp, _Compare, _Alloc >::map ( const _Compare &  __comp,
const allocator_type __a = allocator_type() 
) [inline, explicit]

Creates a map with no elements.

Parameters:
comp A comparison object.
a An allocator object.

Definition at line 164 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
std::map< _Key, _Tp, _Compare, _Alloc >::map ( const map< _Key, _Tp, _Compare, _Alloc > &  __x  )  [inline]

Map copy constructor.

Parameters:
x A map of identical element and allocator types.
The newly-created map uses a copy of the allocation object used by x.

Definition at line 175 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
template<typename _InputIterator>
std::map< _Key, _Tp, _Compare, _Alloc >::map ( _InputIterator  __first,
_InputIterator  __last 
) [inline]

Builds a map from a range.

Parameters:
first An input iterator.
last An input iterator.
Create a map 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 200 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
template<typename _InputIterator>
std::map< _Key, _Tp, _Compare, _Alloc >::map ( _InputIterator  __first,
_InputIterator  __last,
const _Compare &  __comp,
const allocator_type __a = allocator_type() 
) [inline]

Builds a map from a range.

Parameters:
first An input iterator.
last An input iterator.
comp A comparison functor.
a An allocator object.
Create a map 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 216 of file stl_map.h.


Member Function Documentation

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
mapped_type& std::map< _Key, _Tp, _Compare, _Alloc >::at ( const key_type __k  )  [inline]

Access to map data.

Parameters:
k The key for which data should be retrieved.
Returns:
A reference to the data whose key is equivalent to k, if such a data is present in the map.
Exceptions:
std::out_of_range If no such data is present.

Definition at line 433 of file stl_map.h.

References __N, and std::lower_bound().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::begin (  )  const [inline]

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

Definition at line 284 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
iterator std::map< _Key, _Tp, _Compare, _Alloc >::begin (  )  [inline]

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

Definition at line 275 of file stl_map.h.

Referenced by __gnu_cxx::throw_allocator_base::check_allocated().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
void std::map< _Key, _Tp, _Compare, _Alloc >::clear (  )  [inline]

Erases all elements in a map. 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 581 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
size_type std::map< _Key, _Tp, _Compare, _Alloc >::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.
This function only makes sense for multimaps; for map the result will either be 0 (not present) or 1 (present).

Definition at line 641 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
bool std::map< _Key, _Tp, _Compare, _Alloc >::empty (  )  const [inline]

Returns true if the map is empty. (Thus begin() would equal end().)

Definition at line 384 of file stl_map.h.

Referenced by __gnu_cxx::throw_allocator_base::empty().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::end (  )  const [inline]

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

Definition at line 302 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
iterator std::map< _Key, _Tp, _Compare, _Alloc >::end (  )  [inline]

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

Definition at line 293 of file stl_map.h.

Referenced by __gnu_cxx::throw_allocator_base::check_allocated(), and __gnu_cxx::throw_allocator_base::insert().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
std::pair<const_iterator, const_iterator> std::map< _Key, _Tp, _Compare, _Alloc >::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).

This function probably only makes sense for multimaps.

Definition at line 729 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
std::pair<iterator, iterator> std::map< _Key, _Tp, _Compare, _Alloc >::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).

This function probably only makes sense for multimaps.

Definition at line 710 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
void std::map< _Key, _Tp, _Compare, _Alloc >::erase ( iterator  __first,
iterator  __last 
) [inline]

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

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 map. 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 552 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
size_type std::map< _Key, _Tp, _Compare, _Alloc >::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 the elements located by the given key from a map. 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 537 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
void std::map< _Key, _Tp, _Compare, _Alloc >::erase ( iterator  __position  )  [inline]

Erases an element from a map.

Parameters:
position An iterator pointing to the element to be erased.
This function erases an element, pointed to by the given iterator, from a map. 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 522 of file stl_map.h.

Referenced by __gnu_cxx::throw_allocator_base::erase().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::find ( const key_type __x  )  const [inline]

Tries to locate an element in a map.

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 629 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
iterator std::map< _Key, _Tp, _Compare, _Alloc >::find ( const key_type __x  )  [inline]

Tries to locate an element in a map.

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 614 of file stl_map.h.

Referenced by __gnu_cxx::throw_allocator_base::check_allocated(), and __gnu_cxx::throw_allocator_base::insert().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
allocator_type std::map< _Key, _Tp, _Compare, _Alloc >::get_allocator (  )  const [inline]

Get a copy of the memory allocation object.

Definition at line 265 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
template<typename _InputIterator>
void std::map< _Key, _Tp, _Compare, _Alloc >::insert ( _InputIterator  __first,
_InputIterator  __last 
) [inline]

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 508 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
iterator std::map< _Key, _Tp, _Compare, _Alloc >::insert ( iterator  __position,
const value_type __x 
) [inline]

Attempts to insert a std::pair into the map.

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 element with key of x (may or may not be the pair 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.

See http://gcc.gnu.org/onlinedocs/libstdc++/23_containers/howto.html#4 for more on "hinting".

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

Definition at line 495 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
std::pair<iterator, bool> std::map< _Key, _Tp, _Compare, _Alloc >::insert ( const value_type __x  )  [inline]

Attempts to insert a std::pair into the map.

Parameters:
x Pair to be inserted (see std::make_pair for easy creation of pairs).
Returns:
A pair, of which the first element is an iterator that points to the possibly inserted pair, and the second is a bool that is true if the pair was actually inserted.
This function attempts to insert a (key, value) pair into the map. A map relies on unique keys and thus a pair is only inserted if its first element (the key) is not already present in the map.

Insertion requires logarithmic time.

Definition at line 468 of file stl_map.h.

Referenced by __gnu_cxx::throw_allocator_base::insert().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
key_compare std::map< _Key, _Tp, _Compare, _Alloc >::key_comp (  )  const [inline]

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

Definition at line 590 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::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 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 671 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
iterator std::map< _Key, _Tp, _Compare, _Alloc >::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 656 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
size_type std::map< _Key, _Tp, _Compare, _Alloc >::max_size (  )  const [inline]

Returns the maximum size of the map.

Definition at line 394 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
map& std::map< _Key, _Tp, _Compare, _Alloc >::operator= ( const map< _Key, _Tp, _Compare, _Alloc > &  __x  )  [inline]

Map assignment operator.

Parameters:
x A map 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 239 of file stl_map.h.

References std::map< _Key, _Tp, _Compare, _Alloc >::_M_t.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
mapped_type& std::map< _Key, _Tp, _Compare, _Alloc >::operator[] ( const key_type __k  )  [inline]

Subscript ( [] ) access to map data.

Parameters:
k The key for which data should be retrieved.
Returns:
A reference to the data of the (key,data) pair.
Allows for easy lookup with the subscript ( [] ) operator. Returns data associated with the key specified in subscript. If the key does not exist, a pair with that key is created using default values, which is then returned.

Lookup requires logarithmic time.

Definition at line 411 of file stl_map.h.

References __glibcxx_function_requires, and std::lower_bound().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rbegin (  )  const [inline]

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

Definition at line 320 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rbegin (  )  [inline]

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

Definition at line 311 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rend (  )  const [inline]

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

Definition at line 338 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rend (  )  [inline]

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

Definition at line 329 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
size_type std::map< _Key, _Tp, _Compare, _Alloc >::size (  )  const [inline]

Returns the size of the map.

Definition at line 389 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
void std::map< _Key, _Tp, _Compare, _Alloc >::swap ( map< _Key, _Tp, _Compare, _Alloc > &  __x  )  [inline]

Swaps data with another map.

Parameters:
x A map of the same element and allocator types.
This exchanges the elements between two maps 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 570 of file stl_map.h.

References std::map< _Key, _Tp, _Compare, _Alloc >::_M_t.

Referenced by std::swap().

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::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 691 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
iterator std::map< _Key, _Tp, _Compare, _Alloc >::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 681 of file stl_map.h.

template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>, typename _Alloc = std::allocator<std::pair<const _Key, _Tp> >>
value_compare std::map< _Key, _Tp, _Compare, _Alloc >::value_comp (  )  const [inline]

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

Definition at line 598 of file stl_map.h.


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 00:44:47 2008 for libstdc++ by  doxygen 1.5.1