1 // Multimap implementation -*- C++ -*-
3 // Copyright (C) 2001-2018 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_VERSION
67 _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
69 template <typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
73 * @brief A standard container made up of (key,value) pairs, which can be
74 * retrieved based on a key, in logarithmic time.
76 * @ingroup associative_containers
78 * @tparam _Key Type of key objects.
79 * @tparam _Tp Type of mapped objects.
80 * @tparam _Compare Comparison function object type, defaults to less<_Key>.
81 * @tparam _Alloc Allocator type, defaults to
82 * allocator<pair<const _Key, _Tp>.
84 * Meets the requirements of a <a href="tables.html#65">container</a>, a
85 * <a href="tables.html#66">reversible container</a>, and an
86 * <a href="tables.html#69">associative container</a> (using equivalent
87 * keys). For a @c multimap<Key,T> the key_type is Key, the mapped_type
88 * is T, and the value_type is std::pair<const Key,T>.
90 * Multimaps support bidirectional iterators.
92 * The private tree data is declared exactly the same way for map and
93 * multimap; the distinction is made entirely in how the tree functions are
94 * called (*_unique versus *_equal, same as the standard).
96 template <typename _Key
, typename _Tp
,
97 typename _Compare
= std::less
<_Key
>,
98 typename _Alloc
= std::allocator
<std::pair
<const _Key
, _Tp
> > >
102 typedef _Key key_type
;
103 typedef _Tp mapped_type
;
104 typedef std::pair
<const _Key
, _Tp
> value_type
;
105 typedef _Compare key_compare
;
106 typedef _Alloc allocator_type
;
109 #ifdef _GLIBCXX_CONCEPT_CHECKS
110 // concept requirements
111 typedef typename
_Alloc::value_type _Alloc_value_type
;
112 # if __cplusplus < 201103L
113 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
115 __glibcxx_class_requires4(_Compare
, bool, _Key
, _Key
,
116 _BinaryFunctionConcept
)
117 __glibcxx_class_requires2(value_type
, _Alloc_value_type
, _SameTypeConcept
)
120 #if __cplusplus >= 201103L && defined(__STRICT_ANSI__)
121 static_assert(is_same
<typename
_Alloc::value_type
, value_type
>::value
,
122 "std::multimap must have the same value_type as its allocator");
127 : public std::binary_function
<value_type
, value_type
, bool>
129 friend class multimap
<_Key
, _Tp
, _Compare
, _Alloc
>;
133 value_compare(_Compare __c
)
137 bool operator()(const value_type
& __x
, const value_type
& __y
) const
138 { return comp(__x
.first
, __y
.first
); }
142 /// This turns a red-black tree into a [multi]map.
143 typedef typename
__gnu_cxx::__alloc_traits
<_Alloc
>::template
144 rebind
<value_type
>::other _Pair_alloc_type
;
146 typedef _Rb_tree
<key_type
, value_type
, _Select1st
<value_type
>,
147 key_compare
, _Pair_alloc_type
> _Rep_type
;
148 /// The actual tree structure.
151 typedef __gnu_cxx::__alloc_traits
<_Pair_alloc_type
> _Alloc_traits
;
154 // many of these are specified differently in ISO, but the following are
155 // "functionally equivalent"
156 typedef typename
_Alloc_traits::pointer pointer
;
157 typedef typename
_Alloc_traits::const_pointer const_pointer
;
158 typedef typename
_Alloc_traits::reference reference
;
159 typedef typename
_Alloc_traits::const_reference const_reference
;
160 typedef typename
_Rep_type::iterator iterator
;
161 typedef typename
_Rep_type::const_iterator const_iterator
;
162 typedef typename
_Rep_type::size_type size_type
;
163 typedef typename
_Rep_type::difference_type difference_type
;
164 typedef typename
_Rep_type::reverse_iterator reverse_iterator
;
165 typedef typename
_Rep_type::const_reverse_iterator const_reverse_iterator
;
167 #if __cplusplus > 201402L
168 using node_type
= typename
_Rep_type::node_type
;
171 // [23.3.2] construct/copy/destroy
172 // (get_allocator() is also listed in this section)
175 * @brief Default constructor creates no elements.
177 #if __cplusplus < 201103L
178 multimap() : _M_t() { }
180 multimap() = default;
184 * @brief Creates a %multimap with no elements.
185 * @param __comp A comparison object.
186 * @param __a An allocator object.
189 multimap(const _Compare
& __comp
,
190 const allocator_type
& __a
= allocator_type())
191 : _M_t(__comp
, _Pair_alloc_type(__a
)) { }
194 * @brief %Multimap copy constructor.
196 * Whether the allocator is copied depends on the allocator traits.
198 #if __cplusplus < 201103L
199 multimap(const multimap
& __x
)
202 multimap(const multimap
&) = default;
205 * @brief %Multimap move constructor.
207 * The newly-created %multimap contains the exact contents of the
208 * moved instance. The moved instance is a valid, but unspecified
211 multimap(multimap
&&) = default;
214 * @brief Builds a %multimap from an initializer_list.
215 * @param __l An initializer_list.
216 * @param __comp A comparison functor.
217 * @param __a An allocator object.
219 * Create a %multimap consisting of copies of the elements from
220 * the initializer_list. This is linear in N if the list is already
221 * sorted, and NlogN otherwise (where N is @a __l.size()).
223 multimap(initializer_list
<value_type
> __l
,
224 const _Compare
& __comp
= _Compare(),
225 const allocator_type
& __a
= allocator_type())
226 : _M_t(__comp
, _Pair_alloc_type(__a
))
227 { _M_t
._M_insert_equal(__l
.begin(), __l
.end()); }
229 /// Allocator-extended default constructor.
231 multimap(const allocator_type
& __a
)
232 : _M_t(_Pair_alloc_type(__a
)) { }
234 /// Allocator-extended copy constructor.
235 multimap(const multimap
& __m
, const allocator_type
& __a
)
236 : _M_t(__m
._M_t
, _Pair_alloc_type(__a
)) { }
238 /// Allocator-extended move constructor.
239 multimap(multimap
&& __m
, const allocator_type
& __a
)
240 noexcept(is_nothrow_copy_constructible
<_Compare
>::value
241 && _Alloc_traits::_S_always_equal())
242 : _M_t(std::move(__m
._M_t
), _Pair_alloc_type(__a
)) { }
244 /// Allocator-extended initialier-list constructor.
245 multimap(initializer_list
<value_type
> __l
, const allocator_type
& __a
)
246 : _M_t(_Pair_alloc_type(__a
))
247 { _M_t
._M_insert_equal(__l
.begin(), __l
.end()); }
249 /// Allocator-extended range constructor.
250 template<typename _InputIterator
>
251 multimap(_InputIterator __first
, _InputIterator __last
,
252 const allocator_type
& __a
)
253 : _M_t(_Pair_alloc_type(__a
))
254 { _M_t
._M_insert_equal(__first
, __last
); }
258 * @brief Builds a %multimap from a range.
259 * @param __first An input iterator.
260 * @param __last An input iterator.
262 * Create a %multimap consisting of copies of the elements from
263 * [__first,__last). This is linear in N if the range is already sorted,
264 * and NlogN otherwise (where N is distance(__first,__last)).
266 template<typename _InputIterator
>
267 multimap(_InputIterator __first
, _InputIterator __last
)
269 { _M_t
._M_insert_equal(__first
, __last
); }
272 * @brief Builds a %multimap from a range.
273 * @param __first An input iterator.
274 * @param __last An input iterator.
275 * @param __comp A comparison functor.
276 * @param __a An allocator object.
278 * Create a %multimap consisting of copies of the elements from
279 * [__first,__last). This is linear in N if the range is already sorted,
280 * and NlogN otherwise (where N is distance(__first,__last)).
282 template<typename _InputIterator
>
283 multimap(_InputIterator __first
, _InputIterator __last
,
284 const _Compare
& __comp
,
285 const allocator_type
& __a
= allocator_type())
286 : _M_t(__comp
, _Pair_alloc_type(__a
))
287 { _M_t
._M_insert_equal(__first
, __last
); }
289 #if __cplusplus >= 201103L
291 * The dtor only erases the elements, and note that if the elements
292 * themselves are pointers, the pointed-to memory is not touched in any
293 * way. Managing the pointer is the user's responsibility.
295 ~multimap() = default;
299 * @brief %Multimap assignment operator.
301 * Whether the allocator is copied depends on the allocator traits.
303 #if __cplusplus < 201103L
305 operator=(const multimap
& __x
)
312 operator=(const multimap
&) = default;
314 /// Move assignment operator.
316 operator=(multimap
&&) = default;
319 * @brief %Multimap list assignment operator.
320 * @param __l An initializer_list.
322 * This function fills a %multimap with copies of the elements
323 * in the initializer list @a __l.
325 * Note that the assignment completely changes the %multimap and
326 * that the resulting %multimap's size is the same as the number
327 * of elements assigned.
330 operator=(initializer_list
<value_type
> __l
)
332 _M_t
._M_assign_equal(__l
.begin(), __l
.end());
337 /// Get a copy of the memory allocation object.
339 get_allocator() const _GLIBCXX_NOEXCEPT
340 { return allocator_type(_M_t
.get_allocator()); }
344 * Returns a read/write iterator that points to the first pair in the
345 * %multimap. Iteration is done in ascending order according to the
349 begin() _GLIBCXX_NOEXCEPT
350 { return _M_t
.begin(); }
353 * Returns a read-only (constant) iterator that points to the first pair
354 * in the %multimap. Iteration is done in ascending order according to
358 begin() const _GLIBCXX_NOEXCEPT
359 { return _M_t
.begin(); }
362 * Returns a read/write iterator that points one past the last pair in
363 * the %multimap. Iteration is done in ascending order according to the
367 end() _GLIBCXX_NOEXCEPT
368 { return _M_t
.end(); }
371 * Returns a read-only (constant) iterator that points one past the last
372 * pair in the %multimap. Iteration is done in ascending order according
376 end() const _GLIBCXX_NOEXCEPT
377 { return _M_t
.end(); }
380 * Returns a read/write reverse iterator that points to the last pair in
381 * the %multimap. Iteration is done in descending order according to the
385 rbegin() _GLIBCXX_NOEXCEPT
386 { return _M_t
.rbegin(); }
389 * Returns a read-only (constant) reverse iterator that points to the
390 * last pair in the %multimap. Iteration is done in descending order
391 * according to the keys.
393 const_reverse_iterator
394 rbegin() const _GLIBCXX_NOEXCEPT
395 { return _M_t
.rbegin(); }
398 * Returns a read/write reverse iterator that points to one before the
399 * first pair in the %multimap. Iteration is done in descending order
400 * according to the keys.
403 rend() _GLIBCXX_NOEXCEPT
404 { return _M_t
.rend(); }
407 * Returns a read-only (constant) reverse iterator that points to one
408 * before the first pair in the %multimap. Iteration is done in
409 * descending order according to the keys.
411 const_reverse_iterator
412 rend() const _GLIBCXX_NOEXCEPT
413 { return _M_t
.rend(); }
415 #if __cplusplus >= 201103L
417 * Returns a read-only (constant) iterator that points to the first pair
418 * in the %multimap. Iteration is done in ascending order according to
422 cbegin() const noexcept
423 { return _M_t
.begin(); }
426 * Returns a read-only (constant) iterator that points one past the last
427 * pair in the %multimap. Iteration is done in ascending order according
431 cend() const noexcept
432 { return _M_t
.end(); }
435 * Returns a read-only (constant) reverse iterator that points to the
436 * last pair in the %multimap. Iteration is done in descending order
437 * according to the keys.
439 const_reverse_iterator
440 crbegin() const noexcept
441 { return _M_t
.rbegin(); }
444 * Returns a read-only (constant) reverse iterator that points to one
445 * before the first pair in the %multimap. Iteration is done in
446 * descending order according to the keys.
448 const_reverse_iterator
449 crend() const noexcept
450 { return _M_t
.rend(); }
454 /** Returns true if the %multimap is empty. */
456 empty() const _GLIBCXX_NOEXCEPT
457 { return _M_t
.empty(); }
459 /** Returns the size of the %multimap. */
461 size() const _GLIBCXX_NOEXCEPT
462 { return _M_t
.size(); }
464 /** Returns the maximum size of the %multimap. */
466 max_size() const _GLIBCXX_NOEXCEPT
467 { return _M_t
.max_size(); }
470 #if __cplusplus >= 201103L
472 * @brief Build and insert a std::pair into the %multimap.
474 * @param __args Arguments used to generate a new pair instance (see
475 * std::piecewise_contruct for passing arguments to each
476 * part of the pair constructor).
478 * @return An iterator that points to the inserted (key,value) pair.
480 * This function builds and inserts a (key, value) %pair into the
482 * Contrary to a std::map the %multimap does not rely on unique keys and
483 * thus multiple pairs with the same key can be inserted.
485 * Insertion requires logarithmic time.
487 template<typename
... _Args
>
489 emplace(_Args
&&... __args
)
490 { return _M_t
._M_emplace_equal(std::forward
<_Args
>(__args
)...); }
493 * @brief Builds and inserts a std::pair into the %multimap.
495 * @param __pos An iterator that serves as a hint as to where the pair
496 * should be inserted.
497 * @param __args Arguments used to generate a new pair instance (see
498 * std::piecewise_contruct for passing arguments to each
499 * part of the pair constructor).
500 * @return An iterator that points to the inserted (key,value) pair.
502 * This function inserts a (key, value) pair into the %multimap.
503 * Contrary to a std::map the %multimap does not rely on unique keys and
504 * thus multiple pairs with the same key can be inserted.
505 * Note that the first parameter is only a hint and can potentially
506 * improve the performance of the insertion process. A bad hint would
507 * cause no gains in efficiency.
509 * For more on @a hinting, see:
510 * https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints
512 * Insertion requires logarithmic time (if the hint is not taken).
514 template<typename
... _Args
>
516 emplace_hint(const_iterator __pos
, _Args
&&... __args
)
518 return _M_t
._M_emplace_hint_equal(__pos
,
519 std::forward
<_Args
>(__args
)...);
524 * @brief Inserts a std::pair into the %multimap.
525 * @param __x Pair to be inserted (see std::make_pair for easy creation
527 * @return An iterator that points to the inserted (key,value) pair.
529 * This function inserts a (key, value) pair into the %multimap.
530 * Contrary to a std::map the %multimap does not rely on unique keys and
531 * thus multiple pairs with the same key can be inserted.
533 * Insertion requires logarithmic time.
537 insert(const value_type
& __x
)
538 { return _M_t
._M_insert_equal(__x
); }
540 #if __cplusplus >= 201103L
541 // _GLIBCXX_RESOLVE_LIB_DEFECTS
542 // 2354. Unnecessary copying when inserting into maps with braced-init
544 insert(value_type
&& __x
)
545 { return _M_t
._M_insert_equal(std::move(__x
)); }
547 template<typename _Pair
, typename
= typename
548 std::enable_if
<std::is_constructible
<value_type
,
549 _Pair
&&>::value
>::type
>
552 { return _M_t
._M_insert_equal(std::forward
<_Pair
>(__x
)); }
557 * @brief Inserts a std::pair into the %multimap.
558 * @param __position An iterator that serves as a hint as to where the
559 * pair should be inserted.
560 * @param __x Pair to be inserted (see std::make_pair for easy creation
562 * @return An iterator that points to the inserted (key,value) pair.
564 * This function inserts a (key, value) pair into the %multimap.
565 * Contrary to a std::map the %multimap does not rely on unique keys and
566 * thus multiple pairs with the same key can be inserted.
567 * Note that the first parameter is only a hint and can potentially
568 * improve the performance of the insertion process. A bad hint would
569 * cause no gains in efficiency.
571 * For more on @a hinting, see:
572 * https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints
574 * Insertion requires logarithmic time (if the hint is not taken).
578 #if __cplusplus >= 201103L
579 insert(const_iterator __position
, const value_type
& __x
)
581 insert(iterator __position
, const value_type
& __x
)
583 { return _M_t
._M_insert_equal_(__position
, __x
); }
585 #if __cplusplus >= 201103L
586 // _GLIBCXX_RESOLVE_LIB_DEFECTS
587 // 2354. Unnecessary copying when inserting into maps with braced-init
589 insert(const_iterator __position
, value_type
&& __x
)
590 { return _M_t
._M_insert_equal_(__position
, std::move(__x
)); }
592 template<typename _Pair
, typename
= typename
593 std::enable_if
<std::is_constructible
<value_type
,
594 _Pair
&&>::value
>::type
>
596 insert(const_iterator __position
, _Pair
&& __x
)
597 { return _M_t
._M_insert_equal_(__position
,
598 std::forward
<_Pair
>(__x
)); }
603 * @brief A template function that attempts to insert a range
605 * @param __first Iterator pointing to the start of the range to be
607 * @param __last Iterator pointing to the end of the range.
609 * Complexity similar to that of the range constructor.
611 template<typename _InputIterator
>
613 insert(_InputIterator __first
, _InputIterator __last
)
614 { _M_t
._M_insert_equal(__first
, __last
); }
616 #if __cplusplus >= 201103L
618 * @brief Attempts to insert a list of std::pairs into the %multimap.
619 * @param __l A std::initializer_list<value_type> of pairs to be
622 * Complexity similar to that of the range constructor.
625 insert(initializer_list
<value_type
> __l
)
626 { this->insert(__l
.begin(), __l
.end()); }
629 #if __cplusplus > 201402L
632 extract(const_iterator __pos
)
634 __glibcxx_assert(__pos
!= end());
635 return _M_t
.extract(__pos
);
640 extract(const key_type
& __x
)
641 { return _M_t
.extract(__x
); }
643 /// Re-insert an extracted node.
645 insert(node_type
&& __nh
)
646 { return _M_t
._M_reinsert_node_equal(std::move(__nh
)); }
648 /// Re-insert an extracted node.
650 insert(const_iterator __hint
, node_type
&& __nh
)
651 { return _M_t
._M_reinsert_node_hint_equal(__hint
, std::move(__nh
)); }
653 template<typename
, typename
>
654 friend class std::_Rb_tree_merge_helper
;
656 template<typename _C2
>
658 merge(multimap
<_Key
, _Tp
, _C2
, _Alloc
>& __source
)
660 using _Merge_helper
= _Rb_tree_merge_helper
<multimap
, _C2
>;
661 _M_t
._M_merge_equal(_Merge_helper::_S_get_tree(__source
));
664 template<typename _C2
>
666 merge(multimap
<_Key
, _Tp
, _C2
, _Alloc
>&& __source
)
669 template<typename _C2
>
671 merge(map
<_Key
, _Tp
, _C2
, _Alloc
>& __source
)
673 using _Merge_helper
= _Rb_tree_merge_helper
<multimap
, _C2
>;
674 _M_t
._M_merge_equal(_Merge_helper::_S_get_tree(__source
));
677 template<typename _C2
>
679 merge(map
<_Key
, _Tp
, _C2
, _Alloc
>&& __source
)
683 #if __cplusplus >= 201103L
684 // _GLIBCXX_RESOLVE_LIB_DEFECTS
685 // DR 130. Associative erase should return an iterator.
687 * @brief Erases an element from a %multimap.
688 * @param __position An iterator pointing to the element to be erased.
689 * @return An iterator pointing to the element immediately following
690 * @a position prior to the element being erased. If no such
691 * element exists, end() is returned.
693 * This function erases an element, pointed to by the given iterator,
694 * from a %multimap. Note that this function only erases the element,
695 * and that if the element is itself a pointer, the pointed-to memory is
696 * not touched in any way. Managing the pointer is the user's
702 erase(const_iterator __position
)
703 { return _M_t
.erase(__position
); }
706 _GLIBCXX_ABI_TAG_CXX11
708 erase(iterator __position
)
709 { return _M_t
.erase(__position
); }
713 * @brief Erases an element from a %multimap.
714 * @param __position An iterator pointing to the element to be erased.
716 * This function erases an element, pointed to by the given iterator,
717 * from a %multimap. Note that this function only erases the element,
718 * and that if the element is itself a pointer, the pointed-to memory is
719 * not touched in any way. Managing the pointer is the user's
723 erase(iterator __position
)
724 { _M_t
.erase(__position
); }
728 * @brief Erases elements according to the provided key.
729 * @param __x Key of element to be erased.
730 * @return The number of elements erased.
732 * This function erases all elements located by the given key from a
734 * Note that this function only erases the element, and that if
735 * the element is itself a pointer, the pointed-to memory is not touched
736 * in any way. Managing the pointer is the user's responsibility.
739 erase(const key_type
& __x
)
740 { return _M_t
.erase(__x
); }
742 #if __cplusplus >= 201103L
743 // _GLIBCXX_RESOLVE_LIB_DEFECTS
744 // DR 130. Associative erase should return an iterator.
746 * @brief Erases a [first,last) range of elements from a %multimap.
747 * @param __first Iterator pointing to the start of the range to be
749 * @param __last Iterator pointing to the end of the range to be
751 * @return The iterator @a __last.
753 * This function erases a sequence of elements from a %multimap.
754 * Note that this function only erases the elements, and that if
755 * the elements themselves are pointers, the pointed-to memory is not
756 * touched in any way. Managing the pointer is the user's
760 erase(const_iterator __first
, const_iterator __last
)
761 { return _M_t
.erase(__first
, __last
); }
763 // _GLIBCXX_RESOLVE_LIB_DEFECTS
764 // DR 130. Associative erase should return an iterator.
766 * @brief Erases a [first,last) range of elements from a %multimap.
767 * @param __first Iterator pointing to the start of the range to be
769 * @param __last Iterator pointing to the end of the range to
772 * This function erases a sequence of elements from a %multimap.
773 * Note that this function only erases the elements, and that if
774 * the elements themselves are pointers, the pointed-to memory is not
775 * touched in any way. Managing the pointer is the user's
779 erase(iterator __first
, iterator __last
)
780 { _M_t
.erase(__first
, __last
); }
784 * @brief Swaps data with another %multimap.
785 * @param __x A %multimap of the same element and allocator types.
787 * This exchanges the elements between two multimaps in constant time.
788 * (It is only swapping a pointer, an integer, and an instance of
789 * the @c Compare type (which itself is often stateless and empty), so it
790 * should be quite fast.)
791 * Note that the global std::swap() function is specialized such that
792 * std::swap(m1,m2) will feed to this function.
794 * Whether the allocators are swapped depends on the allocator traits.
798 _GLIBCXX_NOEXCEPT_IF(__is_nothrow_swappable
<_Compare
>::value
)
799 { _M_t
.swap(__x
._M_t
); }
802 * Erases all elements in a %multimap. Note that this function only
803 * erases the elements, and that if the elements themselves are pointers,
804 * the pointed-to memory is not touched in any way. Managing the pointer
805 * is the user's responsibility.
808 clear() _GLIBCXX_NOEXCEPT
813 * Returns the key comparison object out of which the %multimap
818 { return _M_t
.key_comp(); }
821 * Returns a value comparison object, built from the key comparison
822 * object out of which the %multimap was constructed.
826 { return value_compare(_M_t
.key_comp()); }
828 // multimap operations
832 * @brief Tries to locate an element in a %multimap.
833 * @param __x Key of (key, value) pair to be located.
834 * @return Iterator pointing to sought-after element,
835 * or end() if not found.
837 * This function takes a key and tries to locate the element with which
838 * the key matches. If successful the function returns an iterator
839 * pointing to the sought after %pair. If unsuccessful it returns the
840 * past-the-end ( @c end() ) iterator.
843 find(const key_type
& __x
)
844 { return _M_t
.find(__x
); }
846 #if __cplusplus > 201103L
847 template<typename _Kt
>
849 find(const _Kt
& __x
) -> decltype(_M_t
._M_find_tr(__x
))
850 { return _M_t
._M_find_tr(__x
); }
856 * @brief Tries to locate an element in a %multimap.
857 * @param __x Key of (key, value) pair to be located.
858 * @return Read-only (constant) iterator pointing to sought-after
859 * element, or end() if not found.
861 * This function takes a key and tries to locate the element with which
862 * the key matches. If successful the function returns a constant
863 * iterator pointing to the sought after %pair. If unsuccessful it
864 * returns the past-the-end ( @c end() ) iterator.
867 find(const key_type
& __x
) const
868 { return _M_t
.find(__x
); }
870 #if __cplusplus > 201103L
871 template<typename _Kt
>
873 find(const _Kt
& __x
) const -> decltype(_M_t
._M_find_tr(__x
))
874 { return _M_t
._M_find_tr(__x
); }
880 * @brief Finds the number of elements with given key.
881 * @param __x Key of (key, value) pairs to be located.
882 * @return Number of elements with specified key.
885 count(const key_type
& __x
) const
886 { return _M_t
.count(__x
); }
888 #if __cplusplus > 201103L
889 template<typename _Kt
>
891 count(const _Kt
& __x
) const -> decltype(_M_t
._M_count_tr(__x
))
892 { return _M_t
._M_count_tr(__x
); }
896 #if __cplusplus > 201703L
899 * @brief Finds whether an element with the given key exists.
900 * @param __x Key of (key, value) pairs to be located.
901 * @return True if there is any element with the specified key.
904 contains(const key_type
& __x
) const
905 { return _M_t
.find(__x
) != _M_t
.end(); }
907 template<typename _Kt
>
909 contains(const _Kt
& __x
) const
910 -> decltype(_M_t
._M_find_tr(__x
), void(), true)
911 { return _M_t
._M_find_tr(__x
) != _M_t
.end(); }
917 * @brief Finds the beginning of a subsequence matching given key.
918 * @param __x Key of (key, value) pair to be located.
919 * @return Iterator pointing to first element equal to or greater
920 * than key, or end().
922 * This function returns the first element of a subsequence of elements
923 * that matches the given key. If unsuccessful it returns an iterator
924 * pointing to the first element that has a greater value than given key
925 * or end() if no such element exists.
928 lower_bound(const key_type
& __x
)
929 { return _M_t
.lower_bound(__x
); }
931 #if __cplusplus > 201103L
932 template<typename _Kt
>
934 lower_bound(const _Kt
& __x
)
935 -> decltype(iterator(_M_t
._M_lower_bound_tr(__x
)))
936 { return iterator(_M_t
._M_lower_bound_tr(__x
)); }
942 * @brief Finds the beginning of a subsequence matching given key.
943 * @param __x Key of (key, value) pair to be located.
944 * @return Read-only (constant) iterator pointing to first element
945 * equal to or greater than key, or end().
947 * This function returns the first element of a subsequence of
948 * elements that matches the given key. If unsuccessful the
949 * iterator will point to the next greatest element or, if no
950 * such greater element exists, to end().
953 lower_bound(const key_type
& __x
) const
954 { return _M_t
.lower_bound(__x
); }
956 #if __cplusplus > 201103L
957 template<typename _Kt
>
959 lower_bound(const _Kt
& __x
) const
960 -> decltype(const_iterator(_M_t
._M_lower_bound_tr(__x
)))
961 { return const_iterator(_M_t
._M_lower_bound_tr(__x
)); }
967 * @brief Finds the end of a subsequence matching given key.
968 * @param __x Key of (key, value) pair to be located.
969 * @return Iterator pointing to the first element
970 * greater than key, or end().
973 upper_bound(const key_type
& __x
)
974 { return _M_t
.upper_bound(__x
); }
976 #if __cplusplus > 201103L
977 template<typename _Kt
>
979 upper_bound(const _Kt
& __x
)
980 -> decltype(iterator(_M_t
._M_upper_bound_tr(__x
)))
981 { return iterator(_M_t
._M_upper_bound_tr(__x
)); }
987 * @brief Finds the end of a subsequence matching given key.
988 * @param __x Key of (key, value) pair to be located.
989 * @return Read-only (constant) iterator pointing to first iterator
990 * greater than key, or end().
993 upper_bound(const key_type
& __x
) const
994 { return _M_t
.upper_bound(__x
); }
996 #if __cplusplus > 201103L
997 template<typename _Kt
>
999 upper_bound(const _Kt
& __x
) const
1000 -> decltype(const_iterator(_M_t
._M_upper_bound_tr(__x
)))
1001 { return const_iterator(_M_t
._M_upper_bound_tr(__x
)); }
1007 * @brief Finds a subsequence matching given key.
1008 * @param __x Key of (key, value) pairs to be located.
1009 * @return Pair of iterators that possibly points to the subsequence
1010 * matching given key.
1012 * This function is equivalent to
1014 * std::make_pair(c.lower_bound(val),
1015 * c.upper_bound(val))
1017 * (but is faster than making the calls separately).
1019 std::pair
<iterator
, iterator
>
1020 equal_range(const key_type
& __x
)
1021 { return _M_t
.equal_range(__x
); }
1023 #if __cplusplus > 201103L
1024 template<typename _Kt
>
1026 equal_range(const _Kt
& __x
)
1027 -> decltype(pair
<iterator
, iterator
>(_M_t
._M_equal_range_tr(__x
)))
1028 { return pair
<iterator
, iterator
>(_M_t
._M_equal_range_tr(__x
)); }
1034 * @brief Finds a subsequence matching given key.
1035 * @param __x Key of (key, value) pairs to be located.
1036 * @return Pair of read-only (constant) iterators that possibly points
1037 * to the subsequence matching given key.
1039 * This function is equivalent to
1041 * std::make_pair(c.lower_bound(val),
1042 * c.upper_bound(val))
1044 * (but is faster than making the calls separately).
1046 std::pair
<const_iterator
, const_iterator
>
1047 equal_range(const key_type
& __x
) const
1048 { return _M_t
.equal_range(__x
); }
1050 #if __cplusplus > 201103L
1051 template<typename _Kt
>
1053 equal_range(const _Kt
& __x
) const
1054 -> decltype(pair
<const_iterator
, const_iterator
>(
1055 _M_t
._M_equal_range_tr(__x
)))
1057 return pair
<const_iterator
, const_iterator
>(
1058 _M_t
._M_equal_range_tr(__x
));
1063 template<typename _K1
, typename _T1
, typename _C1
, typename _A1
>
1065 operator==(const multimap
<_K1
, _T1
, _C1
, _A1
>&,
1066 const multimap
<_K1
, _T1
, _C1
, _A1
>&);
1068 template<typename _K1
, typename _T1
, typename _C1
, typename _A1
>
1070 operator<(const multimap
<_K1
, _T1
, _C1
, _A1
>&,
1071 const multimap
<_K1
, _T1
, _C1
, _A1
>&);
1074 #if __cpp_deduction_guides >= 201606
1076 template<typename _InputIterator
,
1077 typename _Compare
= less
<__iter_key_t
<_InputIterator
>>,
1078 typename _Allocator
= allocator
<__iter_to_alloc_t
<_InputIterator
>>,
1079 typename
= _RequireInputIter
<_InputIterator
>,
1080 typename
= _RequireAllocator
<_Allocator
>>
1081 multimap(_InputIterator
, _InputIterator
,
1082 _Compare
= _Compare(), _Allocator
= _Allocator())
1083 -> multimap
<__iter_key_t
<_InputIterator
>, __iter_val_t
<_InputIterator
>,
1084 _Compare
, _Allocator
>;
1086 template<typename _Key
, typename _Tp
, typename _Compare
= less
<_Key
>,
1087 typename _Allocator
= allocator
<pair
<const _Key
, _Tp
>>,
1088 typename
= _RequireAllocator
<_Allocator
>>
1089 multimap(initializer_list
<pair
<_Key
, _Tp
>>,
1090 _Compare
= _Compare(), _Allocator
= _Allocator())
1091 -> multimap
<_Key
, _Tp
, _Compare
, _Allocator
>;
1093 template<typename _InputIterator
, typename _Allocator
,
1094 typename
= _RequireInputIter
<_InputIterator
>,
1095 typename
= _RequireAllocator
<_Allocator
>>
1096 multimap(_InputIterator
, _InputIterator
, _Allocator
)
1097 -> multimap
<__iter_key_t
<_InputIterator
>, __iter_val_t
<_InputIterator
>,
1098 less
<__iter_key_t
<_InputIterator
>>, _Allocator
>;
1100 template<typename _Key
, typename _Tp
, typename _Allocator
,
1101 typename
= _RequireAllocator
<_Allocator
>>
1102 multimap(initializer_list
<pair
<_Key
, _Tp
>>, _Allocator
)
1103 -> multimap
<_Key
, _Tp
, less
<_Key
>, _Allocator
>;
1108 * @brief Multimap equality comparison.
1109 * @param __x A %multimap.
1110 * @param __y A %multimap of the same type as @a __x.
1111 * @return True iff the size and elements of the maps are equal.
1113 * This is an equivalence relation. It is linear in the size of the
1114 * multimaps. Multimaps are considered equivalent if their sizes are equal,
1115 * and if corresponding elements compare equal.
1117 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1119 operator==(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1120 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1121 { return __x
._M_t
== __y
._M_t
; }
1124 * @brief Multimap ordering relation.
1125 * @param __x A %multimap.
1126 * @param __y A %multimap of the same type as @a __x.
1127 * @return True iff @a x is lexicographically less than @a y.
1129 * This is a total ordering relation. It is linear in the size of the
1130 * multimaps. The elements must be comparable with @c <.
1132 * See std::lexicographical_compare() for how the determination is made.
1134 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1136 operator<(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1137 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1138 { return __x
._M_t
< __y
._M_t
; }
1140 /// Based on operator==
1141 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1143 operator!=(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1144 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1145 { return !(__x
== __y
); }
1147 /// Based on operator<
1148 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1150 operator>(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1151 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1152 { return __y
< __x
; }
1154 /// Based on operator<
1155 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1157 operator<=(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1158 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1159 { return !(__y
< __x
); }
1161 /// Based on operator<
1162 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1164 operator>=(const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1165 const multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1166 { return !(__x
< __y
); }
1168 /// See std::multimap::swap().
1169 template<typename _Key
, typename _Tp
, typename _Compare
, typename _Alloc
>
1171 swap(multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __x
,
1172 multimap
<_Key
, _Tp
, _Compare
, _Alloc
>& __y
)
1173 _GLIBCXX_NOEXCEPT_IF(noexcept(__x
.swap(__y
)))
1176 _GLIBCXX_END_NAMESPACE_CONTAINER
1178 #if __cplusplus > 201402L
1179 // Allow std::multimap access to internals of compatible maps.
1180 template<typename _Key
, typename _Val
, typename _Cmp1
, typename _Alloc
,
1183 _Rb_tree_merge_helper
<_GLIBCXX_STD_C::multimap
<_Key
, _Val
, _Cmp1
, _Alloc
>,
1187 friend class _GLIBCXX_STD_C::multimap
<_Key
, _Val
, _Cmp1
, _Alloc
>;
1190 _S_get_tree(_GLIBCXX_STD_C::map
<_Key
, _Val
, _Cmp2
, _Alloc
>& __map
)
1191 { return __map
._M_t
; }
1194 _S_get_tree(_GLIBCXX_STD_C::multimap
<_Key
, _Val
, _Cmp2
, _Alloc
>& __map
)
1195 { return __map
._M_t
; }
1199 _GLIBCXX_END_NAMESPACE_VERSION
1202 #endif /* _STL_MULTIMAP_H */