libstdc++-v3/include/bits/stl_multimap.h

   1 // Multimap implementation -*- C++ -*-
   2
   3 // Copyright (C) 2001 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 2, 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 // 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, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  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.
  29
  30 /*
  31  *
  32  * Copyright (c) 1994
  33  * Hewlett-Packard Company
  34  *
  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.
  42  *
  43  *
  44  * Copyright (c) 1996,1997
  45  * Silicon Graphics Computer Systems, Inc.
  46  *
  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.
  54  */
  55
  56 /* NOTE: This is an internal header file, included by other STL headers.
  57  *   You should not attempt to use it directly.
  58  */
  59
  60 #ifndef __SGI_STL_INTERNAL_MULTIMAP_H
  61 #define __SGI_STL_INTERNAL_MULTIMAP_H
  62
  63 #include <bits/concept_check.h>
  64
  65 namespace std
  66 {
  67
  68 // Forward declaration of operators < and ==, needed for friend declaration.
  69
  70 template <class _Key, class _Tp,
  71           class _Compare = less<_Key>,
  72           class _Alloc = allocator<pair<const _Key, _Tp> > >
  73 class multimap;
  74
  75 template <class _Key, class _Tp, class _Compare, class _Alloc>
  76 inline bool operator==(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
  77                        const multimap<_Key,_Tp,_Compare,_Alloc>& __y);
  78
  79 template <class _Key, class _Tp, class _Compare, class _Alloc>
  80 inline bool operator<(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
  81                       const multimap<_Key,_Tp,_Compare,_Alloc>& __y);
  82
  83 template <class _Key, class _Tp, class _Compare, class _Alloc>
  84 class multimap
  85 {
  86   // concept requirements
  87   __glibcpp_class_requires(_Tp, _SGIAssignableConcept);
  88   __glibcpp_class_requires4(_Compare, bool, _Key, _Key, _BinaryFunctionConcept);
  89
  90 public:
  91
  92 // typedefs:
  93
  94   typedef _Key                  key_type;
  95   typedef _Tp                   data_type;
  96   typedef _Tp                   mapped_type;
  97   typedef pair<const _Key, _Tp> value_type;
  98   typedef _Compare              key_compare;
  99
 100   class value_compare : public binary_function<value_type, value_type, bool> {
 101   friend class multimap<_Key,_Tp,_Compare,_Alloc>;
 102   protected:
 103     _Compare comp;
 104     value_compare(_Compare __c) : comp(__c) {}
 105   public:
 106     bool operator()(const value_type& __x, const value_type& __y) const {
 107       return comp(__x.first, __y.first);
 108     }
 109   };
 110
 111 private:
 112   typedef _Rb_tree<key_type, value_type,
 113                   _Select1st<value_type>, key_compare, _Alloc> _Rep_type;
 114   _Rep_type _M_t;  // red-black tree representing multimap
 115 public:
 116   typedef typename _Rep_type::pointer pointer;
 117   typedef typename _Rep_type::const_pointer const_pointer;
 118   typedef typename _Rep_type::reference reference;
 119   typedef typename _Rep_type::const_reference const_reference;
 120   typedef typename _Rep_type::iterator iterator;
 121   typedef typename _Rep_type::const_iterator const_iterator;
 122   typedef typename _Rep_type::reverse_iterator reverse_iterator;
 123   typedef typename _Rep_type::const_reverse_iterator const_reverse_iterator;
 124   typedef typename _Rep_type::size_type size_type;
 125   typedef typename _Rep_type::difference_type difference_type;
 126   typedef typename _Rep_type::allocator_type allocator_type;
 127
 128 // allocation/deallocation
 129
 130   multimap() : _M_t(_Compare(), allocator_type()) { }
 131   explicit multimap(const _Compare& __comp,
 132                     const allocator_type& __a = allocator_type())
 133     : _M_t(__comp, __a) { }
 134
 135   template <class _InputIterator>
 136   multimap(_InputIterator __first, _InputIterator __last)
 137     : _M_t(_Compare(), allocator_type())
 138     { _M_t.insert_equal(__first, __last); }
 139
 140   template <class _InputIterator>
 141   multimap(_InputIterator __first, _InputIterator __last,
 142            const _Compare& __comp,
 143            const allocator_type& __a = allocator_type())
 144     : _M_t(__comp, __a) { _M_t.insert_equal(__first, __last); }
 145   multimap(const multimap<_Key,_Tp,_Compare,_Alloc>& __x) : _M_t(__x._M_t) { }
 146
 147   multimap<_Key,_Tp,_Compare,_Alloc>&
 148   operator=(const multimap<_Key,_Tp,_Compare,_Alloc>& __x) {
 149     _M_t = __x._M_t;
 150     return *this;
 151   }
 152
 153   // accessors:
 154
 155   key_compare key_comp() const { return _M_t.key_comp(); }
 156   value_compare value_comp() const { return value_compare(_M_t.key_comp()); }
 157   allocator_type get_allocator() const { return _M_t.get_allocator(); }
 158
 159   iterator begin() { return _M_t.begin(); }
 160   const_iterator begin() const { return _M_t.begin(); }
 161   iterator end() { return _M_t.end(); }
 162   const_iterator end() const { return _M_t.end(); }
 163   reverse_iterator rbegin() { return _M_t.rbegin(); }
 164   const_reverse_iterator rbegin() const { return _M_t.rbegin(); }
 165   reverse_iterator rend() { return _M_t.rend(); }
 166   const_reverse_iterator rend() const { return _M_t.rend(); }
 167   bool empty() const { return _M_t.empty(); }
 168   size_type size() const { return _M_t.size(); }
 169   size_type max_size() const { return _M_t.max_size(); }
 170   void swap(multimap<_Key,_Tp,_Compare,_Alloc>& __x) { _M_t.swap(__x._M_t); }
 171
 172   // insert/erase
 173
 174   iterator insert(const value_type& __x) { return _M_t.insert_equal(__x); }
 175   iterator insert(iterator __position, const value_type& __x) {
 176     return _M_t.insert_equal(__position, __x);
 177   }
 178   template <class _InputIterator>
 179   void insert(_InputIterator __first, _InputIterator __last) {
 180     _M_t.insert_equal(__first, __last);
 181   }
 182   void erase(iterator __position) { _M_t.erase(__position); }
 183   size_type erase(const key_type& __x) { return _M_t.erase(__x); }
 184   void erase(iterator __first, iterator __last)
 185     { _M_t.erase(__first, __last); }
 186   void clear() { _M_t.clear(); }
 187
 188   // multimap operations:
 189
 190   iterator find(const key_type& __x) { return _M_t.find(__x); }
 191   const_iterator find(const key_type& __x) const { return _M_t.find(__x); }
 192   size_type count(const key_type& __x) const { return _M_t.count(__x); }
 193   iterator lower_bound(const key_type& __x) {return _M_t.lower_bound(__x); }
 194   const_iterator lower_bound(const key_type& __x) const {
 195     return _M_t.lower_bound(__x);
 196   }
 197   iterator upper_bound(const key_type& __x) {return _M_t.upper_bound(__x); }
 198   const_iterator upper_bound(const key_type& __x) const {
 199     return _M_t.upper_bound(__x);
 200   }
 201    pair<iterator,iterator> equal_range(const key_type& __x) {
 202     return _M_t.equal_range(__x);
 203   }
 204   pair<const_iterator,const_iterator> equal_range(const key_type& __x) const {
 205     return _M_t.equal_range(__x);
 206   }
 207
 208   template <class _K1, class _T1, class _C1, class _A1>
 209   friend bool operator== (const multimap<_K1, _T1, _C1, _A1>&,
 210                           const multimap<_K1, _T1, _C1, _A1>&);
 211   template <class _K1, class _T1, class _C1, class _A1>
 212   friend bool operator< (const multimap<_K1, _T1, _C1, _A1>&,
 213                          const multimap<_K1, _T1, _C1, _A1>&);
 214 };
 215
 216 template <class _Key, class _Tp, class _Compare, class _Alloc>
 217 inline bool operator==(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 218                        const multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 219   return __x._M_t == __y._M_t;
 220 }
 221
 222 template <class _Key, class _Tp, class _Compare, class _Alloc>
 223 inline bool operator<(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 224                       const multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 225   return __x._M_t < __y._M_t;
 226 }
 227
 228 template <class _Key, class _Tp, class _Compare, class _Alloc>
 229 inline bool operator!=(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 230                        const multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 231   return !(__x == __y);
 232 }
 233
 234 template <class _Key, class _Tp, class _Compare, class _Alloc>
 235 inline bool operator>(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 236                       const multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 237   return __y < __x;
 238 }
 239
 240 template <class _Key, class _Tp, class _Compare, class _Alloc>
 241 inline bool operator<=(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 242                        const multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 243   return !(__y < __x);
 244 }
 245
 246 template <class _Key, class _Tp, class _Compare, class _Alloc>
 247 inline bool operator>=(const multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 248                        const multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 249   return !(__x < __y);
 250 }
 251
 252 template <class _Key, class _Tp, class _Compare, class _Alloc>
 253 inline void swap(multimap<_Key,_Tp,_Compare,_Alloc>& __x,
 254                  multimap<_Key,_Tp,_Compare,_Alloc>& __y) {
 255   __x.swap(__y);
 256 }
 257
 258 } // namespace std
 259
 260 #endif /* __SGI_STL_INTERNAL_MULTIMAP_H */
 261
 262 // Local Variables:
 263 // mode:C++
 264 // End: