1 // Multiset implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
29 * Hewlett-Packard Company
31 * Permission to use, copy, modify, distribute and sell this software
32 * and its documentation for any purpose is hereby granted without fee,
33 * provided that the above copyright notice appear in all copies and
34 * that both that copyright notice and this permission notice appear
35 * in supporting documentation. Hewlett-Packard Company makes no
36 * representations about the suitability of this software for any
37 * purpose. It is provided "as is" without express or implied warranty.
41 * Silicon Graphics Computer Systems, Inc.
43 * Permission to use, copy, modify, distribute and sell this software
44 * and its documentation for any purpose is hereby granted without fee,
45 * provided that the above copyright notice appear in all copies and
46 * that both that copyright notice and this permission notice appear
47 * in supporting documentation. Silicon Graphics makes no
48 * representations about the suitability of this software for any
49 * purpose. It is provided "as is" without express or implied warranty.
52 /** @file stl_multiset.h
53 * This is an internal header file, included by other library headers.
54 * You should not attempt to use it directly.
57 #ifndef _STL_MULTISET_H
58 #define _STL_MULTISET_H 1
60 #include <bits/concept_check.h>
61 #include <initializer_list>
63 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std
, _GLIBCXX_STD_D
)
66 * @brief A standard container made up of elements, which can be retrieved
67 * in logarithmic time.
69 * @ingroup associative_containers
71 * Meets the requirements of a <a href="tables.html#65">container</a>, a
72 * <a href="tables.html#66">reversible container</a>, and an
73 * <a href="tables.html#69">associative container</a> (using equivalent
74 * keys). For a @c multiset<Key> the key_type and value_type are Key.
76 * Multisets support bidirectional iterators.
78 * The private tree data is declared exactly the same way for set and
79 * multiset; the distinction is made entirely in how the tree functions are
80 * called (*_unique versus *_equal, same as the standard).
82 template <typename _Key
, typename _Compare
= std::less
<_Key
>,
83 typename _Alloc
= std::allocator
<_Key
> >
86 // concept requirements
87 typedef typename
_Alloc::value_type _Alloc_value_type
;
88 __glibcxx_class_requires(_Key
, _SGIAssignableConcept
)
89 __glibcxx_class_requires4(_Compare
, bool, _Key
, _Key
,
90 _BinaryFunctionConcept
)
91 __glibcxx_class_requires2(_Key
, _Alloc_value_type
, _SameTypeConcept
)
95 typedef _Key key_type
;
96 typedef _Key value_type
;
97 typedef _Compare key_compare
;
98 typedef _Compare value_compare
;
99 typedef _Alloc allocator_type
;
102 /// This turns a red-black tree into a [multi]set.
103 typedef typename
_Alloc::template rebind
<_Key
>::other _Key_alloc_type
;
105 typedef _Rb_tree
<key_type
, value_type
, _Identity
<value_type
>,
106 key_compare
, _Key_alloc_type
> _Rep_type
;
107 /// The actual tree structure.
111 typedef typename
_Key_alloc_type::pointer pointer
;
112 typedef typename
_Key_alloc_type::const_pointer const_pointer
;
113 typedef typename
_Key_alloc_type::reference reference
;
114 typedef typename
_Key_alloc_type::const_reference const_reference
;
115 // _GLIBCXX_RESOLVE_LIB_DEFECTS
116 // DR 103. set::iterator is required to be modifiable,
117 // but this allows modification of keys.
118 typedef typename
_Rep_type::const_iterator iterator
;
119 typedef typename
_Rep_type::const_iterator const_iterator
;
120 typedef typename
_Rep_type::const_reverse_iterator reverse_iterator
;
121 typedef typename
_Rep_type::const_reverse_iterator const_reverse_iterator
;
122 typedef typename
_Rep_type::size_type size_type
;
123 typedef typename
_Rep_type::difference_type difference_type
;
125 // allocation/deallocation
127 * @brief Default constructor creates no elements.
133 * @brief Creates a %multiset with no elements.
134 * @param comp Comparator to use.
135 * @param a An allocator object.
138 multiset(const _Compare
& __comp
,
139 const allocator_type
& __a
= allocator_type())
140 : _M_t(__comp
, __a
) { }
143 * @brief Builds a %multiset from a range.
144 * @param first An input iterator.
145 * @param last An input iterator.
147 * Create a %multiset consisting of copies of the elements from
148 * [first,last). This is linear in N if the range is already sorted,
149 * and NlogN otherwise (where N is distance(first,last)).
151 template<typename _InputIterator
>
152 multiset(_InputIterator __first
, _InputIterator __last
)
154 { _M_t
._M_insert_equal(__first
, __last
); }
157 * @brief Builds a %multiset from a range.
158 * @param first An input iterator.
159 * @param last An input iterator.
160 * @param comp A comparison functor.
161 * @param a An allocator object.
163 * Create a %multiset consisting of copies of the elements from
164 * [first,last). This is linear in N if the range is already sorted,
165 * and NlogN otherwise (where N is distance(first,last)).
167 template<typename _InputIterator
>
168 multiset(_InputIterator __first
, _InputIterator __last
,
169 const _Compare
& __comp
,
170 const allocator_type
& __a
= allocator_type())
172 { _M_t
._M_insert_equal(__first
, __last
); }
175 * @brief %Multiset copy constructor.
176 * @param x A %multiset of identical element and allocator types.
178 * The newly-created %multiset uses a copy of the allocation object used
181 multiset(const multiset
& __x
)
184 #ifdef __GXX_EXPERIMENTAL_CXX0X__
186 * @brief %Multiset move constructor.
187 * @param x A %multiset of identical element and allocator types.
189 * The newly-created %multiset contains the exact contents of @a x.
190 * The contents of @a x are a valid, but unspecified %multiset.
192 multiset(multiset
&& __x
)
193 : _M_t(std::forward
<_Rep_type
>(__x
._M_t
)) { }
196 * @brief Builds a %multiset from an initializer_list.
197 * @param l An initializer_list.
198 * @param comp A comparison functor.
199 * @param a An allocator object.
201 * Create a %multiset consisting of copies of the elements from
202 * the list. This is linear in N if the list is already sorted,
203 * and NlogN otherwise (where N is @a l.size()).
205 multiset(initializer_list
<value_type
> __l
,
206 const _Compare
& __comp
= _Compare(),
207 const allocator_type
& __a
= allocator_type())
209 { _M_t
._M_insert_equal(__l
.begin(), __l
.end()); }
213 * @brief %Multiset assignment operator.
214 * @param x A %multiset of identical element and allocator types.
216 * All the elements of @a x are copied, but unlike the copy constructor,
217 * the allocator object is not copied.
220 operator=(const multiset
& __x
)
226 #ifdef __GXX_EXPERIMENTAL_CXX0X__
228 * @brief %Multiset move assignment operator.
229 * @param x A %multiset of identical element and allocator types.
231 * The contents of @a x are moved into this %multiset (without copying).
232 * @a x is a valid, but unspecified %multiset.
235 operator=(multiset
&& __x
)
244 * @brief %Multiset list assignment operator.
245 * @param l An initializer_list.
247 * This function fills a %multiset with copies of the elements in the
248 * initializer list @a l.
250 * Note that the assignment completely changes the %multiset and
251 * that the resulting %multiset's size is the same as the number
252 * of elements assigned. Old data may be lost.
255 operator=(initializer_list
<value_type
> __l
)
258 this->insert(__l
.begin(), __l
.end());
265 /// Returns the comparison object.
268 { return _M_t
.key_comp(); }
269 /// Returns the comparison object.
272 { return _M_t
.key_comp(); }
273 /// Returns the memory allocation object.
275 get_allocator() const
276 { return _M_t
.get_allocator(); }
279 * Returns a read-only (constant) iterator that points to the first
280 * element in the %multiset. Iteration is done in ascending order
281 * according to the keys.
285 { return _M_t
.begin(); }
288 * Returns a read-only (constant) iterator that points one past the last
289 * element in the %multiset. Iteration is done in ascending order
290 * according to the keys.
294 { return _M_t
.end(); }
297 * Returns a read-only (constant) reverse iterator that points to the
298 * last element in the %multiset. Iteration is done in descending order
299 * according to the keys.
303 { return _M_t
.rbegin(); }
306 * Returns a read-only (constant) reverse iterator that points to the
307 * last element in the %multiset. Iteration is done in descending order
308 * according to the keys.
312 { return _M_t
.rend(); }
314 #ifdef __GXX_EXPERIMENTAL_CXX0X__
316 * Returns a read-only (constant) iterator that points to the first
317 * element in the %multiset. Iteration is done in ascending order
318 * according to the keys.
322 { return _M_t
.begin(); }
325 * Returns a read-only (constant) iterator that points one past the last
326 * element in the %multiset. Iteration is done in ascending order
327 * according to the keys.
331 { return _M_t
.end(); }
334 * Returns a read-only (constant) reverse iterator that points to the
335 * last element in the %multiset. Iteration is done in descending order
336 * according to the keys.
340 { return _M_t
.rbegin(); }
343 * Returns a read-only (constant) reverse iterator that points to the
344 * last element in the %multiset. Iteration is done in descending order
345 * according to the keys.
349 { return _M_t
.rend(); }
352 /// Returns true if the %set is empty.
355 { return _M_t
.empty(); }
357 /// Returns the size of the %set.
360 { return _M_t
.size(); }
362 /// Returns the maximum size of the %set.
365 { return _M_t
.max_size(); }
368 * @brief Swaps data with another %multiset.
369 * @param x A %multiset of the same element and allocator types.
371 * This exchanges the elements between two multisets in constant time.
372 * (It is only swapping a pointer, an integer, and an instance of the @c
373 * Compare type (which itself is often stateless and empty), so it should
375 * Note that the global std::swap() function is specialized such that
376 * std::swap(s1,s2) will feed to this function.
380 { _M_t
.swap(__x
._M_t
); }
384 * @brief Inserts an element into the %multiset.
385 * @param x Element to be inserted.
386 * @return An iterator that points to the inserted element.
388 * This function inserts an element into the %multiset. Contrary
389 * to a std::set the %multiset does not rely on unique keys and thus
390 * multiple copies of the same element can be inserted.
392 * Insertion requires logarithmic time.
395 insert(const value_type
& __x
)
396 { return _M_t
._M_insert_equal(__x
); }
399 * @brief Inserts an element into the %multiset.
400 * @param position An iterator that serves as a hint as to where the
401 * element should be inserted.
402 * @param x Element to be inserted.
403 * @return An iterator that points to the inserted element.
405 * This function inserts an element into the %multiset. Contrary
406 * to a std::set the %multiset does not rely on unique keys and thus
407 * multiple copies of the same element can be inserted.
409 * Note that the first parameter is only a hint and can potentially
410 * improve the performance of the insertion process. A bad hint would
411 * cause no gains in efficiency.
413 * See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
414 * for more on "hinting".
416 * Insertion requires logarithmic time (if the hint is not taken).
419 insert(iterator __position
, const value_type
& __x
)
420 { return _M_t
._M_insert_equal_(__position
, __x
); }
423 * @brief A template function that attempts to insert a range of elements.
424 * @param first Iterator pointing to the start of the range to be
426 * @param last Iterator pointing to the end of the range.
428 * Complexity similar to that of the range constructor.
430 template<typename _InputIterator
>
432 insert(_InputIterator __first
, _InputIterator __last
)
433 { _M_t
._M_insert_equal(__first
, __last
); }
435 #ifdef __GXX_EXPERIMENTAL_CXX0X__
437 * @brief Attempts to insert a list of elements into the %multiset.
438 * @param list A std::initializer_list<value_type> of elements
441 * Complexity similar to that of the range constructor.
444 insert(initializer_list
<value_type
> __l
)
445 { this->insert(__l
.begin(), __l
.end()); }
448 #ifdef __GXX_EXPERIMENTAL_CXX0X__
449 // _GLIBCXX_RESOLVE_LIB_DEFECTS
450 // DR 130. Associative erase should return an iterator.
452 * @brief Erases an element from a %multiset.
453 * @param position An iterator pointing to the element to be erased.
454 * @return An iterator pointing to the element immediately following
455 * @a position prior to the element being erased. If no such
456 * element exists, end() is returned.
458 * This function erases an element, pointed to by the given iterator,
459 * from a %multiset. Note that this function only erases the element,
460 * and that if the element is itself a pointer, the pointed-to memory is
461 * not touched in any way. Managing the pointer is the user's
465 erase(iterator __position
)
466 { return _M_t
.erase(__position
); }
469 * @brief Erases an element from a %multiset.
470 * @param position An iterator pointing to the element to be erased.
472 * This function erases an element, pointed to by the given iterator,
473 * from a %multiset. Note that this function only erases the element,
474 * and that if the element is itself a pointer, the pointed-to memory is
475 * not touched in any way. Managing the pointer is the user's
479 erase(iterator __position
)
480 { _M_t
.erase(__position
); }
484 * @brief Erases elements according to the provided key.
485 * @param x Key of element to be erased.
486 * @return The number of elements erased.
488 * This function erases all elements located by the given key from a
490 * Note that this function only erases the element, and that if
491 * the element is itself a pointer, the pointed-to memory is not touched
492 * in any way. Managing the pointer is the user's responsibility.
495 erase(const key_type
& __x
)
496 { return _M_t
.erase(__x
); }
498 #ifdef __GXX_EXPERIMENTAL_CXX0X__
499 // _GLIBCXX_RESOLVE_LIB_DEFECTS
500 // DR 130. Associative erase should return an iterator.
502 * @brief Erases a [first,last) range of elements from a %multiset.
503 * @param first Iterator pointing to the start of the range to be
505 * @param last Iterator pointing to the end of the range to be erased.
506 * @return The iterator @a last.
508 * This function erases a sequence of elements from a %multiset.
509 * Note that this function only erases the elements, and that if
510 * the elements themselves are pointers, the pointed-to memory is not
511 * touched in any way. Managing the pointer is the user's responsibility.
514 erase(iterator __first
, iterator __last
)
515 { return _M_t
.erase(__first
, __last
); }
518 * @brief Erases a [first,last) range of elements from a %multiset.
519 * @param first Iterator pointing to the start of the range to be
521 * @param last Iterator pointing to the end of the range to be erased.
523 * This function erases a sequence of elements from a %multiset.
524 * Note that this function only erases the elements, and that if
525 * the elements themselves are pointers, the pointed-to memory is not
526 * touched in any way. Managing the pointer is the user's responsibility.
529 erase(iterator __first
, iterator __last
)
530 { _M_t
.erase(__first
, __last
); }
534 * Erases all elements in a %multiset. Note that this function only
535 * erases the elements, and that if the elements themselves are pointers,
536 * the pointed-to memory is not touched in any way. Managing the pointer
537 * is the user's responsibility.
543 // multiset operations:
546 * @brief Finds the number of elements with given key.
547 * @param x Key of elements to be located.
548 * @return Number of elements with specified key.
551 count(const key_type
& __x
) const
552 { return _M_t
.count(__x
); }
554 // _GLIBCXX_RESOLVE_LIB_DEFECTS
555 // 214. set::find() missing const overload
558 * @brief Tries to locate an element in a %set.
559 * @param x Element to be located.
560 * @return Iterator pointing to sought-after element, or end() if not
563 * This function takes a key and tries to locate the element with which
564 * the key matches. If successful the function returns an iterator
565 * pointing to the sought after element. If unsuccessful it returns the
566 * past-the-end ( @c end() ) iterator.
569 find(const key_type
& __x
)
570 { return _M_t
.find(__x
); }
573 find(const key_type
& __x
) const
574 { return _M_t
.find(__x
); }
579 * @brief Finds the beginning of a subsequence matching given key.
580 * @param x Key to be located.
581 * @return Iterator pointing to first element equal to or greater
582 * than key, or end().
584 * This function returns the first element of a subsequence of elements
585 * that matches the given key. If unsuccessful it returns an iterator
586 * pointing to the first element that has a greater value than given key
587 * or end() if no such element exists.
590 lower_bound(const key_type
& __x
)
591 { return _M_t
.lower_bound(__x
); }
594 lower_bound(const key_type
& __x
) const
595 { return _M_t
.lower_bound(__x
); }
600 * @brief Finds the end of a subsequence matching given key.
601 * @param x Key to be located.
602 * @return Iterator pointing to the first element
603 * greater than key, or end().
606 upper_bound(const key_type
& __x
)
607 { return _M_t
.upper_bound(__x
); }
610 upper_bound(const key_type
& __x
) const
611 { return _M_t
.upper_bound(__x
); }
616 * @brief Finds a subsequence matching given key.
617 * @param x Key to be located.
618 * @return Pair of iterators that possibly points to the subsequence
619 * matching given key.
621 * This function is equivalent to
623 * std::make_pair(c.lower_bound(val),
624 * c.upper_bound(val))
626 * (but is faster than making the calls separately).
628 * This function probably only makes sense for multisets.
630 std::pair
<iterator
, iterator
>
631 equal_range(const key_type
& __x
)
632 { return _M_t
.equal_range(__x
); }
634 std::pair
<const_iterator
, const_iterator
>
635 equal_range(const key_type
& __x
) const
636 { return _M_t
.equal_range(__x
); }
638 template<typename _K1
, typename _C1
, typename _A1
>
640 operator==(const multiset
<_K1
, _C1
, _A1
>&,
641 const multiset
<_K1
, _C1
, _A1
>&);
643 template<typename _K1
, typename _C1
, typename _A1
>
645 operator< (const multiset
<_K1
, _C1
, _A1
>&,
646 const multiset
<_K1
, _C1
, _A1
>&);
650 * @brief Multiset equality comparison.
651 * @param x A %multiset.
652 * @param y A %multiset of the same type as @a x.
653 * @return True iff the size and elements of the multisets are equal.
655 * This is an equivalence relation. It is linear in the size of the
657 * Multisets are considered equivalent if their sizes are equal, and if
658 * corresponding elements compare equal.
660 template<typename _Key
, typename _Compare
, typename _Alloc
>
662 operator==(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
663 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
664 { return __x
._M_t
== __y
._M_t
; }
667 * @brief Multiset ordering relation.
668 * @param x A %multiset.
669 * @param y A %multiset of the same type as @a x.
670 * @return True iff @a x is lexicographically less than @a y.
672 * This is a total ordering relation. It is linear in the size of the
673 * maps. The elements must be comparable with @c <.
675 * See std::lexicographical_compare() for how the determination is made.
677 template<typename _Key
, typename _Compare
, typename _Alloc
>
679 operator<(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
680 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
681 { return __x
._M_t
< __y
._M_t
; }
683 /// Returns !(x == y).
684 template<typename _Key
, typename _Compare
, typename _Alloc
>
686 operator!=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
687 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
688 { return !(__x
== __y
); }
691 template<typename _Key
, typename _Compare
, typename _Alloc
>
693 operator>(const multiset
<_Key
,_Compare
,_Alloc
>& __x
,
694 const multiset
<_Key
,_Compare
,_Alloc
>& __y
)
695 { return __y
< __x
; }
698 template<typename _Key
, typename _Compare
, typename _Alloc
>
700 operator<=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
701 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
702 { return !(__y
< __x
); }
705 template<typename _Key
, typename _Compare
, typename _Alloc
>
707 operator>=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
708 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
709 { return !(__x
< __y
); }
711 /// See std::multiset::swap().
712 template<typename _Key
, typename _Compare
, typename _Alloc
>
714 swap(multiset
<_Key
, _Compare
, _Alloc
>& __x
,
715 multiset
<_Key
, _Compare
, _Alloc
>& __y
)
718 _GLIBCXX_END_NESTED_NAMESPACE
720 #endif /* _STL_MULTISET_H */