xref: /netbsd-src/external/gpl3/gcc/dist/libstdc++-v3/include/bits/stl_multiset.h (revision d909946ca08dceb44d7d0f22ec9488679695d976)
1 // Multiset implementation -*- C++ -*-
2 
3 // Copyright (C) 2001-2015 Free Software Foundation, Inc.
4 //
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)
9 // any later version.
10 
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.
15 
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.
19 
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/>.
24 
25 /*
26  *
27  * Copyright (c) 1994
28  * Hewlett-Packard Company
29  *
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.
37  *
38  *
39  * Copyright (c) 1996
40  * Silicon Graphics Computer Systems, Inc.
41  *
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.
49  */
50 
51 /** @file bits/stl_multiset.h
52  *  This is an internal header file, included by other library headers.
53  *  Do not attempt to use it directly. @headername{set}
54  */
55 
56 #ifndef _STL_MULTISET_H
57 #define _STL_MULTISET_H 1
58 
59 #include <bits/concept_check.h>
60 #if __cplusplus >= 201103L
61 #include <initializer_list>
62 #endif
63 
64 namespace std _GLIBCXX_VISIBILITY(default)
65 {
66 _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
67 
68   /**
69    *  @brief A standard container made up of elements, which can be retrieved
70    *  in logarithmic time.
71    *
72    *  @ingroup associative_containers
73    *
74    *
75    *  @tparam _Key  Type of key objects.
76    *  @tparam _Compare  Comparison function object type, defaults to less<_Key>.
77    *  @tparam _Alloc  Allocator type, defaults to allocator<_Key>.
78    *
79    *  Meets the requirements of a <a href="tables.html#65">container</a>, a
80    *  <a href="tables.html#66">reversible container</a>, and an
81    *  <a href="tables.html#69">associative container</a> (using equivalent
82    *  keys).  For a @c multiset<Key> the key_type and value_type are Key.
83    *
84    *  Multisets support bidirectional iterators.
85    *
86    *  The private tree data is declared exactly the same way for set and
87    *  multiset; the distinction is made entirely in how the tree functions are
88    *  called (*_unique versus *_equal, same as the standard).
89   */
90   template <typename _Key, typename _Compare = std::less<_Key>,
91 	    typename _Alloc = std::allocator<_Key> >
92     class multiset
93     {
94       // concept requirements
95       typedef typename _Alloc::value_type                   _Alloc_value_type;
96       __glibcxx_class_requires(_Key, _SGIAssignableConcept)
97       __glibcxx_class_requires4(_Compare, bool, _Key, _Key,
98 				_BinaryFunctionConcept)
99       __glibcxx_class_requires2(_Key, _Alloc_value_type, _SameTypeConcept)
100 
101     public:
102       // typedefs:
103       typedef _Key     key_type;
104       typedef _Key     value_type;
105       typedef _Compare key_compare;
106       typedef _Compare value_compare;
107       typedef _Alloc   allocator_type;
108 
109     private:
110       /// This turns a red-black tree into a [multi]set.
111       typedef typename __gnu_cxx::__alloc_traits<_Alloc>::template
112 	rebind<_Key>::other _Key_alloc_type;
113 
114       typedef _Rb_tree<key_type, value_type, _Identity<value_type>,
115 		       key_compare, _Key_alloc_type> _Rep_type;
116       /// The actual tree structure.
117       _Rep_type _M_t;
118 
119       typedef __gnu_cxx::__alloc_traits<_Key_alloc_type> _Alloc_traits;
120 
121     public:
122       typedef typename _Alloc_traits::pointer		    pointer;
123       typedef typename _Alloc_traits::const_pointer	    const_pointer;
124       typedef typename _Alloc_traits::reference		    reference;
125       typedef typename _Alloc_traits::const_reference	    const_reference;
126       // _GLIBCXX_RESOLVE_LIB_DEFECTS
127       // DR 103. set::iterator is required to be modifiable,
128       // but this allows modification of keys.
129       typedef typename _Rep_type::const_iterator            iterator;
130       typedef typename _Rep_type::const_iterator            const_iterator;
131       typedef typename _Rep_type::const_reverse_iterator    reverse_iterator;
132       typedef typename _Rep_type::const_reverse_iterator const_reverse_iterator;
133       typedef typename _Rep_type::size_type                 size_type;
134       typedef typename _Rep_type::difference_type           difference_type;
135 
136       // allocation/deallocation
137       /**
138        *  @brief  Default constructor creates no elements.
139        */
140       multiset()
141 #if __cplusplus >= 201103L
142       noexcept(is_nothrow_default_constructible<allocator_type>::value)
143 #endif
144       : _M_t() { }
145 
146       /**
147        *  @brief  Creates a %multiset with no elements.
148        *  @param  __comp  Comparator to use.
149        *  @param  __a  An allocator object.
150        */
151       explicit
152       multiset(const _Compare& __comp,
153 	       const allocator_type& __a = allocator_type())
154       : _M_t(__comp, _Key_alloc_type(__a)) { }
155 
156       /**
157        *  @brief  Builds a %multiset from a range.
158        *  @param  __first  An input iterator.
159        *  @param  __last  An input iterator.
160        *
161        *  Create a %multiset consisting of copies of the elements from
162        *  [first,last).  This is linear in N if the range is already sorted,
163        *  and NlogN otherwise (where N is distance(__first,__last)).
164        */
165       template<typename _InputIterator>
166         multiset(_InputIterator __first, _InputIterator __last)
167 	: _M_t()
168         { _M_t._M_insert_equal(__first, __last); }
169 
170       /**
171        *  @brief  Builds a %multiset from a range.
172        *  @param  __first  An input iterator.
173        *  @param  __last  An input iterator.
174        *  @param  __comp  A comparison functor.
175        *  @param  __a  An allocator object.
176        *
177        *  Create a %multiset consisting of copies of the elements from
178        *  [__first,__last).  This is linear in N if the range is already sorted,
179        *  and NlogN otherwise (where N is distance(__first,__last)).
180        */
181       template<typename _InputIterator>
182         multiset(_InputIterator __first, _InputIterator __last,
183 		 const _Compare& __comp,
184 		 const allocator_type& __a = allocator_type())
185 	: _M_t(__comp, _Key_alloc_type(__a))
186         { _M_t._M_insert_equal(__first, __last); }
187 
188       /**
189        *  @brief  %Multiset copy constructor.
190        *  @param  __x  A %multiset of identical element and allocator types.
191        *
192        *  The newly-created %multiset uses a copy of the allocation object used
193        *  by @a __x.
194        */
195       multiset(const multiset& __x)
196       : _M_t(__x._M_t) { }
197 
198 #if __cplusplus >= 201103L
199      /**
200        *  @brief  %Multiset move constructor.
201        *  @param  __x  A %multiset of identical element and allocator types.
202        *
203        *  The newly-created %multiset contains the exact contents of @a __x.
204        *  The contents of @a __x are a valid, but unspecified %multiset.
205        */
206       multiset(multiset&& __x)
207       noexcept(is_nothrow_copy_constructible<_Compare>::value)
208       : _M_t(std::move(__x._M_t)) { }
209 
210       /**
211        *  @brief  Builds a %multiset from an initializer_list.
212        *  @param  __l  An initializer_list.
213        *  @param  __comp  A comparison functor.
214        *  @param  __a  An allocator object.
215        *
216        *  Create a %multiset consisting of copies of the elements from
217        *  the list.  This is linear in N if the list is already sorted,
218        *  and NlogN otherwise (where N is @a __l.size()).
219        */
220       multiset(initializer_list<value_type> __l,
221 	       const _Compare& __comp = _Compare(),
222 	       const allocator_type& __a = allocator_type())
223       : _M_t(__comp, _Key_alloc_type(__a))
224       { _M_t._M_insert_equal(__l.begin(), __l.end()); }
225 
226       /// Allocator-extended default constructor.
227       explicit
228       multiset(const allocator_type& __a)
229       : _M_t(_Compare(), _Key_alloc_type(__a)) { }
230 
231       /// Allocator-extended copy constructor.
232       multiset(const multiset& __m, const allocator_type& __a)
233       : _M_t(__m._M_t, _Key_alloc_type(__a)) { }
234 
235       /// Allocator-extended move constructor.
236       multiset(multiset&& __m, const allocator_type& __a)
237       noexcept(is_nothrow_copy_constructible<_Compare>::value
238 	       && _Alloc_traits::_S_always_equal())
239       : _M_t(std::move(__m._M_t), _Key_alloc_type(__a)) { }
240 
241       /// Allocator-extended initialier-list constructor.
242       multiset(initializer_list<value_type> __l, const allocator_type& __a)
243       : _M_t(_Compare(), _Key_alloc_type(__a))
244       { _M_t._M_insert_equal(__l.begin(), __l.end()); }
245 
246       /// Allocator-extended range constructor.
247       template<typename _InputIterator>
248         multiset(_InputIterator __first, _InputIterator __last,
249 		 const allocator_type& __a)
250 	: _M_t(_Compare(), _Key_alloc_type(__a))
251         { _M_t._M_insert_equal(__first, __last); }
252 #endif
253 
254       /**
255        *  @brief  %Multiset assignment operator.
256        *  @param  __x  A %multiset of identical element and allocator types.
257        *
258        *  All the elements of @a __x are copied, but unlike the copy
259        *  constructor, the allocator object is not copied.
260        */
261       multiset&
262       operator=(const multiset& __x)
263       {
264 	_M_t = __x._M_t;
265 	return *this;
266       }
267 
268 #if __cplusplus >= 201103L
269       /// Move assignment operator.
270       multiset&
271       operator=(multiset&&) = default;
272 
273       /**
274        *  @brief  %Multiset list assignment operator.
275        *  @param  __l  An initializer_list.
276        *
277        *  This function fills a %multiset with copies of the elements in the
278        *  initializer list @a __l.
279        *
280        *  Note that the assignment completely changes the %multiset and
281        *  that the resulting %multiset's size is the same as the number
282        *  of elements assigned.  Old data may be lost.
283        */
284       multiset&
285       operator=(initializer_list<value_type> __l)
286       {
287 	_M_t._M_assign_equal(__l.begin(), __l.end());
288 	return *this;
289       }
290 #endif
291 
292       // accessors:
293 
294       ///  Returns the comparison object.
295       key_compare
296       key_comp() const
297       { return _M_t.key_comp(); }
298       ///  Returns the comparison object.
299       value_compare
300       value_comp() const
301       { return _M_t.key_comp(); }
302       ///  Returns the memory allocation object.
303       allocator_type
304       get_allocator() const _GLIBCXX_NOEXCEPT
305       { return allocator_type(_M_t.get_allocator()); }
306 
307       /**
308        *  Returns a read-only (constant) iterator that points to the first
309        *  element in the %multiset.  Iteration is done in ascending order
310        *  according to the keys.
311        */
312       iterator
313       begin() const _GLIBCXX_NOEXCEPT
314       { return _M_t.begin(); }
315 
316       /**
317        *  Returns a read-only (constant) iterator that points one past the last
318        *  element in the %multiset.  Iteration is done in ascending order
319        *  according to the keys.
320        */
321       iterator
322       end() const _GLIBCXX_NOEXCEPT
323       { return _M_t.end(); }
324 
325       /**
326        *  Returns a read-only (constant) reverse iterator that points to the
327        *  last element in the %multiset.  Iteration is done in descending order
328        *  according to the keys.
329        */
330       reverse_iterator
331       rbegin() const _GLIBCXX_NOEXCEPT
332       { return _M_t.rbegin(); }
333 
334       /**
335        *  Returns a read-only (constant) reverse iterator that points to the
336        *  last element in the %multiset.  Iteration is done in descending order
337        *  according to the keys.
338        */
339       reverse_iterator
340       rend() const _GLIBCXX_NOEXCEPT
341       { return _M_t.rend(); }
342 
343 #if __cplusplus >= 201103L
344       /**
345        *  Returns a read-only (constant) iterator that points to the first
346        *  element in the %multiset.  Iteration is done in ascending order
347        *  according to the keys.
348        */
349       iterator
350       cbegin() const noexcept
351       { return _M_t.begin(); }
352 
353       /**
354        *  Returns a read-only (constant) iterator that points one past the last
355        *  element in the %multiset.  Iteration is done in ascending order
356        *  according to the keys.
357        */
358       iterator
359       cend() const noexcept
360       { return _M_t.end(); }
361 
362       /**
363        *  Returns a read-only (constant) reverse iterator that points to the
364        *  last element in the %multiset.  Iteration is done in descending order
365        *  according to the keys.
366        */
367       reverse_iterator
368       crbegin() const noexcept
369       { return _M_t.rbegin(); }
370 
371       /**
372        *  Returns a read-only (constant) reverse iterator that points to the
373        *  last element in the %multiset.  Iteration is done in descending order
374        *  according to the keys.
375        */
376       reverse_iterator
377       crend() const noexcept
378       { return _M_t.rend(); }
379 #endif
380 
381       ///  Returns true if the %set is empty.
382       bool
383       empty() const _GLIBCXX_NOEXCEPT
384       { return _M_t.empty(); }
385 
386       ///  Returns the size of the %set.
387       size_type
388       size() const _GLIBCXX_NOEXCEPT
389       { return _M_t.size(); }
390 
391       ///  Returns the maximum size of the %set.
392       size_type
393       max_size() const _GLIBCXX_NOEXCEPT
394       { return _M_t.max_size(); }
395 
396       /**
397        *  @brief  Swaps data with another %multiset.
398        *  @param  __x  A %multiset of the same element and allocator types.
399        *
400        *  This exchanges the elements between two multisets in constant time.
401        *  (It is only swapping a pointer, an integer, and an instance of the @c
402        *  Compare type (which itself is often stateless and empty), so it should
403        *  be quite fast.)
404        *  Note that the global std::swap() function is specialized such that
405        *  std::swap(s1,s2) will feed to this function.
406        */
407       void
408       swap(multiset& __x)
409 #if __cplusplus >= 201103L
410       noexcept(_Alloc_traits::_S_nothrow_swap())
411 #endif
412       { _M_t.swap(__x._M_t); }
413 
414       // insert/erase
415 #if __cplusplus >= 201103L
416       /**
417        *  @brief Builds and inserts an element into the %multiset.
418        *  @param  __args  Arguments used to generate the element instance to be
419        *                 inserted.
420        *  @return An iterator that points to the inserted element.
421        *
422        *  This function inserts an element into the %multiset.  Contrary
423        *  to a std::set the %multiset does not rely on unique keys and thus
424        *  multiple copies of the same element can be inserted.
425        *
426        *  Insertion requires logarithmic time.
427        */
428       template<typename... _Args>
429 	iterator
430 	emplace(_Args&&... __args)
431 	{ return _M_t._M_emplace_equal(std::forward<_Args>(__args)...); }
432 
433       /**
434        *  @brief Builds and inserts an element into the %multiset.
435        *  @param  __pos  An iterator that serves as a hint as to where the
436        *                element should be inserted.
437        *  @param  __args  Arguments used to generate the element instance to be
438        *                 inserted.
439        *  @return An iterator that points to the inserted element.
440        *
441        *  This function inserts an element into the %multiset.  Contrary
442        *  to a std::set the %multiset does not rely on unique keys and thus
443        *  multiple copies of the same element can be inserted.
444        *
445        *  Note that the first parameter is only a hint and can potentially
446        *  improve the performance of the insertion process.  A bad hint would
447        *  cause no gains in efficiency.
448        *
449        *  See https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints
450        *  for more on @a hinting.
451        *
452        *  Insertion requires logarithmic time (if the hint is not taken).
453        */
454       template<typename... _Args>
455 	iterator
456 	emplace_hint(const_iterator __pos, _Args&&... __args)
457 	{
458 	  return _M_t._M_emplace_hint_equal(__pos,
459 					    std::forward<_Args>(__args)...);
460 	}
461 #endif
462 
463       /**
464        *  @brief Inserts an element into the %multiset.
465        *  @param  __x  Element to be inserted.
466        *  @return An iterator that points to the inserted element.
467        *
468        *  This function inserts an element into the %multiset.  Contrary
469        *  to a std::set the %multiset does not rely on unique keys and thus
470        *  multiple copies of the same element can be inserted.
471        *
472        *  Insertion requires logarithmic time.
473        */
474       iterator
475       insert(const value_type& __x)
476       { return _M_t._M_insert_equal(__x); }
477 
478 #if __cplusplus >= 201103L
479       iterator
480       insert(value_type&& __x)
481       { return _M_t._M_insert_equal(std::move(__x)); }
482 #endif
483 
484       /**
485        *  @brief Inserts an element into the %multiset.
486        *  @param  __position  An iterator that serves as a hint as to where the
487        *                    element should be inserted.
488        *  @param  __x  Element to be inserted.
489        *  @return An iterator that points to the inserted element.
490        *
491        *  This function inserts an element into the %multiset.  Contrary
492        *  to a std::set the %multiset does not rely on unique keys and thus
493        *  multiple copies of the same element can be inserted.
494        *
495        *  Note that the first parameter is only a hint and can potentially
496        *  improve the performance of the insertion process.  A bad hint would
497        *  cause no gains in efficiency.
498        *
499        *  See https://gcc.gnu.org/onlinedocs/libstdc++/manual/associative.html#containers.associative.insert_hints
500        *  for more on @a hinting.
501        *
502        *  Insertion requires logarithmic time (if the hint is not taken).
503        */
504       iterator
505       insert(const_iterator __position, const value_type& __x)
506       { return _M_t._M_insert_equal_(__position, __x); }
507 
508 #if __cplusplus >= 201103L
509       iterator
510       insert(const_iterator __position, value_type&& __x)
511       { return _M_t._M_insert_equal_(__position, std::move(__x)); }
512 #endif
513 
514       /**
515        *  @brief A template function that tries to insert a range of elements.
516        *  @param  __first  Iterator pointing to the start of the range to be
517        *                   inserted.
518        *  @param  __last  Iterator pointing to the end of the range.
519        *
520        *  Complexity similar to that of the range constructor.
521        */
522       template<typename _InputIterator>
523         void
524         insert(_InputIterator __first, _InputIterator __last)
525         { _M_t._M_insert_equal(__first, __last); }
526 
527 #if __cplusplus >= 201103L
528       /**
529        *  @brief Attempts to insert a list of elements into the %multiset.
530        *  @param  __l  A std::initializer_list<value_type> of elements
531        *               to be inserted.
532        *
533        *  Complexity similar to that of the range constructor.
534        */
535       void
536       insert(initializer_list<value_type> __l)
537       { this->insert(__l.begin(), __l.end()); }
538 #endif
539 
540 #if __cplusplus >= 201103L
541       // _GLIBCXX_RESOLVE_LIB_DEFECTS
542       // DR 130. Associative erase should return an iterator.
543       /**
544        *  @brief Erases an element from a %multiset.
545        *  @param  __position  An iterator pointing to the element to be erased.
546        *  @return An iterator pointing to the element immediately following
547        *          @a position prior to the element being erased. If no such
548        *          element exists, end() is returned.
549        *
550        *  This function erases an element, pointed to by the given iterator,
551        *  from a %multiset.  Note that this function only erases the element,
552        *  and that if the element is itself a pointer, the pointed-to memory is
553        *  not touched in any way.  Managing the pointer is the user's
554        *  responsibility.
555        */
556       _GLIBCXX_ABI_TAG_CXX11
557       iterator
558       erase(const_iterator __position)
559       { return _M_t.erase(__position); }
560 #else
561       /**
562        *  @brief Erases an element from a %multiset.
563        *  @param  __position  An iterator pointing to the element to be erased.
564        *
565        *  This function erases an element, pointed to by the given iterator,
566        *  from a %multiset.  Note that this function only erases the element,
567        *  and that if the element is itself a pointer, the pointed-to memory is
568        *  not touched in any way.  Managing the pointer is the user's
569        *  responsibility.
570        */
571       void
572       erase(iterator __position)
573       { _M_t.erase(__position); }
574 #endif
575 
576       /**
577        *  @brief Erases elements according to the provided key.
578        *  @param  __x  Key of element to be erased.
579        *  @return  The number of elements erased.
580        *
581        *  This function erases all elements located by the given key from a
582        *  %multiset.
583        *  Note that this function only erases the element, and that if
584        *  the element is itself a pointer, the pointed-to memory is not touched
585        *  in any way.  Managing the pointer is the user's responsibility.
586        */
587       size_type
588       erase(const key_type& __x)
589       { return _M_t.erase(__x); }
590 
591 #if __cplusplus >= 201103L
592       // _GLIBCXX_RESOLVE_LIB_DEFECTS
593       // DR 130. Associative erase should return an iterator.
594       /**
595        *  @brief Erases a [first,last) range of elements from a %multiset.
596        *  @param  __first  Iterator pointing to the start of the range to be
597        *                   erased.
598        *  @param __last Iterator pointing to the end of the range to
599        *                be erased.
600        *  @return The iterator @a last.
601        *
602        *  This function erases a sequence of elements from a %multiset.
603        *  Note that this function only erases the elements, and that if
604        *  the elements themselves are pointers, the pointed-to memory is not
605        *  touched in any way.  Managing the pointer is the user's
606        *  responsibility.
607        */
608       _GLIBCXX_ABI_TAG_CXX11
609       iterator
610       erase(const_iterator __first, const_iterator __last)
611       { return _M_t.erase(__first, __last); }
612 #else
613       /**
614        *  @brief Erases a [first,last) range of elements from a %multiset.
615        *  @param  first  Iterator pointing to the start of the range to be
616        *                 erased.
617        *  @param  last  Iterator pointing to the end of the range to be erased.
618        *
619        *  This function erases a sequence of elements from a %multiset.
620        *  Note that this function only erases the elements, and that if
621        *  the elements themselves are pointers, the pointed-to memory is not
622        *  touched in any way.  Managing the pointer is the user's
623        *  responsibility.
624        */
625       void
626       erase(iterator __first, iterator __last)
627       { _M_t.erase(__first, __last); }
628 #endif
629 
630       /**
631        *  Erases all elements in a %multiset.  Note that this function only
632        *  erases the elements, and that if the elements themselves are pointers,
633        *  the pointed-to memory is not touched in any way.  Managing the pointer
634        *  is the user's responsibility.
635        */
636       void
637       clear() _GLIBCXX_NOEXCEPT
638       { _M_t.clear(); }
639 
640       // multiset operations:
641 
642       //@{
643       /**
644        *  @brief Finds the number of elements with given key.
645        *  @param  __x  Key of elements to be located.
646        *  @return Number of elements with specified key.
647        */
648       size_type
649       count(const key_type& __x) const
650       { return _M_t.count(__x); }
651 
652 #if __cplusplus > 201103L
653       template<typename _Kt>
654 	auto
655 	count(const _Kt& __x) const -> decltype(_M_t._M_count_tr(__x))
656 	{ return _M_t._M_count_tr(__x); }
657 #endif
658       //@}
659 
660       // _GLIBCXX_RESOLVE_LIB_DEFECTS
661       // 214.  set::find() missing const overload
662       //@{
663       /**
664        *  @brief Tries to locate an element in a %set.
665        *  @param  __x  Element to be located.
666        *  @return  Iterator pointing to sought-after element, or end() if not
667        *           found.
668        *
669        *  This function takes a key and tries to locate the element with which
670        *  the key matches.  If successful the function returns an iterator
671        *  pointing to the sought after element.  If unsuccessful it returns the
672        *  past-the-end ( @c end() ) iterator.
673        */
674       iterator
675       find(const key_type& __x)
676       { return _M_t.find(__x); }
677 
678       const_iterator
679       find(const key_type& __x) const
680       { return _M_t.find(__x); }
681 
682 #if __cplusplus > 201103L
683       template<typename _Kt>
684 	auto
685 	find(const _Kt& __x)
686 	-> decltype(iterator{_M_t._M_find_tr(__x)})
687 	{ return iterator{_M_t._M_find_tr(__x)}; }
688 
689       template<typename _Kt>
690 	auto
691 	find(const _Kt& __x) const
692 	-> decltype(const_iterator{_M_t._M_find_tr(__x)})
693 	{ return const_iterator{_M_t._M_find_tr(__x)}; }
694 #endif
695       //@}
696 
697       //@{
698       /**
699        *  @brief Finds the beginning of a subsequence matching given key.
700        *  @param  __x  Key to be located.
701        *  @return  Iterator pointing to first element equal to or greater
702        *           than key, or end().
703        *
704        *  This function returns the first element of a subsequence of elements
705        *  that matches the given key.  If unsuccessful it returns an iterator
706        *  pointing to the first element that has a greater value than given key
707        *  or end() if no such element exists.
708        */
709       iterator
710       lower_bound(const key_type& __x)
711       { return _M_t.lower_bound(__x); }
712 
713       const_iterator
714       lower_bound(const key_type& __x) const
715       { return _M_t.lower_bound(__x); }
716 
717 #if __cplusplus > 201103L
718       template<typename _Kt>
719 	auto
720 	lower_bound(const _Kt& __x)
721 	-> decltype(_M_t._M_lower_bound_tr(__x))
722 	{ return _M_t._M_lower_bound_tr(__x); }
723 
724       template<typename _Kt>
725 	auto
726 	lower_bound(const _Kt& __x) const
727 	-> decltype(_M_t._M_lower_bound_tr(__x))
728 	{ return _M_t._M_lower_bound_tr(__x); }
729 #endif
730       //@}
731 
732       //@{
733       /**
734        *  @brief Finds the end of a subsequence matching given key.
735        *  @param  __x  Key to be located.
736        *  @return Iterator pointing to the first element
737        *          greater than key, or end().
738        */
739       iterator
740       upper_bound(const key_type& __x)
741       { return _M_t.upper_bound(__x); }
742 
743       const_iterator
744       upper_bound(const key_type& __x) const
745       { return _M_t.upper_bound(__x); }
746 
747 #if __cplusplus > 201103L
748       template<typename _Kt>
749 	auto
750 	upper_bound(const _Kt& __x)
751 	-> decltype(_M_t._M_upper_bound_tr(__x))
752 	{ return _M_t._M_upper_bound_tr(__x); }
753 
754       template<typename _Kt>
755 	auto
756 	upper_bound(const _Kt& __x) const
757 	-> decltype(_M_t._M_upper_bound_tr(__x))
758 	{ return _M_t._M_upper_bound_tr(__x); }
759 #endif
760       //@}
761 
762       //@{
763       /**
764        *  @brief Finds a subsequence matching given key.
765        *  @param  __x  Key to be located.
766        *  @return  Pair of iterators that possibly points to the subsequence
767        *           matching given key.
768        *
769        *  This function is equivalent to
770        *  @code
771        *    std::make_pair(c.lower_bound(val),
772        *                   c.upper_bound(val))
773        *  @endcode
774        *  (but is faster than making the calls separately).
775        *
776        *  This function probably only makes sense for multisets.
777        */
778       std::pair<iterator, iterator>
779       equal_range(const key_type& __x)
780       { return _M_t.equal_range(__x); }
781 
782       std::pair<const_iterator, const_iterator>
783       equal_range(const key_type& __x) const
784       { return _M_t.equal_range(__x); }
785 
786 #if __cplusplus > 201103L
787       template<typename _Kt>
788 	auto
789 	equal_range(const _Kt& __x)
790 	-> decltype(_M_t._M_equal_range_tr(__x))
791 	{ return _M_t._M_equal_range_tr(__x); }
792 
793       template<typename _Kt>
794 	auto
795 	equal_range(const _Kt& __x) const
796 	-> decltype(_M_t._M_equal_range_tr(__x))
797 	{ return _M_t._M_equal_range_tr(__x); }
798 #endif
799       //@}
800 
801       template<typename _K1, typename _C1, typename _A1>
802         friend bool
803         operator==(const multiset<_K1, _C1, _A1>&,
804 		   const multiset<_K1, _C1, _A1>&);
805 
806       template<typename _K1, typename _C1, typename _A1>
807         friend bool
808         operator< (const multiset<_K1, _C1, _A1>&,
809 		   const multiset<_K1, _C1, _A1>&);
810     };
811 
812   /**
813    *  @brief  Multiset equality comparison.
814    *  @param  __x  A %multiset.
815    *  @param  __y  A %multiset of the same type as @a __x.
816    *  @return  True iff the size and elements of the multisets are equal.
817    *
818    *  This is an equivalence relation.  It is linear in the size of the
819    *  multisets.
820    *  Multisets are considered equivalent if their sizes are equal, and if
821    *  corresponding elements compare equal.
822   */
823   template<typename _Key, typename _Compare, typename _Alloc>
824     inline bool
825     operator==(const multiset<_Key, _Compare, _Alloc>& __x,
826 	       const multiset<_Key, _Compare, _Alloc>& __y)
827     { return __x._M_t == __y._M_t; }
828 
829   /**
830    *  @brief  Multiset ordering relation.
831    *  @param  __x  A %multiset.
832    *  @param  __y  A %multiset of the same type as @a __x.
833    *  @return  True iff @a __x is lexicographically less than @a __y.
834    *
835    *  This is a total ordering relation.  It is linear in the size of the
836    *  sets.  The elements must be comparable with @c <.
837    *
838    *  See std::lexicographical_compare() for how the determination is made.
839   */
840   template<typename _Key, typename _Compare, typename _Alloc>
841     inline bool
842     operator<(const multiset<_Key, _Compare, _Alloc>& __x,
843 	      const multiset<_Key, _Compare, _Alloc>& __y)
844     { return __x._M_t < __y._M_t; }
845 
846   ///  Returns !(x == y).
847   template<typename _Key, typename _Compare, typename _Alloc>
848     inline bool
849     operator!=(const multiset<_Key, _Compare, _Alloc>& __x,
850 	       const multiset<_Key, _Compare, _Alloc>& __y)
851     { return !(__x == __y); }
852 
853   ///  Returns y < x.
854   template<typename _Key, typename _Compare, typename _Alloc>
855     inline bool
856     operator>(const multiset<_Key,_Compare,_Alloc>& __x,
857 	      const multiset<_Key,_Compare,_Alloc>& __y)
858     { return __y < __x; }
859 
860   ///  Returns !(y < x)
861   template<typename _Key, typename _Compare, typename _Alloc>
862     inline bool
863     operator<=(const multiset<_Key, _Compare, _Alloc>& __x,
864 	       const multiset<_Key, _Compare, _Alloc>& __y)
865     { return !(__y < __x); }
866 
867   ///  Returns !(x < y)
868   template<typename _Key, typename _Compare, typename _Alloc>
869     inline bool
870     operator>=(const multiset<_Key, _Compare, _Alloc>& __x,
871 	       const multiset<_Key, _Compare, _Alloc>& __y)
872     { return !(__x < __y); }
873 
874   /// See std::multiset::swap().
875   template<typename _Key, typename _Compare, typename _Alloc>
876     inline void
877     swap(multiset<_Key, _Compare, _Alloc>& __x,
878 	 multiset<_Key, _Compare, _Alloc>& __y)
879     { __x.swap(__y); }
880 
881 _GLIBCXX_END_NAMESPACE_CONTAINER
882 } // namespace std
883 
884 #endif /* _STL_MULTISET_H */
885