1 // Multiset implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2004, 2005 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 2, 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 // You should have received a copy of the GNU General Public License along
17 // with this library; see the file COPYING. If not, write to the Free
18 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
21 // As a special exception, you may use this file as part of a free software
22 // library without restriction. Specifically, if other files instantiate
23 // templates or use macros or inline functions from this file, or you compile
24 // this file and link it with other files to produce an executable, this
25 // file does not by itself cause the resulting executable to be covered by
26 // the GNU General Public License. This exception does not however
27 // invalidate any other reasons why the executable file might be covered by
28 // the GNU General Public License.
33 * Hewlett-Packard Company
35 * Permission to use, copy, modify, distribute and sell this software
36 * and its documentation for any purpose is hereby granted without fee,
37 * provided that the above copyright notice appear in all copies and
38 * that both that copyright notice and this permission notice appear
39 * in supporting documentation. Hewlett-Packard Company makes no
40 * representations about the suitability of this software for any
41 * purpose. It is provided "as is" without express or implied warranty.
45 * Silicon Graphics Computer Systems, Inc.
47 * Permission to use, copy, modify, distribute and sell this software
48 * and its documentation for any purpose is hereby granted without fee,
49 * provided that the above copyright notice appear in all copies and
50 * that both that copyright notice and this permission notice appear
51 * in supporting documentation. Silicon Graphics makes no
52 * representations about the suitability of this software for any
53 * purpose. It is provided "as is" without express or implied warranty.
56 /** @file stl_multiset.h
57 * This is an internal header file, included by other library headers.
58 * You should not attempt to use it directly.
64 #include <bits/concept_check.h>
66 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std
, _GLIBCXX_STD
)
68 // Forward declaration of operators < and ==, needed for friend declaration.
69 template <class _Key
, class _Compare
= std::less
<_Key
>,
70 class _Alloc
= std::allocator
<_Key
> >
73 template <class _Key
, class _Compare
, class _Alloc
>
75 operator==(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
76 const multiset
<_Key
, _Compare
, _Alloc
>& __y
);
78 template <class _Key
, class _Compare
, class _Alloc
>
80 operator<(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
81 const multiset
<_Key
, _Compare
, _Alloc
>& __y
);
84 * @brief A standard container made up of elements, which can be retrieved
85 * in logarithmic time.
88 * @ingroup Assoc_containers
90 * Meets the requirements of a <a href="tables.html#65">container</a>, a
91 * <a href="tables.html#66">reversible container</a>, and an
92 * <a href="tables.html#69">associative container</a> (using equivalent
93 * keys). For a @c multiset<Key> the key_type and value_type are Key.
95 * Multisets support bidirectional iterators.
98 * The private tree data is declared exactly the same way for set and
99 * multiset; the distinction is made entirely in how the tree functions are
100 * called (*_unique versus *_equal, same as the standard).
103 template <class _Key
, class _Compare
, class _Alloc
>
106 // concept requirements
107 typedef typename
_Alloc::value_type _Alloc_value_type
;
108 __glibcxx_class_requires(_Key
, _SGIAssignableConcept
)
109 __glibcxx_class_requires4(_Compare
, bool, _Key
, _Key
,
110 _BinaryFunctionConcept
)
111 __glibcxx_class_requires2(_Key
, _Alloc_value_type
, _SameTypeConcept
)
115 typedef _Key key_type
;
116 typedef _Key value_type
;
117 typedef _Compare key_compare
;
118 typedef _Compare value_compare
;
119 typedef _Alloc allocator_type
;
122 /// @if maint This turns a red-black tree into a [multi]set. @endif
123 typedef typename
_Alloc::template rebind
<_Key
>::other _Key_alloc_type
;
125 typedef _Rb_tree
<key_type
, value_type
, _Identity
<value_type
>,
126 key_compare
, _Key_alloc_type
> _Rep_type
;
127 /// @if maint The actual tree structure. @endif
131 typedef typename
_Key_alloc_type::pointer pointer
;
132 typedef typename
_Key_alloc_type::const_pointer const_pointer
;
133 typedef typename
_Key_alloc_type::reference reference
;
134 typedef typename
_Key_alloc_type::const_reference const_reference
;
135 // _GLIBCXX_RESOLVE_LIB_DEFECTS
136 // DR 103. set::iterator is required to be modifiable,
137 // but this allows modification of keys.
138 typedef typename
_Rep_type::const_iterator iterator
;
139 typedef typename
_Rep_type::const_iterator const_iterator
;
140 typedef typename
_Rep_type::const_reverse_iterator reverse_iterator
;
141 typedef typename
_Rep_type::const_reverse_iterator const_reverse_iterator
;
142 typedef typename
_Rep_type::size_type size_type
;
143 typedef typename
_Rep_type::difference_type difference_type
;
145 // allocation/deallocation
148 * @brief Default constructor creates no elements.
151 : _M_t(_Compare(), allocator_type()) { }
154 multiset(const _Compare
& __comp
,
155 const allocator_type
& __a
= allocator_type())
156 : _M_t(__comp
, __a
) { }
159 * @brief Builds a %multiset from a range.
160 * @param first An input iterator.
161 * @param last An input iterator.
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 <class _InputIterator
>
168 multiset(_InputIterator __first
, _InputIterator __last
)
169 : _M_t(_Compare(), allocator_type())
170 { _M_t
.insert_equal(__first
, __last
); }
173 * @brief Builds a %multiset from a range.
174 * @param first An input iterator.
175 * @param last An input iterator.
176 * @param comp A comparison functor.
177 * @param a An allocator object.
179 * Create a %multiset consisting of copies of the elements from
180 * [first,last). This is linear in N if the range is already sorted,
181 * and NlogN otherwise (where N is distance(first,last)).
183 template <class _InputIterator
>
184 multiset(_InputIterator __first
, _InputIterator __last
,
185 const _Compare
& __comp
,
186 const allocator_type
& __a
= allocator_type())
188 { _M_t
.insert_equal(__first
, __last
); }
191 * @brief %Multiset copy constructor.
192 * @param x A %multiset of identical element and allocator types.
194 * The newly-created %multiset uses a copy of the allocation object used
197 multiset(const multiset
<_Key
,_Compare
,_Alloc
>& __x
)
201 * @brief %Multiset assignment operator.
202 * @param x A %multiset of identical element and allocator types.
204 * All the elements of @a x are copied, but unlike the copy constructor,
205 * the allocator object is not copied.
207 multiset
<_Key
,_Compare
,_Alloc
>&
208 operator=(const multiset
<_Key
,_Compare
,_Alloc
>& __x
)
216 /// Returns the comparison object.
219 { return _M_t
.key_comp(); }
220 /// Returns the comparison object.
223 { return _M_t
.key_comp(); }
224 /// Returns the memory allocation object.
226 get_allocator() const
227 { return _M_t
.get_allocator(); }
230 * Returns a read/write iterator that points to the first element in the
231 * %multiset. Iteration is done in ascending order according to the
236 { return _M_t
.begin(); }
239 * Returns a read/write iterator that points one past the last element in
240 * the %multiset. Iteration is done in ascending order according to the
245 { return _M_t
.end(); }
248 * Returns a read/write reverse iterator that points to the last element
249 * in the %multiset. Iteration is done in descending order according to
254 { return _M_t
.rbegin(); }
257 * Returns a read/write reverse iterator that points to the last element
258 * in the %multiset. Iteration is done in descending order according to
263 { return _M_t
.rend(); }
265 /// Returns true if the %set is empty.
268 { return _M_t
.empty(); }
270 /// Returns the size of the %set.
273 { return _M_t
.size(); }
275 /// Returns the maximum size of the %set.
278 { return _M_t
.max_size(); }
281 * @brief Swaps data with another %multiset.
282 * @param x A %multiset of the same element and allocator types.
284 * This exchanges the elements between two multisets in constant time.
285 * (It is only swapping a pointer, an integer, and an instance of the @c
286 * Compare type (which itself is often stateless and empty), so it should
288 * Note that the global std::swap() function is specialized such that
289 * std::swap(s1,s2) will feed to this function.
292 swap(multiset
<_Key
, _Compare
, _Alloc
>& __x
)
293 { _M_t
.swap(__x
._M_t
); }
297 * @brief Inserts an element into the %multiset.
298 * @param x Element to be inserted.
299 * @return An iterator that points to the inserted element.
301 * This function inserts an element into the %multiset. Contrary
302 * to a std::set the %multiset does not rely on unique keys and thus
303 * multiple copies of the same element can be inserted.
305 * Insertion requires logarithmic time.
308 insert(const value_type
& __x
)
309 { return _M_t
.insert_equal(__x
); }
312 * @brief Inserts an element into the %multiset.
313 * @param position An iterator that serves as a hint as to where the
314 * element should be inserted.
315 * @param x Element to be inserted.
316 * @return An iterator that points to the inserted element.
318 * This function inserts an element into the %multiset. Contrary
319 * to a std::set the %multiset does not rely on unique keys and thus
320 * multiple copies of the same element can be inserted.
322 * Note that the first parameter is only a hint and can potentially
323 * improve the performance of the insertion process. A bad hint would
324 * cause no gains in efficiency.
326 * See http://gcc.gnu.org/onlinedocs/libstdc++/23_containers/howto.html#4
327 * for more on "hinting".
329 * Insertion requires logarithmic time (if the hint is not taken).
332 insert(iterator __position
, const value_type
& __x
)
333 { return _M_t
.insert_equal(__position
, __x
); }
336 * @brief A template function that attemps to insert a range of elements.
337 * @param first Iterator pointing to the start of the range to be
339 * @param last Iterator pointing to the end of the range.
341 * Complexity similar to that of the range constructor.
343 template <class _InputIterator
>
345 insert(_InputIterator __first
, _InputIterator __last
)
346 { _M_t
.insert_equal(__first
, __last
); }
349 * @brief Erases an element from a %multiset.
350 * @param position An iterator pointing to the element to be erased.
352 * This function erases an element, pointed to by the given iterator,
353 * from a %multiset. Note that this function only erases the element,
354 * and that if the element is itself a pointer, the pointed-to memory is
355 * not touched in any way. Managing the pointer is the user's
359 erase(iterator __position
)
360 { _M_t
.erase(__position
); }
363 * @brief Erases elements according to the provided key.
364 * @param x Key of element to be erased.
365 * @return The number of elements erased.
367 * This function erases all elements located by the given key from a
369 * Note that this function only erases the element, and that if
370 * the element is itself a pointer, the pointed-to memory is not touched
371 * in any way. Managing the pointer is the user's responsibilty.
374 erase(const key_type
& __x
)
375 { return _M_t
.erase(__x
); }
378 * @brief Erases a [first,last) range of elements from a %multiset.
379 * @param first Iterator pointing to the start of the range to be
381 * @param last Iterator pointing to the end of the range to be erased.
383 * This function erases a sequence of elements from a %multiset.
384 * Note that this function only erases the elements, and that if
385 * the elements themselves are pointers, the pointed-to memory is not
386 * touched in any way. Managing the pointer is the user's responsibilty.
389 erase(iterator __first
, iterator __last
)
390 { _M_t
.erase(__first
, __last
); }
393 * Erases all elements in a %multiset. Note that this function only
394 * erases the elements, and that if the elements themselves are pointers,
395 * the pointed-to memory is not touched in any way. Managing the pointer
396 * is the user's responsibilty.
402 // multiset operations:
405 * @brief Finds the number of elements with given key.
406 * @param x Key of elements to be located.
407 * @return Number of elements with specified key.
410 count(const key_type
& __x
) const
411 { return _M_t
.count(__x
); }
413 // _GLIBCXX_RESOLVE_LIB_DEFECTS
414 // 214. set::find() missing const overload
417 * @brief Tries to locate an element in a %set.
418 * @param x Element to be located.
419 * @return Iterator pointing to sought-after element, or end() if not
422 * This function takes a key and tries to locate the element with which
423 * the key matches. If successful the function returns an iterator
424 * pointing to the sought after element. If unsuccessful it returns the
425 * past-the-end ( @c end() ) iterator.
428 find(const key_type
& __x
)
429 { return _M_t
.find(__x
); }
432 find(const key_type
& __x
) const
433 { return _M_t
.find(__x
); }
438 * @brief Finds the beginning of a subsequence matching given key.
439 * @param x Key to be located.
440 * @return Iterator pointing to first element equal to or greater
441 * than key, or end().
443 * This function returns the first element of a subsequence of elements
444 * that matches the given key. If unsuccessful it returns an iterator
445 * pointing to the first element that has a greater value than given key
446 * or end() if no such element exists.
449 lower_bound(const key_type
& __x
)
450 { return _M_t
.lower_bound(__x
); }
453 lower_bound(const key_type
& __x
) const
454 { return _M_t
.lower_bound(__x
); }
459 * @brief Finds the end of a subsequence matching given key.
460 * @param x Key to be located.
461 * @return Iterator pointing to the first element
462 * greater than key, or end().
465 upper_bound(const key_type
& __x
)
466 { return _M_t
.upper_bound(__x
); }
469 upper_bound(const key_type
& __x
) const
470 { return _M_t
.upper_bound(__x
); }
475 * @brief Finds a subsequence matching given key.
476 * @param x Key to be located.
477 * @return Pair of iterators that possibly points to the subsequence
478 * matching given key.
480 * This function is equivalent to
482 * std::make_pair(c.lower_bound(val),
483 * c.upper_bound(val))
485 * (but is faster than making the calls separately).
487 * This function probably only makes sense for multisets.
489 std::pair
<iterator
, iterator
>
490 equal_range(const key_type
& __x
)
491 { return _M_t
.equal_range(__x
); }
493 std::pair
<const_iterator
, const_iterator
>
494 equal_range(const key_type
& __x
) const
495 { return _M_t
.equal_range(__x
); }
497 template <class _K1
, class _C1
, class _A1
>
499 operator== (const multiset
<_K1
, _C1
, _A1
>&,
500 const multiset
<_K1
, _C1
, _A1
>&);
502 template <class _K1
, class _C1
, class _A1
>
504 operator< (const multiset
<_K1
, _C1
, _A1
>&,
505 const multiset
<_K1
, _C1
, _A1
>&);
509 * @brief Multiset equality comparison.
510 * @param x A %multiset.
511 * @param y A %multiset of the same type as @a x.
512 * @return True iff the size and elements of the multisets are equal.
514 * This is an equivalence relation. It is linear in the size of the
516 * Multisets are considered equivalent if their sizes are equal, and if
517 * corresponding elements compare equal.
519 template <class _Key
, class _Compare
, class _Alloc
>
521 operator==(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
522 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
523 { return __x
._M_t
== __y
._M_t
; }
526 * @brief Multiset ordering relation.
527 * @param x A %multiset.
528 * @param y A %multiset of the same type as @a x.
529 * @return True iff @a x is lexicographically less than @a y.
531 * This is a total ordering relation. It is linear in the size of the
532 * maps. The elements must be comparable with @c <.
534 * See std::lexicographical_compare() for how the determination is made.
536 template <class _Key
, class _Compare
, class _Alloc
>
538 operator<(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
539 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
540 { return __x
._M_t
< __y
._M_t
; }
542 /// Returns !(x == y).
543 template <class _Key
, class _Compare
, class _Alloc
>
545 operator!=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
546 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
547 { return !(__x
== __y
); }
550 template <class _Key
, class _Compare
, class _Alloc
>
552 operator>(const multiset
<_Key
,_Compare
,_Alloc
>& __x
,
553 const multiset
<_Key
,_Compare
,_Alloc
>& __y
)
554 { return __y
< __x
; }
557 template <class _Key
, class _Compare
, class _Alloc
>
559 operator<=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
560 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
561 { return !(__y
< __x
); }
564 template <class _Key
, class _Compare
, class _Alloc
>
566 operator>=(const multiset
<_Key
, _Compare
, _Alloc
>& __x
,
567 const multiset
<_Key
, _Compare
, _Alloc
>& __y
)
568 { return !(__x
< __y
); }
570 /// See std::multiset::swap().
571 template <class _Key
, class _Compare
, class _Alloc
>
573 swap(multiset
<_Key
, _Compare
, _Alloc
>& __x
,
574 multiset
<_Key
, _Compare
, _Alloc
>& __y
)
577 _GLIBCXX_END_NESTED_NAMESPACE
579 #endif /* _MULTISET_H */