libstdc++
std::map Class Reference

List of all members.

Public Types

Public Member Functions

Friends


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


Constructor & Destructor Documentation

std::map::map ( ) [inline]

Default constructor creates no elements.

Definition at line 152 of file stl_map.h.

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

Creates a map with no elements.

Parameters:
compA comparison object.
aAn allocator object.

Definition at line 161 of file stl_map.h.

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

Map copy constructor.

Parameters:
xA map of identical element and allocator types.

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

Definition at line 172 of file stl_map.h.

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

Map move constructor.

Parameters:
xA map of identical element and allocator types.

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

Definition at line 183 of file stl_map.h.

std::map::map ( initializer_list< value_type __l,
const _Compare &  __c = _Compare(),
const allocator_type &  __a = allocator_type() 
) [inline]

Builds a map from an initializer_list.

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

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

Definition at line 197 of file stl_map.h.

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

Builds a map from a range.

Parameters:
firstAn input iterator.
lastAn 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 214 of file stl_map.h.

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

Builds a map from a range.

Parameters:
firstAn input iterator.
lastAn input iterator.
compA comparison functor.
aAn 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 230 of file stl_map.h.


Member Function Documentation

mapped_type& std::map::at ( const key_type &  __k) [inline]

Access to map data.

Parameters:
kThe 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_rangeIf no such data is present.

Definition at line 482 of file stl_map.h.

References lower_bound(), end(), and key_comp().

iterator std::map::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 309 of file stl_map.h.

const_iterator std::map::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 318 of file stl_map.h.

const_iterator std::map::cbegin ( ) 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 382 of file stl_map.h.

const_iterator std::map::cend ( ) 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 391 of file stl_map.h.

void std::map::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 703 of file stl_map.h.

Referenced by operator=().

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

Finds the number of elements with given key.

Parameters:
xKey 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 763 of file stl_map.h.

const_reverse_iterator std::map::crbegin ( ) 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 400 of file stl_map.h.

const_reverse_iterator std::map::crend ( ) 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 409 of file stl_map.h.

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

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

Definition at line 418 of file stl_map.h.

iterator std::map::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 327 of file stl_map.h.

Referenced by operator[](), and at().

const_iterator std::map::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 336 of file stl_map.h.

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

Finds a subsequence matching given key.

Parameters:
xKey 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 832 of file stl_map.h.

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

Finds a subsequence matching given key.

Parameters:
xKey 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 851 of file stl_map.h.

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

Erases an element from a map.

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

size_type std::map::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 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 643 of file stl_map.h.

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

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

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

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

Tries to locate an element in a map.

Parameters:
xKey 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 736 of file stl_map.h.

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

Tries to locate an element in a map.

Parameters:
xKey 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 751 of file stl_map.h.

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

Get a copy of the memory allocation object.

Definition at line 299 of file stl_map.h.

std::pair<iterator, bool> std::map::insert ( const value_type __x) [inline]

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

Parameters:
xPair 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 517 of file stl_map.h.

Referenced by operator=(), and operator[]().

void std::map::insert ( std::initializer_list< value_type __list) [inline]

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

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

Complexity similar to that of the range constructor.

Definition at line 538 of file stl_map.h.

References insert().

Referenced by insert().

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

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

Parameters:
positionAn iterator that serves as a hint as to where the pair should be inserted.
xPair 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++/manual/bk01pt07ch17.html for more on hinting.

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

Definition at line 567 of file stl_map.h.

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

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.

Definition at line 593 of file stl_map.h.

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

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

Definition at line 712 of file stl_map.h.

Referenced by operator[](), and at().

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

Finds the beginning of a subsequence matching given key.

Parameters:
xKey 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 778 of file stl_map.h.

Referenced by operator[](), and at().

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

Finds the beginning of a subsequence matching given key.

Parameters:
xKey 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 793 of file stl_map.h.

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

Returns the maximum size of the map.

Definition at line 428 of file stl_map.h.

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

Map 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:
xA 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 253 of file stl_map.h.

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

Map move assignment operator.

Parameters:
xA map of identical element and allocator types.

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

Definition at line 268 of file stl_map.h.

References clear(), and swap().

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

Map list assignment operator.

Parameters:
lAn initializer_list.

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

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

Definition at line 289 of file stl_map.h.

References clear(), and insert().

mapped_type& std::map::operator[] ( const key_type &  __k) [inline]

Subscript ( [] ) access to map data.

Parameters:
kThe 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 445 of file stl_map.h.

References lower_bound(), end(), key_comp(), and insert().

reverse_iterator std::map::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 345 of file stl_map.h.

const_reverse_iterator std::map::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 354 of file stl_map.h.

reverse_iterator std::map::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 363 of file stl_map.h.

const_reverse_iterator std::map::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 372 of file stl_map.h.

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

Returns the size of the map.

Definition at line 423 of file stl_map.h.

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

Swaps data with another map.

Parameters:
xA 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 693 of file stl_map.h.

Referenced by operator=().

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

Finds the end of a subsequence matching given key.

Parameters:
xKey of (key, value) pair to be located.
Returns:
Iterator pointing to the first element greater than key, or end().

Definition at line 803 of file stl_map.h.

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

Finds the end of a subsequence matching given key.

Parameters:
xKey of (key, value) pair to be located.
Returns:
Read-only (constant) iterator pointing to first iterator greater than key, or end().

Definition at line 813 of file stl_map.h.

value_compare std::map::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 720 of file stl_map.h.


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