OSDN Git Service

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