1 // Multiset implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
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)
247 * @brief %Multiset list assignment operator.
248 * @param l An initializer_list.
250 * This function fills a %multiset with copies of the elements in the
251 * initializer list @a l.
253 * Note that the assignment completely changes the %multiset and
254 * that the resulting %multiset's size is the same as the number
255 * of elements assigned. Old data may be lost.
258 operator=(initializer_list<value_type> __l)
261 this->insert(__l.begin(), __l.end());
268 /// Returns the comparison object.
271 { return _M_t.key_comp(); }
272 /// Returns the comparison object.
275 { return _M_t.key_comp(); }
276 /// Returns the memory allocation object.
278 get_allocator() const
279 { return _M_t.get_allocator(); }
282 * Returns a read-only (constant) iterator that points to the first
283 * element in the %multiset. Iteration is done in ascending order
284 * according to the keys.
288 { return _M_t.begin(); }
291 * Returns a read-only (constant) iterator that points one past the last
292 * element in the %multiset. Iteration is done in ascending order
293 * according to the keys.
297 { return _M_t.end(); }
300 * Returns a read-only (constant) reverse iterator that points to the
301 * last element in the %multiset. Iteration is done in descending order
302 * according to the keys.
306 { return _M_t.rbegin(); }
309 * Returns a read-only (constant) reverse iterator that points to the
310 * last element in the %multiset. Iteration is done in descending order
311 * according to the keys.
315 { return _M_t.rend(); }
317 #ifdef __GXX_EXPERIMENTAL_CXX0X__
319 * Returns a read-only (constant) iterator that points to the first
320 * element in the %multiset. Iteration is done in ascending order
321 * according to the keys.
325 { return _M_t.begin(); }
328 * Returns a read-only (constant) iterator that points one past the last
329 * element in the %multiset. Iteration is done in ascending order
330 * according to the keys.
334 { return _M_t.end(); }
337 * Returns a read-only (constant) reverse iterator that points to the
338 * last element in the %multiset. Iteration is done in descending order
339 * according to the keys.
343 { return _M_t.rbegin(); }
346 * Returns a read-only (constant) reverse iterator that points to the
347 * last element in the %multiset. Iteration is done in descending order
348 * according to the keys.
352 { return _M_t.rend(); }
355 /// Returns true if the %set is empty.
358 { return _M_t.empty(); }
360 /// Returns the size of the %set.
363 { return _M_t.size(); }
365 /// Returns the maximum size of the %set.
368 { return _M_t.max_size(); }
371 * @brief Swaps data with another %multiset.
372 * @param x A %multiset of the same element and allocator types.
374 * This exchanges the elements between two multisets in constant time.
375 * (It is only swapping a pointer, an integer, and an instance of the @c
376 * Compare type (which itself is often stateless and empty), so it should
378 * Note that the global std::swap() function is specialized such that
379 * std::swap(s1,s2) will feed to this function.
383 { _M_t.swap(__x._M_t); }
387 * @brief Inserts an element into the %multiset.
388 * @param x Element to be inserted.
389 * @return An iterator that points to the inserted element.
391 * This function inserts an element into the %multiset. Contrary
392 * to a std::set the %multiset does not rely on unique keys and thus
393 * multiple copies of the same element can be inserted.
395 * Insertion requires logarithmic time.
398 insert(const value_type& __x)
399 { return _M_t._M_insert_equal(__x); }
402 * @brief Inserts an element into the %multiset.
403 * @param position An iterator that serves as a hint as to where the
404 * element should be inserted.
405 * @param x Element to be inserted.
406 * @return An iterator that points to the inserted element.
408 * This function inserts an element into the %multiset. Contrary
409 * to a std::set the %multiset does not rely on unique keys and thus
410 * multiple copies of the same element can be inserted.
412 * Note that the first parameter is only a hint and can potentially
413 * improve the performance of the insertion process. A bad hint would
414 * cause no gains in efficiency.
416 * See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
417 * for more on "hinting".
419 * Insertion requires logarithmic time (if the hint is not taken).
422 insert(iterator __position, const value_type& __x)
423 { return _M_t._M_insert_equal_(__position, __x); }
426 * @brief A template function that attempts to insert a range of elements.
427 * @param first Iterator pointing to the start of the range to be
429 * @param last Iterator pointing to the end of the range.
431 * Complexity similar to that of the range constructor.
433 template<typename _InputIterator>
435 insert(_InputIterator __first, _InputIterator __last)
436 { _M_t._M_insert_equal(__first, __last); }
438 #ifdef __GXX_EXPERIMENTAL_CXX0X__
440 * @brief Attempts to insert a list of elements into the %multiset.
441 * @param list A std::initializer_list<value_type> of elements
444 * Complexity similar to that of the range constructor.
447 insert(initializer_list<value_type> __l)
448 { this->insert(__l.begin(), __l.end()); }
451 #ifdef __GXX_EXPERIMENTAL_CXX0X__
452 // _GLIBCXX_RESOLVE_LIB_DEFECTS
453 // DR 130. Associative erase should return an iterator.
455 * @brief Erases an element from a %multiset.
456 * @param position An iterator pointing to the element to be erased.
457 * @return An iterator pointing to the element immediately following
458 * @a position prior to the element being erased. If no such
459 * element exists, end() is returned.
461 * This function erases an element, pointed to by the given iterator,
462 * from a %multiset. Note that this function only erases the element,
463 * and that if the element is itself a pointer, the pointed-to memory is
464 * not touched in any way. Managing the pointer is the user's
468 erase(iterator __position)
469 { return _M_t.erase(__position); }
472 * @brief Erases an element from a %multiset.
473 * @param position An iterator pointing to the element to be erased.
475 * This function erases an element, pointed to by the given iterator,
476 * from a %multiset. Note that this function only erases the element,
477 * and that if the element is itself a pointer, the pointed-to memory is
478 * not touched in any way. Managing the pointer is the user's
482 erase(iterator __position)
483 { _M_t.erase(__position); }
487 * @brief Erases elements according to the provided key.
488 * @param x Key of element to be erased.
489 * @return The number of elements erased.
491 * This function erases all elements located by the given key from a
493 * Note that this function only erases the element, and that if
494 * the element is itself a pointer, the pointed-to memory is not touched
495 * in any way. Managing the pointer is the user's responsibility.
498 erase(const key_type& __x)
499 { return _M_t.erase(__x); }
501 #ifdef __GXX_EXPERIMENTAL_CXX0X__
502 // _GLIBCXX_RESOLVE_LIB_DEFECTS
503 // DR 130. Associative erase should return an iterator.
505 * @brief Erases a [first,last) range of elements from a %multiset.
506 * @param first Iterator pointing to the start of the range to be
508 * @param last Iterator pointing to the end of the range to be erased.
509 * @return The iterator @a last.
511 * This function erases a sequence of elements from a %multiset.
512 * Note that this function only erases the elements, and that if
513 * the elements themselves are pointers, the pointed-to memory is not
514 * touched in any way. Managing the pointer is the user's responsibility.
517 erase(iterator __first, iterator __last)
518 { return _M_t.erase(__first, __last); }
521 * @brief Erases a [first,last) range of elements from a %multiset.
522 * @param first Iterator pointing to the start of the range to be
524 * @param last Iterator pointing to the end of the range to be erased.
526 * This function erases a sequence of elements from a %multiset.
527 * Note that this function only erases the elements, and that if
528 * the elements themselves are pointers, the pointed-to memory is not
529 * touched in any way. Managing the pointer is the user's responsibility.
532 erase(iterator __first, iterator __last)
533 { _M_t.erase(__first, __last); }
537 * Erases all elements in a %multiset. Note that this function only
538 * erases the elements, and that if the elements themselves are pointers,
539 * the pointed-to memory is not touched in any way. Managing the pointer
540 * is the user's responsibility.
546 // multiset operations:
549 * @brief Finds the number of elements with given key.
550 * @param x Key of elements to be located.
551 * @return Number of elements with specified key.
554 count(const key_type& __x) const
555 { return _M_t.count(__x); }
557 // _GLIBCXX_RESOLVE_LIB_DEFECTS
558 // 214. set::find() missing const overload
561 * @brief Tries to locate an element in a %set.
562 * @param x Element to be located.
563 * @return Iterator pointing to sought-after element, or end() if not
566 * This function takes a key and tries to locate the element with which
567 * the key matches. If successful the function returns an iterator
568 * pointing to the sought after element. If unsuccessful it returns the
569 * past-the-end ( @c end() ) iterator.
572 find(const key_type& __x)
573 { return _M_t.find(__x); }
576 find(const key_type& __x) const
577 { return _M_t.find(__x); }
582 * @brief Finds the beginning of a subsequence matching given key.
583 * @param x Key to be located.
584 * @return Iterator pointing to first element equal to or greater
585 * than key, or end().
587 * This function returns the first element of a subsequence of elements
588 * that matches the given key. If unsuccessful it returns an iterator
589 * pointing to the first element that has a greater value than given key
590 * or end() if no such element exists.
593 lower_bound(const key_type& __x)
594 { return _M_t.lower_bound(__x); }
597 lower_bound(const key_type& __x) const
598 { return _M_t.lower_bound(__x); }
603 * @brief Finds the end of a subsequence matching given key.
604 * @param x Key to be located.
605 * @return Iterator pointing to the first element
606 * greater than key, or end().
609 upper_bound(const key_type& __x)
610 { return _M_t.upper_bound(__x); }
613 upper_bound(const key_type& __x) const
614 { return _M_t.upper_bound(__x); }
619 * @brief Finds a subsequence matching given key.
620 * @param x Key to be located.
621 * @return Pair of iterators that possibly points to the subsequence
622 * matching given key.
624 * This function is equivalent to
626 * std::make_pair(c.lower_bound(val),
627 * c.upper_bound(val))
629 * (but is faster than making the calls separately).
631 * This function probably only makes sense for multisets.
633 std::pair<iterator, iterator>
634 equal_range(const key_type& __x)
635 { return _M_t.equal_range(__x); }
637 std::pair<const_iterator, const_iterator>
638 equal_range(const key_type& __x) const
639 { return _M_t.equal_range(__x); }
641 template<typename _K1, typename _C1, typename _A1>
643 operator==(const multiset<_K1, _C1, _A1>&,
644 const multiset<_K1, _C1, _A1>&);
646 template<typename _K1, typename _C1, typename _A1>
648 operator< (const multiset<_K1, _C1, _A1>&,
649 const multiset<_K1, _C1, _A1>&);
653 * @brief Multiset equality comparison.
654 * @param x A %multiset.
655 * @param y A %multiset of the same type as @a x.
656 * @return True iff the size and elements of the multisets are equal.
658 * This is an equivalence relation. It is linear in the size of the
660 * Multisets are considered equivalent if their sizes are equal, and if
661 * corresponding elements compare equal.
663 template<typename _Key, typename _Compare, typename _Alloc>
665 operator==(const multiset<_Key, _Compare, _Alloc>& __x,
666 const multiset<_Key, _Compare, _Alloc>& __y)
667 { return __x._M_t == __y._M_t; }
670 * @brief Multiset ordering relation.
671 * @param x A %multiset.
672 * @param y A %multiset of the same type as @a x.
673 * @return True iff @a x is lexicographically less than @a y.
675 * This is a total ordering relation. It is linear in the size of the
676 * maps. The elements must be comparable with @c <.
678 * See std::lexicographical_compare() for how the determination is made.
680 template<typename _Key, typename _Compare, typename _Alloc>
682 operator<(const multiset<_Key, _Compare, _Alloc>& __x,
683 const multiset<_Key, _Compare, _Alloc>& __y)
684 { return __x._M_t < __y._M_t; }
686 /// Returns !(x == y).
687 template<typename _Key, typename _Compare, typename _Alloc>
689 operator!=(const multiset<_Key, _Compare, _Alloc>& __x,
690 const multiset<_Key, _Compare, _Alloc>& __y)
691 { return !(__x == __y); }
694 template<typename _Key, typename _Compare, typename _Alloc>
696 operator>(const multiset<_Key,_Compare,_Alloc>& __x,
697 const multiset<_Key,_Compare,_Alloc>& __y)
698 { return __y < __x; }
701 template<typename _Key, typename _Compare, typename _Alloc>
703 operator<=(const multiset<_Key, _Compare, _Alloc>& __x,
704 const multiset<_Key, _Compare, _Alloc>& __y)
705 { return !(__y < __x); }
708 template<typename _Key, typename _Compare, typename _Alloc>
710 operator>=(const multiset<_Key, _Compare, _Alloc>& __x,
711 const multiset<_Key, _Compare, _Alloc>& __y)
712 { return !(__x < __y); }
714 /// See std::multiset::swap().
715 template<typename _Key, typename _Compare, typename _Alloc>
717 swap(multiset<_Key, _Compare, _Alloc>& __x,
718 multiset<_Key, _Compare, _Alloc>& __y)
721 _GLIBCXX_END_NESTED_NAMESPACE
723 #endif /* _STL_MULTISET_H */