libstdc++-v3/include/debug/multiset.h

   1 // Debugging multiset implementation -*- C++ -*-
   2
   3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 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 /** @file debug/multiset.h
  27  *  This file is a GNU debug extension to the Standard C++ Library.
  28  */
  29
  30 #ifndef _GLIBCXX_DEBUG_MULTISET_H
  31 #define _GLIBCXX_DEBUG_MULTISET_H 1
  32
  33 #include <debug/safe_sequence.h>
  34 #include <debug/safe_iterator.h>
  35 #include <utility>
  36
  37 namespace std
  38 {
  39 namespace __debug
  40 {
  41   /// Class std::multiset with safety/checking/debug instrumentation.
  42   template<typename _Key, typename _Compare = std::less<_Key>,
  43            typename _Allocator = std::allocator<_Key> >
  44     class multiset
  45     : public _GLIBCXX_STD_D::multiset<_Key, _Compare, _Allocator>,
  46       public __gnu_debug::_Safe_sequence<multiset<_Key, _Compare, _Allocator> >
  47     {
  48       typedef _GLIBCXX_STD_D::multiset<_Key, _Compare, _Allocator> _Base;
  49       typedef __gnu_debug::_Safe_sequence<multiset> _Safe_base;
  50
  51     public:
  52       // types:
  53       typedef _Key                                   key_type;
  54       typedef _Key                                   value_type;
  55       typedef _Compare                               key_compare;
  56       typedef _Compare                               value_compare;
  57       typedef _Allocator                             allocator_type;
  58       typedef typename _Base::reference              reference;
  59       typedef typename _Base::const_reference        const_reference;
  60
  61       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator, multiset>
  62       iterator;
  63       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,
  64                                           multiset> const_iterator;
  65
  66       typedef typename _Base::size_type              size_type;
  67       typedef typename _Base::difference_type        difference_type;
  68       typedef typename _Base::pointer                pointer;
  69       typedef typename _Base::const_pointer          const_pointer;
  70       typedef std::reverse_iterator<iterator>        reverse_iterator;
  71       typedef std::reverse_iterator<const_iterator>  const_reverse_iterator;
  72
  73       // 23.3.3.1 construct/copy/destroy:
  74       explicit multiset(const _Compare& __comp = _Compare(),
  75                         const _Allocator& __a = _Allocator())
  76       : _Base(__comp, __a) { }
  77
  78       template<typename _InputIterator>
  79         multiset(_InputIterator __first, _InputIterator __last,
  80                  const _Compare& __comp = _Compare(),
  81                  const _Allocator& __a = _Allocator())
  82         : _Base(__gnu_debug::__check_valid_range(__first, __last), __last,
  83                 __comp, __a) { }
  84
  85       multiset(const multiset& __x)
  86       : _Base(__x), _Safe_base() { }
  87
  88       multiset(const _Base& __x)
  89       : _Base(__x), _Safe_base() { }
  90
  91 #ifdef __GXX_EXPERIMENTAL_CXX0X__
  92       multiset(multiset&& __x)
  93       : _Base(std::forward<multiset>(__x)), _Safe_base()
  94       { this->_M_swap(__x); }
  95
  96       multiset(initializer_list<value_type> __l,
  97                const _Compare& __comp = _Compare(),
  98                const allocator_type& __a = allocator_type())
  99       : _Base(__l, __comp, __a), _Safe_base() { }
 100 #endif
 101
 102       ~multiset() { }
 103
 104       multiset&
 105       operator=(const multiset& __x)
 106       {
 107         *static_cast<_Base*>(this) = __x;
 108         this->_M_invalidate_all();
 109         return *this;
 110       }
 111
 112 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 113       multiset&
 114       operator=(multiset&& __x)
 115       {
 116         // NB: DR 675.
 117         clear();
 118         swap(__x);
 119         return *this;
 120       }
 121
 122       multiset&
 123       operator=(initializer_list<value_type> __l)
 124       {
 125         this->clear();
 126         this->insert(__l);
 127         return *this;
 128       }
 129 #endif
 130
 131       using _Base::get_allocator;
 132
 133       // iterators:
 134       iterator
 135       begin()
 136       { return iterator(_Base::begin(), this); }
 137
 138       const_iterator
 139       begin() const
 140       { return const_iterator(_Base::begin(), this); }
 141
 142       iterator
 143       end()
 144       { return iterator(_Base::end(), this); }
 145
 146       const_iterator
 147       end() const
 148       { return const_iterator(_Base::end(), this); }
 149
 150       reverse_iterator
 151       rbegin()
 152       { return reverse_iterator(end()); }
 153
 154       const_reverse_iterator
 155       rbegin() const
 156       { return const_reverse_iterator(end()); }
 157
 158       reverse_iterator
 159       rend()
 160       { return reverse_iterator(begin()); }
 161
 162       const_reverse_iterator
 163       rend() const
 164       { return const_reverse_iterator(begin()); }
 165
 166 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 167       const_iterator
 168       cbegin() const
 169       { return const_iterator(_Base::begin(), this); }
 170
 171       const_iterator
 172       cend() const
 173       { return const_iterator(_Base::end(), this); }
 174
 175       const_reverse_iterator
 176       crbegin() const
 177       { return const_reverse_iterator(end()); }
 178
 179       const_reverse_iterator
 180       crend() const
 181       { return const_reverse_iterator(begin()); }
 182 #endif
 183
 184       // capacity:
 185       using _Base::empty;
 186       using _Base::size;
 187       using _Base::max_size;
 188
 189       // modifiers:
 190       iterator
 191       insert(const value_type& __x)
 192       { return iterator(_Base::insert(__x), this); }
 193
 194       iterator
 195       insert(iterator __position, const value_type& __x)
 196       {
 197         __glibcxx_check_insert(__position);
 198         return iterator(_Base::insert(__position.base(), __x), this);
 199       }
 200
 201       template<typename _InputIterator>
 202       void
 203       insert(_InputIterator __first, _InputIterator __last)
 204       {
 205         __glibcxx_check_valid_range(__first, __last);
 206         _Base::insert(__first, __last);
 207       }
 208
 209 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 210       void
 211       insert(initializer_list<value_type> __l)
 212       { _Base::insert(__l); }
 213 #endif
 214
 215       void
 216       erase(iterator __position)
 217       {
 218         __glibcxx_check_erase(__position);
 219         __position._M_invalidate();
 220         _Base::erase(__position.base());
 221       }
 222
 223       size_type
 224       erase(const key_type& __x)
 225       {
 226         std::pair<iterator, iterator> __victims = this->equal_range(__x);
 227         size_type __count = 0;
 228         while (__victims.first != __victims.second)
 229         {
 230           iterator __victim = __victims.first++;
 231           __victim._M_invalidate();
 232           _Base::erase(__victim.base());
 233           ++__count;
 234         }
 235         return __count;
 236       }
 237
 238       void
 239       erase(iterator __first, iterator __last)
 240       {
 241         // _GLIBCXX_RESOLVE_LIB_DEFECTS
 242         // 151. can't currently clear() empty container
 243         __glibcxx_check_erase_range(__first, __last);
 244         while (__first != __last)
 245         this->erase(__first++);
 246       }
 247
 248       void
 249       swap(multiset& __x)
 250       {
 251         _Base::swap(__x);
 252         this->_M_swap(__x);
 253       }
 254
 255       void
 256       clear()
 257       { this->erase(begin(), end()); }
 258
 259       // observers:
 260       using _Base::key_comp;
 261       using _Base::value_comp;
 262
 263       // multiset operations:
 264       iterator
 265       find(const key_type& __x)
 266       { return iterator(_Base::find(__x), this); }
 267
 268       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 269       // 214. set::find() missing const overload
 270       const_iterator
 271       find(const key_type& __x) const
 272       { return const_iterator(_Base::find(__x), this); }
 273
 274       using _Base::count;
 275
 276       iterator
 277       lower_bound(const key_type& __x)
 278       { return iterator(_Base::lower_bound(__x), this); }
 279
 280       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 281       // 214. set::find() missing const overload
 282       const_iterator
 283       lower_bound(const key_type& __x) const
 284       { return const_iterator(_Base::lower_bound(__x), this); }
 285
 286       iterator
 287       upper_bound(const key_type& __x)
 288       { return iterator(_Base::upper_bound(__x), this); }
 289
 290       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 291       // 214. set::find() missing const overload
 292       const_iterator
 293       upper_bound(const key_type& __x) const
 294       { return const_iterator(_Base::upper_bound(__x), this); }
 295
 296       std::pair<iterator,iterator>
 297       equal_range(const key_type& __x)
 298       {
 299         typedef typename _Base::iterator _Base_iterator;
 300         std::pair<_Base_iterator, _Base_iterator> __res =
 301         _Base::equal_range(__x);
 302         return std::make_pair(iterator(__res.first, this),
 303                               iterator(__res.second, this));
 304       }
 305
 306       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 307       // 214. set::find() missing const overload
 308       std::pair<const_iterator,const_iterator>
 309       equal_range(const key_type& __x) const
 310       {
 311         typedef typename _Base::const_iterator _Base_iterator;
 312         std::pair<_Base_iterator, _Base_iterator> __res =
 313         _Base::equal_range(__x);
 314         return std::make_pair(const_iterator(__res.first, this),
 315                               const_iterator(__res.second, this));
 316       }
 317
 318       _Base&
 319       _M_base() { return *this; }
 320
 321       const _Base&
 322       _M_base() const { return *this; }
 323
 324     private:
 325       void
 326       _M_invalidate_all()
 327       {
 328         typedef typename _Base::const_iterator _Base_const_iterator;
 329         typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
 330         this->_M_invalidate_if(_Not_equal(_M_base().end()));
 331       }
 332     };
 333
 334   template<typename _Key, typename _Compare, typename _Allocator>
 335     inline bool
 336     operator==(const multiset<_Key, _Compare, _Allocator>& __lhs,
 337                const multiset<_Key, _Compare, _Allocator>& __rhs)
 338     { return __lhs._M_base() == __rhs._M_base(); }
 339
 340   template<typename _Key, typename _Compare, typename _Allocator>
 341     inline bool
 342     operator!=(const multiset<_Key, _Compare, _Allocator>& __lhs,
 343                const multiset<_Key, _Compare, _Allocator>& __rhs)
 344     { return __lhs._M_base() != __rhs._M_base(); }
 345
 346   template<typename _Key, typename _Compare, typename _Allocator>
 347     inline bool
 348     operator<(const multiset<_Key, _Compare, _Allocator>& __lhs,
 349               const multiset<_Key, _Compare, _Allocator>& __rhs)
 350     { return __lhs._M_base() < __rhs._M_base(); }
 351
 352   template<typename _Key, typename _Compare, typename _Allocator>
 353     inline bool
 354     operator<=(const multiset<_Key, _Compare, _Allocator>& __lhs,
 355                const multiset<_Key, _Compare, _Allocator>& __rhs)
 356     { return __lhs._M_base() <= __rhs._M_base(); }
 357
 358   template<typename _Key, typename _Compare, typename _Allocator>
 359     inline bool
 360     operator>=(const multiset<_Key, _Compare, _Allocator>& __lhs,
 361                const multiset<_Key, _Compare, _Allocator>& __rhs)
 362     { return __lhs._M_base() >= __rhs._M_base(); }
 363
 364   template<typename _Key, typename _Compare, typename _Allocator>
 365     inline bool
 366     operator>(const multiset<_Key, _Compare, _Allocator>& __lhs,
 367               const multiset<_Key, _Compare, _Allocator>& __rhs)
 368     { return __lhs._M_base() > __rhs._M_base(); }
 369
 370   template<typename _Key, typename _Compare, typename _Allocator>
 371     void
 372     swap(multiset<_Key, _Compare, _Allocator>& __x,
 373          multiset<_Key, _Compare, _Allocator>& __y)
 374     { return __x.swap(__y); }
 375
 376 } // namespace __debug
 377 } // namespace std
 378
 379 #endif