1 // Multiset implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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 2, 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 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
34 * Hewlett-Packard Company
36 * Permission to use, copy, modify, distribute and sell this software
37 * and its documentation for any purpose is hereby granted without fee,
38 * provided that the above copyright notice appear in all copies and
39 * that both that copyright notice and this permission notice appear
40 * in supporting documentation. Hewlett-Packard Company makes no
41 * representations about the suitability of this software for any
42 * purpose. It is provided "as is" without express or implied warranty.
46 * Silicon Graphics Computer Systems, Inc.
48 * Permission to use, copy, modify, distribute and sell this software
49 * and its documentation for any purpose is hereby granted without fee,
50 * provided that the above copyright notice appear in all copies and
51 * that both that copyright notice and this permission notice appear
52 * in supporting documentation. Silicon Graphics makes no
53 * representations about the suitability of this software for any
54 * purpose. It is provided "as is" without express or implied warranty.
57 /** @file stl_multiset.h
58 * This is an internal header file, included by other library headers.
59 * You should not attempt to use it directly.
62 #ifndef _STL_MULTISET_H
63 #define _STL_MULTISET_H 1
65 #include <bits/concept_check.h>
67 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std
, _GLIBCXX_STD_D
)
70 * @brief A standard container made up of elements, which can be retrieved
71 * in logarithmic time.
74 * @ingroup Assoc_containers
76 * Meets the requirements of a <a href="tables.html#65">container</a>, a
77 * <a href="tables.html#66">reversible container</a>, and an
78 * <a href="tables.html#69">associative container</a> (using equivalent
79 * keys). For a @c multiset<Key> the key_type and value_type are Key.
81 * Multisets support bidirectional iterators.
83 * The private tree data is declared exactly the same way for set and
84 * multiset; the distinction is made entirely in how the tree functions are
85 * called (*_unique versus *_equal, same as the standard).
87 template <typename _Key
, typename _Compare
= std::less
<_Key
>,
88 typename _Alloc
= std::allocator
<_Key
> >
91 // concept requirements
92 typedef typename
_Alloc::value_type _Alloc_value_type
;
93 __glibcxx_class_requires(_Key
, _SGIAssignableConcept
)
94 __glibcxx_class_requires4(_Compare
, bool, _Key
, _Key
,
95 _BinaryFunctionConcept
)
96 __glibcxx_class_requires2(_Key
, _Alloc_value_type
, _SameTypeConcept
)
100 typedef _Key key_type
;
101 typedef _Key value_type
;
102 typedef _Compare key_compare
;
103 typedef _Compare value_compare
;
104 typedef _Alloc allocator_type
;
107 /// This turns a red-black tree into a [multi]set.
108 typedef typename
_Alloc::template rebind
<_Key
>::other _Key_alloc_type
;
110 typedef _Rb_tree
<key_type
, value_type
, _Identity
<value_type
>,
111 key_compare
, _Key_alloc_type
> _Rep_type
;
112 /// The actual tree structure.
116 typedef typename
_Key_alloc_type::pointer pointer
;
117 typedef typename
_Key_alloc_type::const_pointer const_pointer
;
118 typedef typename
_Key_alloc_type::reference reference
;
119 typedef typename
_Key_alloc_type::const_reference const_reference
;
120 // _GLIBCXX_RESOLVE_LIB_DEFECTS
121 // DR 103. set::iterator is required to be modifiable,
122 // but this allows modification of keys.
123 typedef typename
_Rep_type::const_iterator iterator
;
124 typedef typename
_Rep_type::const_iterator const_iterator
;
125 typedef typename
_Rep_type::const_reverse_iterator reverse_iterator
;
126 typedef typename
_Rep_type::const_reverse_iterator const_reverse_iterator
;
127 typedef typename
_Rep_type::size_type size_type
;
128 typedef typename
_Rep_type::difference_type difference_type
;
130 // allocation/deallocation
132 * @brief Default constructor creates no elements.
138 * @brief Creates a %multiset with no elements.
139 * @param comp Comparator to use.
140 * @param a An allocator object.
143 multiset(const _Compare
& __comp
,
144 const allocator_type
& __a
= allocator_type())
145 : _M_t(__comp
, __a
) { }
148 * @brief Builds a %multiset from a range.
149 * @param first An input iterator.
150 * @param last An input iterator.
152 * Create a %multiset consisting of copies of the elements from
153 * [first,last). This is linear in N if the range is already sorted,
154 * and NlogN otherwise (where N is distance(first,last)).
156 template<typename _InputIterator
>
157 multiset(_InputIterator __first
, _InputIterator __last
)
159 { _M_t
._M_insert_equal(__first
, __last
); }
162 * @brief Builds a %multiset from a range.
163 * @param first An input iterator.
164 * @param last An input iterator.
165 * @param comp A comparison functor.
166 * @param a An allocator object.
168 * Create a %multiset consisting of copies of the elements from
169 * [first,last). This is linear in N if the range is already sorted,
170 * and NlogN otherwise (where N is distance(first,last)).
172 template<typename _InputIterator
>
173 multiset(_InputIterator __first
, _InputIterator __last
,
174 const _Compare
& __comp
,
175 const allocator_type
& __a
= allocator_type())
177 { _M_t
._M_insert_equal(__first
, __last
); }
180 * @brief %Multiset copy constructor.
181 * @param x A %multiset of identical element and allocator types.
183 * The newly-created %multiset uses a copy of the allocation object used
186 multiset(const multiset
& __x
)
189 #ifdef __GXX_EXPERIMENTAL_CXX0X__
191 * @brief %Multiset move constructor.
192 * @param x A %multiset of identical element and allocator types.
194 * The newly-created %multiset contains the exact contents of @a x.
195 * The contents of @a x are a valid, but unspecified %multiset.
197 multiset(multiset
&& __x
)
198 : _M_t(std::forward
<_Rep_type
>(__x
._M_t
)) { }
202 * @brief %Multiset assignment operator.
203 * @param x A %multiset of identical element and allocator types.
205 * All the elements of @a x are copied, but unlike the copy constructor,
206 * the allocator object is not copied.
209 operator=(const multiset
& __x
)
215 #ifdef __GXX_EXPERIMENTAL_CXX0X__
217 * @brief %Multiset move assignment operator.
218 * @param x A %multiset of identical element and allocator types.
220 * The contents of @a x are moved into this %multiset (without copying).
221 * @a x is a valid, but unspecified %multiset.
224 operator=(multiset
&& __x
)
235 /// Returns the comparison object.
238 { return _M_t
.key_comp(); }
239 /// Returns the comparison object.
242 { return _M_t
.key_comp(); }
243 /// Returns the memory allocation object.
245 get_allocator() const
246 { return _M_t
.get_allocator(); }
249 * Returns a read-only (constant) iterator that points to the first
250 * element in the %multiset. Iteration is done in ascending order
251 * according to the keys.
255 { return _M_t
.begin(); }
258 * Returns a read-only (constant) iterator that points one past the last
259 * element in the %multiset. Iteration is done in ascending order
260 * according to the keys.
264 { return _M_t
.end(); }
267 * Returns a read-only (constant) reverse iterator that points to the
268 * last element in the %multiset. Iteration is done in descending order
269 * according to the keys.
273 { return _M_t
.rbegin(); }
276 * Returns a read-only (constant) reverse iterator that points to the
277 * last element in the %multiset. Iteration is done in descending order
278 * according to the keys.
282 { return _M_t
.rend(); }
284 #ifdef __GXX_EXPERIMENTAL_CXX0X__
286 * Returns a read-only (constant) iterator that points to the first
287 * element in the %multiset. Iteration is done in ascending order
288 * according to the keys.
292 { return _M_t
.begin(); }
295 * Returns a read-only (constant) iterator that points one past the last
296 * element in the %multiset. Iteration is done in ascending order
297 * according to the keys.
301 { return _M_t
.end(); }
304 * Returns a read-only (constant) reverse iterator that points to the
305 * last element in the %multiset. Iteration is done in descending order
306 * according to the keys.
310 { return _M_t
.rbegin(); }
313 * Returns a read-only (constant) reverse iterator that points to the
314 * last element in the %multiset. Iteration is done in descending order
315 * according to the keys.
319 { return _M_t
.rend(); }
322 /// Returns true if the %set is empty.
325 { return _M_t
.empty(); }
327 /// Returns the size of the %set.
330 { return _M_t
.size(); }
332 /// Returns the maximum size of the %set.
335 { return _M_t
.max_size(); }
338 * @brief Swaps data with another %multiset.
339 * @param x A %multiset of the same element and allocator types.
341 * This exchanges the elements between two multisets in constant time.
342 * (It is only swapping a pointer, an integer, and an instance of the @c
343 * Compare type (which itself is often stateless and empty), so it should
345 * Note that the global std::swap() function is specialized such that
346 * std::swap(s1,s2) will feed to this function.
349 #ifdef __GXX_EXPERIMENTAL_CXX0X__
354 { _M_t
.swap(__x
._M_t
); }
358 * @brief Inserts an element into the %multiset.
359 * @param x Element to be inserted.
360 * @return An iterator that points to the inserted element.
362 * This function inserts an element into the %multiset. Contrary
363 * to a std::set the %multiset does not rely on unique keys and thus
364 * multiple copies of the same element can be inserted.
366 * Insertion requires logarithmic time.
369 insert(const value_type
& __x
)
370 { return _M_t
._M_insert_equal(__x
); }
373 * @brief Inserts an element into the %multiset.
374 * @param position An iterator that serves as a hint as to where the
375 * element should be inserted.
376 * @param x Element to be inserted.
377 * @return An iterator that points to the inserted element.
379 * This function inserts an element into the %multiset. Contrary
380 * to a std::set the %multiset does not rely on unique keys and thus
381 * multiple copies of the same element can be inserted.
383 * Note that the first parameter is only a hint and can potentially
384 * improve the performance of the insertion process. A bad hint would
385 * cause no gains in efficiency.
387 * See http://gcc.gnu.org/onlinedocs/libstdc++/23_containers/howto.html#4
388 * for more on "hinting".
390 * Insertion requires logarithmic time (if the hint is not taken).
393 insert(iterator __position
, const value_type
& __x
)
394 { return _M_t
._M_insert_equal_(__position
, __x
); }
397 * @brief A template function that attemps to insert a range of elements.
398 * @param first Iterator pointing to the start of the range to be
400 * @param last Iterator pointing to the end of the range.
402 * Complexity similar to that of the range constructor.
404 template<typename _InputIterator
>
406 insert(_InputIterator __first
, _InputIterator __last
)
407 { _M_t
._M_insert_equal(__first
, __last
); }
410 * @brief Erases an element from a %multiset.
411 * @param position An iterator pointing to the element to be erased.
413 * This function erases an element, pointed to by the given iterator,
414 * from a %multiset. Note that this function only erases the element,
415 * and that if the element is itself a pointer, the pointed-to memory is
416 * not touched in any way. Managing the pointer is the user's
420 erase(iterator __position
)
421 { _M_t
.erase(__position
); }
424 * @brief Erases elements according to the provided key.
425 * @param x Key of element to be erased.
426 * @return The number of elements erased.
428 * This function erases all elements located by the given key from a
430 * Note that this function only erases the element, and that if
431 * the element is itself a pointer, the pointed-to memory is not touched
432 * in any way. Managing the pointer is the user's responsibilty.
435 erase(const key_type
& __x
)
436 { return _M_t
.erase(__x
); }
439 * @brief Erases a [first,last) range of elements from a %multiset.
440 * @param first Iterator pointing to the start of the range to be
442 * @param last Iterator pointing to the end of the range to be erased.
444 * This function erases a sequence of elements from a %multiset.
445 * Note that this function only erases the elements, and that if
446 * the elements themselves are pointers, the pointed-to memory is not
447 * touched in any way. Managing the pointer is the user's responsibilty.
450 erase(iterator __first
, iterator __last
)
451 { _M_t
.erase(__first
, __last
); }
454 * Erases all elements in a %multiset. Note that this function only
455 * erases the elements, and that if the elements themselves are pointers,
456 * the pointed-to memory is not touched in any way. Managing the pointer
457 * is the user's responsibilty.
463 // multiset operations:
466 * @brief Finds the number of elements with given key.
467 * @param x Key of elements to be located.
468 * @return Number of elements with specified key.
471 count(const key_type
& __x
) const
472 { return _M_t
.count(__x
); }
474 // _GLIBCXX_RESOLVE_LIB_DEFECTS
475 // 214. set::find() missing const overload
478 * @brief Tries to locate an element in a %set.
479 * @param x Element to be located.
480 * @return Iterator pointing to sought-after element, or end() if not
483 * This function takes a key and tries to locate the element with which
484 * the key matches. If successful the function returns an iterator
485 * pointing to the sought after element. If unsuccessful it returns the
486 * past-the-end ( @c end() ) iterator.
489 find(const key_type
& __x
)
490 { return _M_t
.find(__x
); }
493 find(const key_type
& __x
) const
494 { return _M_t
.find(__x
); }
499 * @brief Finds the beginning of a subsequence matching given key.
500 * @param x Key to be located.
501 * @return Iterator pointing to first element equal to or greater
502 * than key, or end().
504 * This function returns the first element of a subsequence of elements
505 * that matches the given key. If unsuccessful it returns an iterator
506 * pointing to the first element that has a greater value than given key
507 * or end() if no such element exists.
510 lower_bound(const key_type
& __x
)
511 { return _M_t
.lower_bound(__x
); }
514 lower_bound(const key_type
& __x
) const
515 { return _M_t
.lower_bound(__x
); }
520 * @brief Finds the end of a subsequence matching given key.
521 * @param x Key to be located.
522 * @return Iterator pointing to the first element
523 * greater than key, or end().
526 upper_bound(const key_type
& __x
)
527 { return _M_t
.upper_bound(__x
); }
530 upper_bound(const key_type
& __x
) const
531 { return _M_t
.upper_bound(__x
); }
536 * @brief Finds a subsequence matching given key.
537 * @param x Key to be located.
538 * @return Pair of iterators that possibly points to the subsequence
539 * matching given key.
541 * This function is equivalent to
543 * std::make_pair(c.lower_bound(val),
544 * c.upper_bound(val))
546 * (but is faster than making the calls separately).
548 * This function probably only makes sense for multisets.
550 std::pair
<iterator
, iterator
>
551 equal_range(const key_type
& __x
)
552 { return _M_t
.equal_range(__x
); }
554 std::pair
<const_iterator
, const_iterator
>
555 equal_range(const key_type
& __x
) const
556 { return _M_t
.equal_range(__x
); }
558 template<typename _K1
, typename _C1
, typename _A1
>
560 operator==(const multiset
<_K1
, _C1
, _A1
>&,
561 const multiset
<_K1
, _C1
, _A1
>&);
563 template<typename _K1
, typename _C1
, typename _A1
>
565 operator< (const multiset
<_K1
, _C1
, _A1
>&,
566 const multiset
<_K1
, _C1
, _A1
>&);
570 * @brief Multiset equality comparison.
571 * @param x A %multiset.
572 * @param y A %multiset of the same type as @a x.
573 * @return True iff the size and elements of the multisets are equal.
575 * This is an equivalence relation. It is linear in the size of the
577 * Multisets are considered equivalent if their sizes are equal, and if
578 * corresponding elements compare equal.
580 template<typename _Key
, typename _Compare
, typename _Alloc
>
582 operator==(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
583 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
584 { return __x
._M_t
== __y
._M_t
; }
587 * @brief Multiset ordering relation.
588 * @param x A %multiset.
589 * @param y A %multiset of the same type as @a x.
590 * @return True iff @a x is lexicographically less than @a y.
592 * This is a total ordering relation. It is linear in the size of the
593 * maps. The elements must be comparable with @c <.
595 * See std::lexicographical_compare() for how the determination is made.
597 template<typename _Key
, typename _Compare
, typename _Alloc
>
599 operator<(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
600 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
601 { return __x
._M_t
< __y
._M_t
; }
603 /// Returns !(x == y).
604 template<typename _Key
, typename _Compare
, typename _Alloc
>
606 operator!=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
607 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
608 { return !(__x
== __y
); }
611 template<typename _Key
, typename _Compare
, typename _Alloc
>
613 operator>(const multiset
<_Key
,_Compare
,_Alloc
>& __x
,
614 const multiset
<_Key
,_Compare
,_Alloc
>& __y
)
615 { return __y
< __x
; }
618 template<typename _Key
, typename _Compare
, typename _Alloc
>
620 operator<=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
621 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
622 { return !(__y
< __x
); }
625 template<typename _Key
, typename _Compare
, typename _Alloc
>
627 operator>=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
628 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
629 { return !(__x
< __y
); }
631 /// See std::multiset::swap().
632 template<typename _Key
, typename _Compare
, typename _Alloc
>
634 swap(multiset
<_Key
, _Compare
, _Alloc
>& __x
,
635 multiset
<_Key
, _Compare
, _Alloc
>& __y
)
638 #ifdef __GXX_EXPERIMENTAL_CXX0X__
639 template<typename _Key
, typename _Compare
, typename _Alloc
>
641 swap(multiset
<_Key
, _Compare
, _Alloc
>&& __x
,
642 multiset
<_Key
, _Compare
, _Alloc
>& __y
)
645 template<typename _Key
, typename _Compare
, typename _Alloc
>
647 swap(multiset
<_Key
, _Compare
, _Alloc
>& __x
,
648 multiset
<_Key
, _Compare
, _Alloc
>&& __y
)
652 _GLIBCXX_END_NESTED_NAMESPACE
654 #endif /* _STL_MULTISET_H */