libstdc++
|
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).
std::map< _Key, _Tp, _Compare, _Alloc >::map | ( | initializer_list< value_type > | __l, |
const _Compare & | __comp = _Compare() , |
||
const allocator_type & | __a = allocator_type() |
||
) | [inline] |
Builds a map from an initializer_list.
__l | An initializer_list. |
__comp | A comparison object. |
__a | An 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()).
std::map< _Key, _Tp, _Compare, _Alloc >::map | ( | _InputIterator | __first, |
_InputIterator | __last | ||
) | [inline] |
Builds a map from a range.
__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)).
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.
__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)).
mapped_type& std::map< _Key, _Tp, _Compare, _Alloc >::at | ( | const key_type & | __k | ) | [inline] |
Access to map data.
__k | The key for which data should be retrieved. |
std::out_of_range | If no such data is present. |
Definition at line 487 of file stl_map.h.
References std::map< _Key, _Tp, _Compare, _Alloc >::end(), std::map< _Key, _Tp, _Compare, _Alloc >::key_comp(), and std::map< _Key, _Tp, _Compare, _Alloc >::lower_bound().
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 715 of file stl_map.h.
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::operator=().
size_type std::map< _Key, _Tp, _Compare, _Alloc >::count | ( | const key_type & | __x | ) | const [inline] |
Finds the number of elements with given key.
__x | Key of (key, value) pairs to be located. |
This function only makes sense for multimaps; for map the result will either be 0 (not present) or 1 (present).
const_reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::crbegin | ( | ) | const [inline] |
const_reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::crend | ( | ) | const [inline] |
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 332 of file stl_map.h.
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::at(), and std::map< _Key, _Tp, _Compare, _Alloc >::operator[]().
std::pair<iterator, iterator> std::map< _Key, _Tp, _Compare, _Alloc >::equal_range | ( | const key_type & | __x | ) | [inline] |
Finds a subsequence matching given key.
__x | Key of (key, value) pairs to be located. |
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.
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.
__x | Key of (key, value) pairs to be located. |
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.
iterator std::map< _Key, _Tp, _Compare, _Alloc >::erase | ( | const_iterator | __position | ) | [inline] |
Erases an element from a map.
__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.
size_type std::map< _Key, _Tp, _Compare, _Alloc >::erase | ( | const key_type & | __x | ) | [inline] |
Erases elements according to the provided key.
__x | Key of element to be 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.
iterator std::map< _Key, _Tp, _Compare, _Alloc >::erase | ( | const_iterator | __first, |
const_iterator | __last | ||
) | [inline] |
Erases a [first,last) range of elements from a map.
__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.
iterator std::map< _Key, _Tp, _Compare, _Alloc >::find | ( | const key_type & | __x | ) | [inline] |
Tries to locate an element in a map.
__x | Key of (key, value) pair to be located. |
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.
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::find | ( | const key_type & | __x | ) | const [inline] |
Tries to locate an element in a map.
__x | Key of (key, value) pair to be located. |
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.
allocator_type std::map< _Key, _Tp, _Compare, _Alloc >::get_allocator | ( | ) | const [inline] |
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.
__x | Pair to be inserted (see std::make_pair for easy creation of pairs). |
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 522 of file stl_map.h.
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::operator=(), and std::map< _Key, _Tp, _Compare, _Alloc >::operator[]().
void std::map< _Key, _Tp, _Compare, _Alloc >::insert | ( | std::initializer_list< value_type > | __list | ) | [inline] |
Attempts to insert a list of std::pairs into the map.
__list | A std::initializer_list<value_type> of pairs to be inserted. |
Complexity similar to that of the range constructor.
Definition at line 543 of file stl_map.h.
References std::map< _Key, _Tp, _Compare, _Alloc >::insert().
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::insert().
iterator std::map< _Key, _Tp, _Compare, _Alloc >::insert | ( | const_iterator | __position, |
const value_type & | __x | ||
) | [inline] |
Attempts to insert a std::pair into the map.
__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). |
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).
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 724 of file stl_map.h.
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::at(), and std::map< _Key, _Tp, _Compare, _Alloc >::operator[]().
iterator std::map< _Key, _Tp, _Compare, _Alloc >::lower_bound | ( | const key_type & | __x | ) | [inline] |
Finds the beginning of a subsequence matching given key.
__x | Key of (key, value) pair to be located. |
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 790 of file stl_map.h.
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::at(), and std::map< _Key, _Tp, _Compare, _Alloc >::operator[]().
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.
__x | Key of (key, value) pair to be located. |
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.
map& std::map< _Key, _Tp, _Compare, _Alloc >::operator= | ( | const map< _Key, _Tp, _Compare, _Alloc > & | __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.
__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.
map& std::map< _Key, _Tp, _Compare, _Alloc >::operator= | ( | map< _Key, _Tp, _Compare, _Alloc > && | __x | ) | [inline] |
Map move assignment operator.
__x | A 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 273 of file stl_map.h.
References std::map< _Key, _Tp, _Compare, _Alloc >::clear(), and std::map< _Key, _Tp, _Compare, _Alloc >::swap().
map& std::map< _Key, _Tp, _Compare, _Alloc >::operator= | ( | initializer_list< value_type > | __l | ) | [inline] |
Map list assignment operator.
__l | An 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 294 of file stl_map.h.
References std::map< _Key, _Tp, _Compare, _Alloc >::clear(), and std::map< _Key, _Tp, _Compare, _Alloc >::insert().
mapped_type& std::map< _Key, _Tp, _Compare, _Alloc >::operator[] | ( | const key_type & | __k | ) | [inline] |
Subscript ( [] ) access to map data.
__k | The key for which data should be retrieved. |
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 450 of file stl_map.h.
References std::map< _Key, _Tp, _Compare, _Alloc >::end(), std::map< _Key, _Tp, _Compare, _Alloc >::insert(), std::map< _Key, _Tp, _Compare, _Alloc >::key_comp(), and std::map< _Key, _Tp, _Compare, _Alloc >::lower_bound().
reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rbegin | ( | ) | [inline] |
const_reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rbegin | ( | ) | const [inline] |
reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rend | ( | ) | [inline] |
const_reverse_iterator std::map< _Key, _Tp, _Compare, _Alloc >::rend | ( | ) | const [inline] |
void std::map< _Key, _Tp, _Compare, _Alloc >::swap | ( | map< _Key, _Tp, _Compare, _Alloc > & | __x | ) | [inline] |
Swaps data with another map.
__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 705 of file stl_map.h.
Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::operator=(), and std::swap().
iterator std::map< _Key, _Tp, _Compare, _Alloc >::upper_bound | ( | const key_type & | __x | ) | [inline] |
const_iterator std::map< _Key, _Tp, _Compare, _Alloc >::upper_bound | ( | const key_type & | __x | ) | const [inline] |
value_compare std::map< _Key, _Tp, _Compare, _Alloc >::value_comp | ( | ) | const [inline] |