1 // Multimap implementation -*- C++ -*-
3 // Copyright (C) 2001-2015 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
28 * Hewlett-Packard Company
30 * Permission to use, copy, modify, distribute and sell this software
31 * and its documentation for any purpose is hereby granted without fee,
32 * provided that the above copyright notice appear in all copies and
33 * that both that copyright notice and this permission notice appear
34 * in supporting documentation. Hewlett-Packard Company makes no
35 * representations about the suitability of this software for any
36 * purpose. It is provided "as is" without express or implied warranty.
39 * Copyright (c) 1996,1997
40 * Silicon Graphics Computer Systems, Inc.
42 * Permission to use, copy, modify, distribute and sell this software
43 * and its documentation for any purpose is hereby granted without fee,
44 * provided that the above copyright notice appear in all copies and
45 * that both that copyright notice and this permission notice appear
46 * in supporting documentation. Silicon Graphics makes no
47 * representations about the suitability of this software for any
48 * purpose. It is provided "as is" without express or implied warranty.
51 /** @file bits/stl_multimap.h
52 * This is an internal header file, included by other library headers.
53 * Do not attempt to use it directly. @headername{map}
56 #ifndef _STL_MULTIMAP_H
57 #define _STL_MULTIMAP_H 1
59 #include <bits/concept_check.h>
60 #if __cplusplus >= 201103L
61 #include <initializer_list>
64 namespace std
_GLIBCXX_VISIBILITY(default)
66 _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
69 * @brief A standard container made up of (key,value) pairs, which can be
70 * retrieved based on a key, in logarithmic time.
72 * @ingroup associative_containers
74 * @tparam _Key Type of key objects.
75 * @tparam _Tp Type of mapped objects.
76 * @tparam _Compare Comparison function object type, defaults to less<_Key>.
77 * @tparam _Alloc Allocator type, defaults to
78 * allocator<pair<const _Key, _Tp>.
80 * Meets the requirements of a <a href="tables.html#65">container</a>, a
81 * <a href="tables.html#66">reversible container</a>, and an
82 * <a href="tables.html#69">associative container</a> (using equivalent
83 * keys). For a @c multimap<Key,T> the key_type is Key, the mapped_type
84 * is T, and the value_type is std::pair<const Key,T>.
86 * Multimaps support bidirectional iterators.
88 * The private tree data is declared exactly the same way for map and
89 * multimap; the distinction is made entirely in how the tree functions are
90 * called (*_unique versus *_equal, same as the standard).
92 template <typename _Key
, typename _Tp
,
93 typename _Compare
= std::less
<_Key
>,
94 typename _Alloc
= std::allocator
<std::pair
<const _Key
, _Tp
> > >
98 typedef _Key key_type
;
99 typedef _Tp mapped_type
;
100 typedef std::pair
<const _Key
, _Tp
> value_type
;
101 typedef _Compare key_compare
;
102 typedef _Alloc allocator_type
;
105 // concept requirements
106 typedef typename
_Alloc::value_type _Alloc_value_type
;
107 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
108 __glibcxx_class_requires4(_Compare
, bool, _Key
, _Key
,
109 _BinaryFunctionConcept
)
110 __glibcxx_class_requires2(value_type
, _Alloc_value_type
, _SameTypeConcept
)
114 : public std::binary_function
<value_type
, value_type
, bool>
116 friend class multimap
<_Key
, _Tp
, _Compare
, _Alloc
>;
120 value_compare(_Compare __c
)
124 bool operator()(const value_type
& __x
, const value_type
& __y
) const
125 { return comp(__x
.first
, __y
.first
); }
129 /// This turns a red-black tree into a [multi]map.
130 typedef typename
__gnu_cxx::__alloc_traits
<_Alloc
>::template
131 rebind
<value_type
>::other _Pair_alloc_type
;
133 typedef _Rb_tree
<key_type
, value_type
, _Select1st
<value_type
>,
134 key_compare
, _Pair_alloc_type
> _Rep_type
;
135 /// The actual tree structure.
138 typedef __gnu_cxx::__alloc_traits
<_Pair_alloc_type
> _Alloc_traits
;
141 // many of these are specified differently in ISO, but the following are
142 // "functionally equivalent"
143 typedef typename
_Alloc_traits::pointer pointer
;
144 typedef typename
_Alloc_traits::const_pointer const_pointer
;
145 typedef typename
_Alloc_traits::reference reference
;
146 typedef typename
_Alloc_traits::const_reference const_reference
;
147 typedef typename
_Rep_type::iterator iterator
;
148 typedef typename
_Rep_type::const_iterator const_iterator
;
149 typedef typename
_Rep_type::size_type size_type
;
150 typedef typename
_Rep_type::difference_type difference_type
;
151 typedef typename
_Rep_type::reverse_iterator reverse_iterator
;
152 typedef typename
_Rep_type::const_reverse_iterator const_reverse_iterator
;
154 // [23.3.2] construct/copy/destroy
155 // (get_allocator() is also listed in this section)
158 * @brief Default constructor creates no elements.
161 #if __cplusplus >= 201103L
162 noexcept(is_nothrow_default_constructible
<allocator_type
>::value
)
167 * @brief Creates a %multimap with no elements.
168 * @param __comp A comparison object.
169 * @param __a An allocator object.
172 multimap(const _Compare
& __comp
,
173 const allocator_type
& __a
= allocator_type())
174 : _M_t(__comp
, _Pair_alloc_type(__a
)) { }
177 * @brief %Multimap copy constructor.
178 * @param __x A %multimap of identical element and allocator types.
180 * The newly-created %multimap uses a copy of the allocation object
183 multimap(const multimap
& __x
)
186 #if __cplusplus >= 201103L
188 * @brief %Multimap move constructor.
189 * @param __x A %multimap of identical element and allocator types.
191 * The newly-created %multimap contains the exact contents of @a __x.
192 * The contents of @a __x are a valid, but unspecified %multimap.
194 multimap(multimap
&& __x
)
195 noexcept(is_nothrow_copy_constructible
<_Compare
>::value
)
196 : _M_t(std::move(__x
._M_t
)) { }
199 * @brief Builds a %multimap from an initializer_list.
200 * @param __l An initializer_list.
201 * @param __comp A comparison functor.
202 * @param __a An allocator object.
204 * Create a %multimap consisting of copies of the elements from
205 * the initializer_list. This is linear in N if the list is already
206 * sorted, and NlogN otherwise (where N is @a __l.size()).
208 multimap(initializer_list
<value_type
> __l
,
209 const _Compare
& __comp
= _Compare(),
210 const allocator_type
& __a
= allocator_type())
211 : _M_t(__comp
, _Pair_alloc_type(__a
))
212 { _M_t
._M_insert_equal(__l
.begin(), __l
.end()); }
214 /// Allocator-extended default constructor.
216 multimap(const allocator_type
& __a
)
217 : _M_t(_Compare(), _Pair_alloc_type(__a
)) { }
219 /// Allocator-extended copy constructor.
220 multimap(const multimap
& __m
, const allocator_type
& __a
)
221 : _M_t(__m
._M_t
, _Pair_alloc_type(__a
)) { }
223 /// Allocator-extended move constructor.
224 multimap(multimap
&& __m
, const allocator_type
& __a
)
225 noexcept(is_nothrow_copy_constructible
<_Compare
>::value
226 && _Alloc_traits::_S_always_equal())
227 : _M_t(std::move(__m
._M_t
), _Pair_alloc_type(__a
)) { }
229 /// Allocator-extended initialier-list constructor.
230 multimap(initializer_list
<value_type
> __l
, const allocator_type
& __a
)
231 : _M_t(_Compare(), _Pair_alloc_type(__a
))
232 { _M_t
._M_insert_equal(__l
.begin(), __l
.end()); }
234 /// Allocator-extended range constructor.
235 template<typename _InputIterator
>
236 multimap(_InputIterator __first
, _InputIterator __last
,
237 const allocator_type
& __a
)
238 : _M_t(_Compare(), _Pair_alloc_type(__a
))
239 { _M_t
._M_insert_equal(__first
, __last
); }
243 * @brief Builds a %multimap from a range.
244 * @param __first An input iterator.
245 * @param __last An input iterator.
247 * Create a %multimap consisting of copies of the elements from
248 * [__first,__last). This is linear in N if the range is already sorted,
249 * and NlogN otherwise (where N is distance(__first,__last)).
251 template<typename _InputIterator
>
252 multimap(_InputIterator __first
, _InputIterator __last
)
254 { _M_t
._M_insert_equal(__first
, __last
); }
257 * @brief Builds a %multimap from a range.
258 * @param __first An input iterator.
259 * @param __last An input iterator.
260 * @param __comp A comparison functor.
261 * @param __a An allocator object.
263 * Create a %multimap consisting of copies of the elements from
264 * [__first,__last). This is linear in N if the range is already sorted,
265 * and NlogN otherwise (where N is distance(__first,__last)).
267 template<typename _InputIterator
>
268 multimap(_InputIterator __first
, _InputIterator __last
,
269 const _Compare
& __comp
,
270 const allocator_type
& __a
= allocator_type())
271 : _M_t(__comp
, _Pair_alloc_type(__a
))
272 { _M_t
._M_insert_equal(__first
, __last
); }
274 // FIXME There is no dtor declared, but we should have something generated
275 // by Doxygen. I don't know what tags to add to this paragraph to make
278 * The dtor only erases the elements, and note that if the elements
279 * themselves are pointers, the pointed-to memory is not touched in any
280 * way. Managing the pointer is the user's responsibility.
284 * @brief %Multimap assignment operator.
285 * @param __x A %multimap of identical element and allocator types.
287 * All the elements of @a __x are copied, but unlike the copy
288 * constructor, the allocator object is not copied.
291 operator=(const multimap
& __x
)
297 #if __cplusplus >= 201103L
298 /// Move assignment operator.
300 operator=(multimap
&&) = default;
303 * @brief %Multimap list assignment operator.
304 * @param __l An initializer_list.
306 * This function fills a %multimap with copies of the elements
307 * in the initializer list @a __l.
309 * Note that the assignment completely changes the %multimap and
310 * that the resulting %multimap's size is the same as the number
311 * of elements assigned. Old data may be lost.
314 operator=(initializer_list
<value_type
> __l
)
316 _M_t
._M_assign_equal(__l
.begin(), __l
.end());
321 /// Get a copy of the memory allocation object.
323 get_allocator() const _GLIBCXX_NOEXCEPT
324 { return allocator_type(_M_t
.get_allocator()); }
328 * Returns a read/write iterator that points to the first pair in the
329 * %multimap. Iteration is done in ascending order according to the
333 begin() _GLIBCXX_NOEXCEPT
334 { return _M_t
.begin(); }
337 * Returns a read-only (constant) iterator that points to the first pair
338 * in the %multimap. Iteration is done in ascending order according to
342 begin() const _GLIBCXX_NOEXCEPT
343 { return _M_t
.begin(); }
346 * Returns a read/write iterator that points one past the last pair in
347 * the %multimap. Iteration is done in ascending order according to the
351 end() _GLIBCXX_NOEXCEPT
352 { return _M_t
.end(); }
355 * Returns a read-only (constant) iterator that points one past the last
356 * pair in the %multimap. Iteration is done in ascending order according
360 end() const _GLIBCXX_NOEXCEPT
361 { return _M_t
.end(); }
364 * Returns a read/write reverse iterator that points to the last pair in
365 * the %multimap. Iteration is done in descending order according to the
369 rbegin() _GLIBCXX_NOEXCEPT
370 { return _M_t
.rbegin(); }
373 * Returns a read-only (constant) reverse iterator that points to the
374 * last pair in the %multimap. Iteration is done in descending order
375 * according to the keys.
377 const_reverse_iterator
378 rbegin() const _GLIBCXX_NOEXCEPT
379 { return _M_t
.rbegin(); }
382 * Returns a read/write reverse iterator that points to one before the
383 * first pair in the %multimap. Iteration is done in descending order
384 * according to the keys.
387 rend() _GLIBCXX_NOEXCEPT
388 { return _M_t
.rend(); }
391 * Returns a read-only (constant) reverse iterator that points to one
392 * before the first pair in the %multimap. Iteration is done in
393 * descending order according to the keys.
395 const_reverse_iterator
396 rend() const _GLIBCXX_NOEXCEPT
397 { return _M_t
.rend(); }
399 #if __cplusplus >= 201103L
401 * Returns a read-only (constant) iterator that points to the first pair
402 * in the %multimap. Iteration is done in ascending order according to
406 cbegin() const noexcept
407 { return _M_t
.begin(); }
410 * Returns a read-only (constant) iterator that points one past the last
411 * pair in the %multimap. Iteration is done in ascending order according
415 cend() const noexcept
416 { return _M_t
.end(); }
419 * Returns a read-only (constant) reverse iterator that points to the
420 * last pair in the %multimap. Iteration is done in descending order
421 * according to the keys.
423 const_reverse_iterator
424 crbegin() const noexcept
425 { return _M_t
.rbegin(); }
428 * Returns a read-only (constant) reverse iterator that points to one
429 * before the first pair in the %multimap. Iteration is done in
430 * descending order according to the keys.
432 const_reverse_iterator
433 crend() const noexcept
434 { return _M_t
.rend(); }
438 /** Returns true if the %multimap is empty. */
440 empty() const _GLIBCXX_NOEXCEPT
441 { return _M_t
.empty(); }
443 /** Returns the size of the %multimap. */
445 size() const _GLIBCXX_NOEXCEPT
446 { return _M_t
.size(); }
448 /** Returns the maximum size of the %multimap. */
450 max_size() const _GLIBCXX_NOEXCEPT
451 { return _M_t
.max_size(); }
454 #if __cplusplus >= 201103L
456 * @brief Build and insert a std::pair into the %multimap.
458 * @param __args Arguments used to generate a new pair instance (see
459 * std::piecewise_contruct for passing arguments to each
460 * part of the pair constructor).
462 * @return An iterator that points to the inserted (key,value) pair.
464 * This function builds and inserts a (key, value) %pair into the
466 * Contrary to a std::map the %multimap does not rely on unique keys and
467 * thus multiple pairs with the same key can be inserted.
469 * Insertion requires logarithmic time.
471 template<typename
... _Args
>
473 emplace(_Args
&&... __args
)
474 { return _M_t
._M_emplace_equal(std::forward
<_Args
>(__args
)...); }
477 * @brief Builds and inserts a std::pair into the %multimap.
479 * @param __pos An iterator that serves as a hint as to where the pair
480 * should be inserted.
481 * @param __args Arguments used to generate a new pair instance (see
482 * std::piecewise_contruct for passing arguments to each
483 * part of the pair constructor).
484 * @return An iterator that points to the inserted (key,value) pair.
486 * This function inserts a (key, value) pair into the %multimap.
487 * Contrary to a std::map the %multimap does not rely on unique keys and
488 * thus multiple pairs with the same key can be inserted.
489 * Note that the first parameter is only a hint and can potentially
490 * improve the performance of the insertion process. A bad hint would
491 * cause no gains in efficiency.
493 * For more on @a hinting, see:
494 * https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints
496 * Insertion requires logarithmic time (if the hint is not taken).
498 template<typename
... _Args
>
500 emplace_hint(const_iterator __pos
, _Args
&&... __args
)
502 return _M_t
._M_emplace_hint_equal(__pos
,
503 std::forward
<_Args
>(__args
)...);
508 * @brief Inserts a std::pair into the %multimap.
509 * @param __x Pair to be inserted (see std::make_pair for easy creation
511 * @return An iterator that points to the inserted (key,value) pair.
513 * This function inserts a (key, value) pair into the %multimap.
514 * Contrary to a std::map the %multimap does not rely on unique keys and
515 * thus multiple pairs with the same key can be inserted.
517 * Insertion requires logarithmic time.
520 insert(const value_type
& __x
)
521 { return _M_t
._M_insert_equal(__x
); }
523 #if __cplusplus >= 201103L
524 template<typename _Pair
, typename
= typename
525 std::enable_if
<std::is_constructible
<value_type
,
526 _Pair
&&>::value
>::type
>
529 { return _M_t
._M_insert_equal(std::forward
<_Pair
>(__x
)); }
533 * @brief Inserts a std::pair into the %multimap.
534 * @param __position An iterator that serves as a hint as to where the
535 * pair should be inserted.
536 * @param __x Pair to be inserted (see std::make_pair for easy creation
538 * @return An iterator that points to the inserted (key,value) pair.
540 * This function inserts a (key, value) pair into the %multimap.
541 * Contrary to a std::map the %multimap does not rely on unique keys and
542 * thus multiple pairs with the same key can be inserted.
543 * Note that the first parameter is only a hint and can potentially
544 * improve the performance of the insertion process. A bad hint would
545 * cause no gains in efficiency.
547 * For more on @a hinting, see:
548 * https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints
550 * Insertion requires logarithmic time (if the hint is not taken).
553 #if __cplusplus >= 201103L
554 insert(const_iterator __position
, const value_type
& __x
)
556 insert(iterator __position
, const value_type
& __x
)
558 { return _M_t
._M_insert_equal_(__position
, __x
); }
560 #if __cplusplus >= 201103L
561 template<typename _Pair
, typename
= typename
562 std::enable_if
<std::is_constructible
<value_type
,
563 _Pair
&&>::value
>::type
>
565 insert(const_iterator __position
, _Pair
&& __x
)
566 { return _M_t
._M_insert_equal_(__position
,
567 std::forward
<_Pair
>(__x
)); }
571 * @brief A template function that attempts to insert a range
573 * @param __first Iterator pointing to the start of the range to be
575 * @param __last Iterator pointing to the end of the range.
577 * Complexity similar to that of the range constructor.
579 template<typename _InputIterator
>
581 insert(_InputIterator __first
, _InputIterator __last
)
582 { _M_t
._M_insert_equal(__first
, __last
); }
584 #if __cplusplus >= 201103L
586 * @brief Attempts to insert a list of std::pairs into the %multimap.
587 * @param __l A std::initializer_list<value_type> of pairs to be
590 * Complexity similar to that of the range constructor.
593 insert(initializer_list
<value_type
> __l
)
594 { this->insert(__l
.begin(), __l
.end()); }
597 #if __cplusplus >= 201103L
598 // _GLIBCXX_RESOLVE_LIB_DEFECTS
599 // DR 130. Associative erase should return an iterator.
601 * @brief Erases an element from a %multimap.
602 * @param __position An iterator pointing to the element to be erased.
603 * @return An iterator pointing to the element immediately following
604 * @a position prior to the element being erased. If no such
605 * element exists, end() is returned.
607 * This function erases an element, pointed to by the given iterator,
608 * from a %multimap. Note that this function only erases the element,
609 * and that if the element is itself a pointer, the pointed-to memory is
610 * not touched in any way. Managing the pointer is the user's
614 erase(const_iterator __position
)
615 { return _M_t
.erase(__position
); }
618 _GLIBCXX_ABI_TAG_CXX11
620 erase(iterator __position
)
621 { return _M_t
.erase(__position
); }
624 * @brief Erases an element from a %multimap.
625 * @param __position An iterator pointing to the element to be erased.
627 * This function erases an element, pointed to by the given iterator,
628 * from a %multimap. Note that this function only erases the element,
629 * and that if the element is itself a pointer, the pointed-to memory is
630 * not touched in any way. Managing the pointer is the user's
634 erase(iterator __position
)
635 { _M_t
.erase(__position
); }
639 * @brief Erases elements according to the provided key.
640 * @param __x Key of element to be erased.
641 * @return The number of elements erased.
643 * This function erases all elements located by the given key from a
645 * Note that this function only erases the element, and that if
646 * the element is itself a pointer, the pointed-to memory is not touched
647 * in any way. Managing the pointer is the user's responsibility.
650 erase(const key_type
& __x
)
651 { return _M_t
.erase(__x
); }
653 #if __cplusplus >= 201103L
654 // _GLIBCXX_RESOLVE_LIB_DEFECTS
655 // DR 130. Associative erase should return an iterator.
657 * @brief Erases a [first,last) range of elements from a %multimap.
658 * @param __first Iterator pointing to the start of the range to be
660 * @param __last Iterator pointing to the end of the range to be
662 * @return The iterator @a __last.
664 * This function erases a sequence of elements from a %multimap.
665 * Note that this function only erases the elements, and that if
666 * the elements themselves are pointers, the pointed-to memory is not
667 * touched in any way. Managing the pointer is the user's
671 erase(const_iterator __first
, const_iterator __last
)
672 { return _M_t
.erase(__first
, __last
); }
674 // _GLIBCXX_RESOLVE_LIB_DEFECTS
675 // DR 130. Associative erase should return an iterator.
677 * @brief Erases a [first,last) range of elements from a %multimap.
678 * @param __first Iterator pointing to the start of the range to be
680 * @param __last Iterator pointing to the end of the range to
683 * This function erases a sequence of elements from a %multimap.
684 * Note that this function only erases the elements, and that if
685 * the elements themselves are pointers, the pointed-to memory is not
686 * touched in any way. Managing the pointer is the user's
690 erase(iterator __first
, iterator __last
)
691 { _M_t
.erase(__first
, __last
); }
695 * @brief Swaps data with another %multimap.
696 * @param __x A %multimap of the same element and allocator types.
698 * This exchanges the elements between two multimaps in constant time.
699 * (It is only swapping a pointer, an integer, and an instance of
700 * the @c Compare type (which itself is often stateless and empty), so it
701 * should be quite fast.)
702 * Note that the global std::swap() function is specialized such that
703 * std::swap(m1,m2) will feed to this function.
707 #if __cplusplus >= 201103L
708 noexcept(_Alloc_traits::_S_nothrow_swap()
709 && __is_nothrow_swappable
<_Compare
>::value
)
711 { _M_t
.swap(__x
._M_t
); }
714 * Erases all elements in a %multimap. Note that this function only
715 * erases the elements, and that if the elements themselves are pointers,
716 * the pointed-to memory is not touched in any way. Managing the pointer
717 * is the user's responsibility.
720 clear() _GLIBCXX_NOEXCEPT
725 * Returns the key comparison object out of which the %multimap
730 { return _M_t
.key_comp(); }
733 * Returns a value comparison object, built from the key comparison
734 * object out of which the %multimap was constructed.
738 { return value_compare(_M_t
.key_comp()); }
740 // multimap operations
744 * @brief Tries to locate an element in a %multimap.
745 * @param __x Key of (key, value) pair to be located.
746 * @return Iterator pointing to sought-after element,
747 * or end() if not found.
749 * This function takes a key and tries to locate the element with which
750 * the key matches. If successful the function returns an iterator
751 * pointing to the sought after %pair. If unsuccessful it returns the
752 * past-the-end ( @c end() ) iterator.
755 find(const key_type
& __x
)
756 { return _M_t
.find(__x
); }
758 #if __cplusplus > 201103L
759 template<typename _Kt
>
761 find(const _Kt
& __x
) -> decltype(_M_t
._M_find_tr(__x
))
762 { return _M_t
._M_find_tr(__x
); }
768 * @brief Tries to locate an element in a %multimap.
769 * @param __x Key of (key, value) pair to be located.
770 * @return Read-only (constant) iterator pointing to sought-after
771 * element, or end() if not found.
773 * This function takes a key and tries to locate the element with which
774 * the key matches. If successful the function returns a constant
775 * iterator pointing to the sought after %pair. If unsuccessful it
776 * returns the past-the-end ( @c end() ) iterator.
779 find(const key_type
& __x
) const
780 { return _M_t
.find(__x
); }
782 #if __cplusplus > 201103L
783 template<typename _Kt
>
785 find(const _Kt
& __x
) const -> decltype(_M_t
._M_find_tr(__x
))
786 { return _M_t
._M_find_tr(__x
); }
792 * @brief Finds the number of elements with given key.
793 * @param __x Key of (key, value) pairs to be located.
794 * @return Number of elements with specified key.
797 count(const key_type
& __x
) const
798 { return _M_t
.count(__x
); }
800 #if __cplusplus > 201103L
801 template<typename _Kt
>
803 count(const _Kt
& __x
) const -> decltype(_M_t
._M_count_tr(__x
))
804 { return _M_t
._M_count_tr(__x
); }
810 * @brief Finds the beginning of a subsequence matching given key.
811 * @param __x Key of (key, value) pair to be located.
812 * @return Iterator pointing to first element equal to or greater
813 * than key, or end().
815 * This function returns the first element of a subsequence of elements
816 * that matches the given key. If unsuccessful it returns an iterator
817 * pointing to the first element that has a greater value than given key
818 * or end() if no such element exists.
821 lower_bound(const key_type
& __x
)
822 { return _M_t
.lower_bound(__x
); }
824 #if __cplusplus > 201103L
825 template<typename _Kt
>
827 lower_bound(const _Kt
& __x
)
828 -> decltype(_M_t
._M_lower_bound_tr(__x
))
829 { return _M_t
._M_lower_bound_tr(__x
); }
835 * @brief Finds the beginning of a subsequence matching given key.
836 * @param __x Key of (key, value) pair to be located.
837 * @return Read-only (constant) iterator pointing to first element
838 * equal to or greater than key, or end().
840 * This function returns the first element of a subsequence of
841 * elements that matches the given key. If unsuccessful the
842 * iterator will point to the next greatest element or, if no
843 * such greater element exists, to end().
846 lower_bound(const key_type
& __x
) const
847 { return _M_t
.lower_bound(__x
); }
849 #if __cplusplus > 201103L
850 template<typename _Kt
>
852 lower_bound(const _Kt
& __x
) const
853 -> decltype(_M_t
._M_lower_bound_tr(__x
))
854 { return _M_t
._M_lower_bound_tr(__x
); }
860 * @brief Finds the end of a subsequence matching given key.
861 * @param __x Key of (key, value) pair to be located.
862 * @return Iterator pointing to the first element
863 * greater than key, or end().
866 upper_bound(const key_type
& __x
)
867 { return _M_t
.upper_bound(__x
); }
869 #if __cplusplus > 201103L
870 template<typename _Kt
>
872 upper_bound(const _Kt
& __x
)
873 -> decltype(_M_t
._M_upper_bound_tr(__x
))
874 { return _M_t
._M_upper_bound_tr(__x
); }
880 * @brief Finds the end of a subsequence matching given key.
881 * @param __x Key of (key, value) pair to be located.
882 * @return Read-only (constant) iterator pointing to first iterator
883 * greater than key, or end().
886 upper_bound(const key_type
& __x
) const
887 { return _M_t
.upper_bound(__x
); }
889 #if __cplusplus > 201103L
890 template<typename _Kt
>
892 upper_bound(const _Kt
& __x
) const
893 -> decltype(_M_t
._M_upper_bound_tr(__x
))
894 { return _M_t
._M_upper_bound_tr(__x
); }
900 * @brief Finds a subsequence matching given key.
901 * @param __x Key of (key, value) pairs to be located.
902 * @return Pair of iterators that possibly points to the subsequence
903 * matching given key.
905 * This function is equivalent to
907 * std::make_pair(c.lower_bound(val),
908 * c.upper_bound(val))
910 * (but is faster than making the calls separately).
912 std::pair
<iterator
, iterator
>
913 equal_range(const key_type
& __x
)
914 { return _M_t
.equal_range(__x
); }
916 #if __cplusplus > 201103L
917 template<typename _Kt
>
919 equal_range(const _Kt
& __x
)
920 -> decltype(_M_t
._M_equal_range_tr(__x
))
921 { return _M_t
._M_equal_range_tr(__x
); }
927 * @brief Finds a subsequence matching given key.
928 * @param __x Key of (key, value) pairs to be located.
929 * @return Pair of read-only (constant) iterators that possibly points
930 * to the subsequence matching given key.
932 * This function is equivalent to
934 * std::make_pair(c.lower_bound(val),
935 * c.upper_bound(val))
937 * (but is faster than making the calls separately).
939 std::pair
<const_iterator
, const_iterator
>
940 equal_range(const key_type
& __x
) const
941 { return _M_t
.equal_range(__x
); }
943 #if __cplusplus > 201103L
944 template<typename _Kt
>
946 equal_range(const _Kt
& __x
) const
947 -> decltype(_M_t
._M_equal_range_tr(__x
))
948 { return _M_t
._M_equal_range_tr(__x
); }
952 template<typename _K1
, typename _T1
, typename _C1
, typename _A1
>
954 operator==(const multimap
<_K1
, _T1
, _C1
, _A1
>&,
955 const multimap
<_K1
, _T1
, _C1
, _A1
>&);
957 template<typename _K1
, typename _T1
, typename _C1
, typename _A1
>
959 operator<(const multimap
<_K1
, _T1
, _C1
, _A1
>&,
960 const multimap
<_K1
, _T1
, _C1
, _A1
>&);
964 * @brief Multimap equality comparison.
965 * @param __x A %multimap.
966 * @param __y A %multimap of the same type as @a __x.
967 * @return True iff the size and elements of the maps are equal.
969 * This is an equivalence relation. It is linear in the size of the
970 * multimaps. Multimaps are considered equivalent if their sizes are equal,
971 * and if corresponding elements compare equal.
973 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
975 operator==(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
976 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
977 { return __x
._M_t
== __y
._M_t
; }
980 * @brief Multimap ordering relation.
981 * @param __x A %multimap.
982 * @param __y A %multimap of the same type as @a __x.
983 * @return True iff @a x is lexicographically less than @a y.
985 * This is a total ordering relation. It is linear in the size of the
986 * multimaps. The elements must be comparable with @c <.
988 * See std::lexicographical_compare() for how the determination is made.
990 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
992 operator<(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
993 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
994 { return __x
._M_t
< __y
._M_t
; }
996 /// Based on operator==
997 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
999 operator!=(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1000 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1001 { return !(__x
== __y
); }
1003 /// Based on operator<
1004 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1006 operator>(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1007 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1008 { return __y
< __x
; }
1010 /// Based on operator<
1011 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1013 operator<=(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1014 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1015 { return !(__y
< __x
); }
1017 /// Based on operator<
1018 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1020 operator>=(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1021 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1022 { return !(__x
< __y
); }
1024 /// See std::multimap::swap().
1025 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1027 swap(multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1028 multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1029 #if __cplusplus >= 201103L
1030 noexcept(noexcept(__x
.swap(__y
)))
1034 _GLIBCXX_END_NAMESPACE_CONTAINER
1037 #endif /* _STL_MULTIMAP_H */