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

   1 // Multiset 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
  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_MULTISET_H
  61 #define __SGI_STL_INTERNAL_MULTISET_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 _Compare = less<_Key>,
  71           class _Alloc = allocator<_Key> >
  72 class multiset;
  73
  74 template <class _Key, class _Compare, class _Alloc>
  75 inline bool operator==(const multiset<_Key,_Compare,_Alloc>& __x,
  76                        const multiset<_Key,_Compare,_Alloc>& __y);
  77
  78 template <class _Key, class _Compare, class _Alloc>
  79 inline bool operator<(const multiset<_Key,_Compare,_Alloc>& __x,
  80                       const multiset<_Key,_Compare,_Alloc>& __y);
  81
  82 template <class _Key, class _Compare, class _Alloc>
  83 class multiset
  84 {
  85   // concept requirements
  86   __glibcpp_class_requires(_Key, _SGIAssignableConcept)
  87   __glibcpp_class_requires4(_Compare, bool, _Key, _Key, _BinaryFunctionConcept);
  88
  89 public:
  90
  91   // typedefs:
  92
  93   typedef _Key     key_type;
  94   typedef _Key     value_type;
  95   typedef _Compare key_compare;
  96   typedef _Compare value_compare;
  97 private:
  98   typedef _Rb_tree<key_type, value_type,
  99                   _Identity<value_type>, key_compare, _Alloc> _Rep_type;
 100   _Rep_type _M_t;  // red-black tree representing multiset
 101 public:
 102   typedef typename _Rep_type::const_pointer pointer;
 103   typedef typename _Rep_type::const_pointer const_pointer;
 104   typedef typename _Rep_type::const_reference reference;
 105   typedef typename _Rep_type::const_reference const_reference;
 106   typedef typename _Rep_type::const_iterator iterator;
 107   typedef typename _Rep_type::const_iterator const_iterator;
 108   typedef typename _Rep_type::const_reverse_iterator reverse_iterator;
 109   typedef typename _Rep_type::const_reverse_iterator const_reverse_iterator;
 110   typedef typename _Rep_type::size_type size_type;
 111   typedef typename _Rep_type::difference_type difference_type;
 112   typedef typename _Rep_type::allocator_type allocator_type;
 113
 114   // allocation/deallocation
 115
 116   multiset() : _M_t(_Compare(), allocator_type()) {}
 117   explicit multiset(const _Compare& __comp,
 118                     const allocator_type& __a = allocator_type())
 119     : _M_t(__comp, __a) {}
 120
 121   template <class _InputIterator>
 122   multiset(_InputIterator __first, _InputIterator __last)
 123     : _M_t(_Compare(), allocator_type())
 124     { _M_t.insert_equal(__first, __last); }
 125
 126   template <class _InputIterator>
 127   multiset(_InputIterator __first, _InputIterator __last,
 128            const _Compare& __comp,
 129            const allocator_type& __a = allocator_type())
 130     : _M_t(__comp, __a) { _M_t.insert_equal(__first, __last); }
 131
 132   multiset(const multiset<_Key,_Compare,_Alloc>& __x) : _M_t(__x._M_t) {}
 133
 134   multiset<_Key,_Compare,_Alloc>&
 135   operator=(const multiset<_Key,_Compare,_Alloc>& __x) {
 136     _M_t = __x._M_t;
 137     return *this;
 138   }
 139
 140   // accessors:
 141
 142   key_compare key_comp() const { return _M_t.key_comp(); }
 143   value_compare value_comp() const { return _M_t.key_comp(); }
 144   allocator_type get_allocator() const { return _M_t.get_allocator(); }
 145
 146   iterator begin() const { return _M_t.begin(); }
 147   iterator end() const { return _M_t.end(); }
 148   reverse_iterator rbegin() const { return _M_t.rbegin(); }
 149   reverse_iterator rend() const { return _M_t.rend(); }
 150   bool empty() const { return _M_t.empty(); }
 151   size_type size() const { return _M_t.size(); }
 152   size_type max_size() const { return _M_t.max_size(); }
 153   void swap(multiset<_Key,_Compare,_Alloc>& __x) { _M_t.swap(__x._M_t); }
 154
 155   // insert/erase
 156   iterator insert(const value_type& __x) {
 157     return _M_t.insert_equal(__x);
 158   }
 159   iterator insert(iterator __position, const value_type& __x) {
 160     typedef typename _Rep_type::iterator _Rep_iterator;
 161     return _M_t.insert_equal((_Rep_iterator&)__position, __x);
 162   }
 163
 164   template <class _InputIterator>
 165   void insert(_InputIterator __first, _InputIterator __last) {
 166     _M_t.insert_equal(__first, __last);
 167   }
 168   void erase(iterator __position) {
 169     typedef typename _Rep_type::iterator _Rep_iterator;
 170     _M_t.erase((_Rep_iterator&)__position);
 171   }
 172   size_type erase(const key_type& __x) {
 173     return _M_t.erase(__x);
 174   }
 175   void erase(iterator __first, iterator __last) {
 176     typedef typename _Rep_type::iterator _Rep_iterator;
 177     _M_t.erase((_Rep_iterator&)__first, (_Rep_iterator&)__last);
 178   }
 179   void clear() { _M_t.clear(); }
 180
 181   // multiset operations:
 182
 183   size_type count(const key_type& __x) const { return _M_t.count(__x); }
 184
 185 #ifdef _GLIBCPP_RESOLVE_LIB_DEFECTS
 186 //214.  set::find() missing const overload
 187   iterator find(const key_type& __x) { return _M_t.find(__x); }
 188   const_iterator find(const key_type& __x) const { return _M_t.find(__x); }
 189   iterator lower_bound(const key_type& __x) {
 190     return _M_t.lower_bound(__x);
 191   }
 192   const_iterator lower_bound(const key_type& __x) const {
 193     return _M_t.lower_bound(__x);
 194   }
 195   iterator upper_bound(const key_type& __x) {
 196     return _M_t.upper_bound(__x);
 197   }
 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 #else
 208   iterator find(const key_type& __x) const { return _M_t.find(__x); }
 209   iterator lower_bound(const key_type& __x) const {
 210     return _M_t.lower_bound(__x);
 211   }
 212   iterator upper_bound(const key_type& __x) const {
 213     return _M_t.upper_bound(__x);
 214   }
 215   pair<iterator,iterator> equal_range(const key_type& __x) const {
 216     return _M_t.equal_range(__x);
 217   }
 218 #endif
 219
 220   template <class _K1, class _C1, class _A1>
 221   friend bool operator== (const multiset<_K1,_C1,_A1>&,
 222                           const multiset<_K1,_C1,_A1>&);
 223   template <class _K1, class _C1, class _A1>
 224   friend bool operator< (const multiset<_K1,_C1,_A1>&,
 225                          const multiset<_K1,_C1,_A1>&);
 226 };
 227
 228 template <class _Key, class _Compare, class _Alloc>
 229 inline bool operator==(const multiset<_Key,_Compare,_Alloc>& __x,
 230                        const multiset<_Key,_Compare,_Alloc>& __y) {
 231   return __x._M_t == __y._M_t;
 232 }
 233
 234 template <class _Key, class _Compare, class _Alloc>
 235 inline bool operator<(const multiset<_Key,_Compare,_Alloc>& __x,
 236                       const multiset<_Key,_Compare,_Alloc>& __y) {
 237   return __x._M_t < __y._M_t;
 238 }
 239
 240 template <class _Key, class _Compare, class _Alloc>
 241 inline bool operator!=(const multiset<_Key,_Compare,_Alloc>& __x,
 242                        const multiset<_Key,_Compare,_Alloc>& __y) {
 243   return !(__x == __y);
 244 }
 245
 246 template <class _Key, class _Compare, class _Alloc>
 247 inline bool operator>(const multiset<_Key,_Compare,_Alloc>& __x,
 248                       const multiset<_Key,_Compare,_Alloc>& __y) {
 249   return __y < __x;
 250 }
 251
 252 template <class _Key, class _Compare, class _Alloc>
 253 inline bool operator<=(const multiset<_Key,_Compare,_Alloc>& __x,
 254                        const multiset<_Key,_Compare,_Alloc>& __y) {
 255   return !(__y < __x);
 256 }
 257
 258 template <class _Key, class _Compare, class _Alloc>
 259 inline bool operator>=(const multiset<_Key,_Compare,_Alloc>& __x,
 260                        const multiset<_Key,_Compare,_Alloc>& __y) {
 261   return !(__x < __y);
 262 }
 263
 264 template <class _Key, class _Compare, class _Alloc>
 265 inline void swap(multiset<_Key,_Compare,_Alloc>& __x,
 266                  multiset<_Key,_Compare,_Alloc>& __y) {
 267   __x.swap(__y);
 268 }
 269
 270 } // namespace std
 271
 272 #endif /* __SGI_STL_INTERNAL_MULTISET_H */
 273
 274 // Local Variables:
 275 // mode:C++
 276 // End: