libstdc++-v3/include/debug/unordered_set

   1 // Debugging unordered_set/unordered_multiset implementation -*- C++ -*-
   2
   3 // Copyright (C) 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 /** @file debug/unordered_set
  27  *  This file is a GNU debug extension to the Standard C++ Library.
  28  */
  29
  30 #ifndef _GLIBCXX_DEBUG_UNORDERED_SET
  31 #define _GLIBCXX_DEBUG_UNORDERED_SET 1
  32
  33 #ifdef __GXX_EXPERIMENTAL_CXX0X__
  34 # include <unordered_set>
  35 #else
  36 # include <c++0x_warning.h>
  37 #endif
  38
  39 #include <debug/safe_sequence.h>
  40 #include <debug/safe_iterator.h>
  41 #include <initializer_list>
  42
  43 namespace std
  44 {
  45 namespace __debug
  46 {
  47   template<typename _Value,
  48            typename _Hash = std::hash<_Value>,
  49            typename _Pred = std::equal_to<_Value>,
  50            typename _Alloc = std::allocator<_Value> >
  51     class unordered_set
  52     : public _GLIBCXX_STD_D::unordered_set<_Value, _Hash, _Pred, _Alloc>,
  53       public __gnu_debug::_Safe_sequence<unordered_set<_Value, _Hash,
  54                                                        _Pred, _Alloc> >
  55     {
  56       typedef _GLIBCXX_STD_D::unordered_set<_Value, _Hash,
  57                                             _Pred, _Alloc> _Base;
  58       typedef __gnu_debug::_Safe_sequence<unordered_set> _Safe_base;
  59
  60     public:
  61       typedef typename _Base::size_type       size_type;
  62       typedef typename _Base::hasher          hasher;
  63       typedef typename _Base::key_equal       key_equal;
  64       typedef typename _Base::allocator_type  allocator_type;
  65
  66       typedef typename _Base::key_type        key_type;
  67       typedef typename _Base::value_type      value_type;
  68
  69       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator,
  70                                           unordered_set> iterator;
  71       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,
  72                                           unordered_set> const_iterator;
  73
  74       explicit
  75       unordered_set(size_type __n = 10,
  76                     const hasher& __hf = hasher(),
  77                     const key_equal& __eql = key_equal(),
  78                     const allocator_type& __a = allocator_type())
  79       : _Base(__n, __hf, __eql, __a) { }
  80
  81       template<typename _InputIterator>
  82         unordered_set(_InputIterator __f, _InputIterator __l,
  83                       size_type __n = 10,
  84                       const hasher& __hf = hasher(),
  85                       const key_equal& __eql = key_equal(),
  86                       const allocator_type& __a = allocator_type())
  87         : _Base(__gnu_debug::__check_valid_range(__f, __l), __l, __n,
  88                 __hf, __eql, __a), _Safe_base() { }
  89
  90       unordered_set(const unordered_set& __x)
  91       : _Base(__x), _Safe_base() { }
  92
  93       unordered_set(const _Base& __x)
  94       : _Base(__x), _Safe_base() { }
  95
  96       unordered_set(unordered_set&& __x)
  97       : _Base(std::forward<unordered_set>(__x)), _Safe_base() { }
  98
  99       unordered_set(initializer_list<value_type> __l,
 100                     size_type __n = 10,
 101                     const hasher& __hf = hasher(),
 102                     const key_equal& __eql = key_equal(),
 103                     const allocator_type& __a = allocator_type())
 104       : _Base(__l, __n, __hf, __eql, __a), _Safe_base() { }
 105
 106       unordered_set&
 107       operator=(const unordered_set& __x)
 108       {
 109         *static_cast<_Base*>(this) = __x;
 110         this->_M_invalidate_all();
 111         return *this;
 112       }
 113
 114       unordered_set&
 115       operator=(unordered_set&& __x)
 116       {
 117         // NB: DR 675.
 118         clear();
 119         swap(__x);
 120         return *this;
 121       }
 122
 123       unordered_set&
 124       operator=(initializer_list<value_type> __l)
 125       {
 126         this->clear();
 127         this->insert(__l);
 128         return *this;
 129       }
 130
 131       void
 132       swap(unordered_set& __x)
 133       {
 134         _Base::swap(__x);
 135         _Safe_base::_M_swap(__x);
 136       }
 137
 138       void
 139       clear()
 140       {
 141         _Base::clear();
 142         this->_M_invalidate_all();
 143       }
 144
 145       iterator
 146       begin()
 147       { return iterator(_Base::begin(), this); }
 148
 149       const_iterator
 150       begin() const
 151       { return const_iterator(_Base::begin(), this); }
 152
 153       iterator
 154       end()
 155       { return iterator(_Base::end(), this); }
 156
 157       const_iterator
 158       end() const
 159       { return const_iterator(_Base::end(), this); }
 160
 161       const_iterator
 162       cbegin() const
 163       { return const_iterator(_Base::begin(), this); }
 164
 165       const_iterator
 166       cend() const
 167       { return const_iterator(_Base::end(), this); }
 168
 169       // local versions
 170       using _Base::begin;
 171       using _Base::end;
 172       using _Base::cbegin;
 173       using _Base::cend;
 174
 175       std::pair<iterator, bool>
 176       insert(const value_type& __obj)
 177       {
 178         typedef std::pair<typename _Base::iterator, bool> __pair_type;
 179         __pair_type __res = _Base::insert(__obj);
 180         return std::make_pair(iterator(__res.first, this), __res.second);
 181       }
 182
 183       iterator
 184       insert(iterator, const value_type& __obj)
 185       {
 186         typedef std::pair<typename _Base::iterator, bool> __pair_type;
 187         __pair_type __res = _Base::insert(__obj);
 188         return iterator(__res.first, this);
 189       }
 190
 191       const_iterator
 192       insert(const_iterator, const value_type& __obj)
 193       {
 194         typedef std::pair<typename _Base::iterator, bool> __pair_type;
 195         __pair_type __res = _Base::insert(__obj);
 196         return const_iterator(__res.first, this);
 197       }
 198
 199       void
 200       insert(std::initializer_list<value_type> __l)
 201       { _Base::insert(__l); }
 202
 203       template<typename _InputIterator>
 204         void
 205         insert(_InputIterator __first, _InputIterator __last)
 206         {
 207           __glibcxx_check_valid_range(__first, __last);
 208           _Base::insert(__first, __last);
 209         }
 210
 211       iterator
 212       find(const key_type& __key)
 213       { return iterator(_Base::find(__key), this); }
 214
 215       const_iterator
 216       find(const key_type& __key) const
 217       { return const_iterator(_Base::find(__key), this); }
 218
 219       std::pair<iterator, iterator>
 220       equal_range(const key_type& __key)
 221       {
 222         typedef typename _Base::iterator _Base_iterator;
 223         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 224         __pair_type __res = _Base::equal_range(__key);
 225         return std::make_pair(iterator(__res.first, this),
 226                               iterator(__res.second, this));
 227       }
 228
 229       std::pair<const_iterator, const_iterator>
 230       equal_range(const key_type& __key) const
 231       {
 232         typedef typename _Base::const_iterator _Base_iterator;
 233         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 234         __pair_type __res = _Base::equal_range(__key);
 235         return std::make_pair(const_iterator(__res.first, this),
 236                               const_iterator(__res.second, this));
 237       }
 238
 239       size_type
 240       erase(const key_type& __key)
 241       {
 242         size_type __ret(0);
 243         iterator __victim(_Base::find(__key), this);
 244         if (__victim != end())
 245           {
 246             this->erase(__victim);
 247             __ret = 1;
 248           }
 249         return __ret;
 250       }
 251
 252       iterator
 253       erase(iterator __it)
 254       {
 255         __glibcxx_check_erase(__it);
 256         __it._M_invalidate();
 257         return iterator(_Base::erase(__it.base()), this);
 258       }
 259
 260       const_iterator
 261       erase(const_iterator __it)
 262       {
 263         __glibcxx_check_erase(__it);
 264         __it._M_invalidate();
 265         return const_iterator(_Base::erase(__it.base()), this);
 266       }
 267
 268       iterator
 269       erase(iterator __first, iterator __last)
 270       {
 271         __glibcxx_check_erase_range(__first, __last);
 272         for (iterator __tmp = __first; __tmp != __last;)
 273         {
 274           iterator __victim = __tmp++;
 275           __victim._M_invalidate();
 276         }
 277         return iterator(_Base::erase(__first.base(),
 278                                      __last.base()), this);
 279       }
 280
 281       const_iterator
 282       erase(const_iterator __first, const_iterator __last)
 283       {
 284         __glibcxx_check_erase_range(__first, __last);
 285         for (const_iterator __tmp = __first; __tmp != __last;)
 286         {
 287           const_iterator __victim = __tmp++;
 288           __victim._M_invalidate();
 289         }
 290         return const_iterator(_Base::erase(__first.base(),
 291                                            __last.base()), this);
 292       }
 293
 294       _Base&
 295       _M_base() { return *this; }
 296
 297       const _Base&
 298       _M_base() const { return *this; }
 299
 300     private:
 301       void
 302       _M_invalidate_all()
 303       {
 304         typedef typename _Base::const_iterator _Base_const_iterator;
 305         typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
 306         this->_M_invalidate_if(_Not_equal(_M_base().end()));
 307       }
 308     };
 309
 310   template<typename _Value, typename _Hash, typename _Pred, typename _Alloc>
 311     inline void
 312     swap(unordered_set<_Value, _Hash, _Pred, _Alloc>& __x,
 313          unordered_set<_Value, _Hash, _Pred, _Alloc>& __y)
 314     { __x.swap(__y); }
 315
 316
 317   template<typename _Value,
 318            typename _Hash = std::hash<_Value>,
 319            typename _Pred = std::equal_to<_Value>,
 320            typename _Alloc = std::allocator<_Value> >
 321     class unordered_multiset
 322     : public _GLIBCXX_STD_D::unordered_multiset<_Value, _Hash, _Pred, _Alloc>,
 323       public __gnu_debug::_Safe_sequence<unordered_multiset<_Value, _Hash,
 324                                                             _Pred, _Alloc> >
 325     {
 326       typedef _GLIBCXX_STD_D::unordered_multiset<_Value, _Hash,
 327                                                  _Pred, _Alloc> _Base;
 328       typedef __gnu_debug::_Safe_sequence<unordered_multiset> _Safe_base;
 329
 330     public:
 331       typedef typename _Base::size_type       size_type;
 332       typedef typename _Base::hasher          hasher;
 333       typedef typename _Base::key_equal       key_equal;
 334       typedef typename _Base::allocator_type  allocator_type;
 335
 336       typedef typename _Base::key_type        key_type;
 337       typedef typename _Base::value_type      value_type;
 338
 339       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator,
 340                                           unordered_multiset> iterator;
 341       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,
 342                                           unordered_multiset> const_iterator;
 343
 344       explicit
 345       unordered_multiset(size_type __n = 10,
 346                          const hasher& __hf = hasher(),
 347                          const key_equal& __eql = key_equal(),
 348                          const allocator_type& __a = allocator_type())
 349       : _Base(__n, __hf, __eql, __a) { }
 350
 351       template<typename _InputIterator>
 352         unordered_multiset(_InputIterator __f, _InputIterator __l,
 353                            size_type __n = 10,
 354                            const hasher& __hf = hasher(),
 355                            const key_equal& __eql = key_equal(),
 356                            const allocator_type& __a = allocator_type())
 357         : _Base(__gnu_debug::__check_valid_range(__f, __l), __l, __n,
 358                 __hf, __eql, __a), _Safe_base() { }
 359
 360       unordered_multiset(const unordered_multiset& __x)
 361       : _Base(__x), _Safe_base() { }
 362
 363       unordered_multiset(const _Base& __x)
 364       : _Base(__x), _Safe_base() { }
 365
 366       unordered_multiset(unordered_multiset&& __x)
 367       : _Base(std::forward<unordered_multiset>(__x)), _Safe_base() { }
 368
 369       unordered_multiset(initializer_list<value_type> __l,
 370                          size_type __n = 10,
 371                          const hasher& __hf = hasher(),
 372                          const key_equal& __eql = key_equal(),
 373                          const allocator_type& __a = allocator_type())
 374       : _Base(__l, __n, __hf, __eql, __a), _Safe_base() { }
 375
 376       unordered_multiset&
 377       operator=(const unordered_multiset& __x)
 378       {
 379         *static_cast<_Base*>(this) = __x;
 380         this->_M_invalidate_all();
 381         return *this;
 382       }
 383
 384       unordered_multiset&
 385       operator=(unordered_multiset&& __x)
 386       {
 387         // NB: DR 675.
 388         clear();
 389         swap(__x);
 390         return *this;
 391       }
 392
 393       unordered_multiset&
 394       operator=(initializer_list<value_type> __l)
 395       {
 396         this->clear();
 397         this->insert(__l);
 398         return *this;
 399       }
 400
 401       void
 402       swap(unordered_multiset& __x)
 403       {
 404         _Base::swap(__x);
 405         _Safe_base::_M_swap(__x);
 406       }
 407
 408       void
 409       clear()
 410       {
 411         _Base::clear();
 412         this->_M_invalidate_all();
 413       }
 414
 415       iterator
 416       begin()
 417       { return iterator(_Base::begin(), this); }
 418
 419       const_iterator
 420       begin() const
 421       { return const_iterator(_Base::begin(), this); }
 422
 423       iterator
 424       end()
 425       { return iterator(_Base::end(), this); }
 426
 427       const_iterator
 428       end() const
 429       { return const_iterator(_Base::end(), this); }
 430
 431       const_iterator
 432       cbegin() const
 433       { return const_iterator(_Base::begin(), this); }
 434
 435       const_iterator
 436       cend() const
 437       { return const_iterator(_Base::end(), this); }
 438
 439       // local versions
 440       using _Base::begin;
 441       using _Base::end;
 442       using _Base::cbegin;
 443       using _Base::cend;
 444
 445       iterator
 446       insert(const value_type& __obj)
 447       { return iterator(_Base::insert(__obj), this); }
 448
 449       iterator
 450       insert(iterator, const value_type& __obj)
 451       { return iterator(_Base::insert(__obj), this); }
 452
 453       const_iterator
 454       insert(const_iterator, const value_type& __obj)
 455       { return const_iterator(_Base::insert(__obj), this); }
 456
 457       void
 458       insert(std::initializer_list<value_type> __l)
 459       { _Base::insert(__l); }
 460
 461       template<typename _InputIterator>
 462         void
 463         insert(_InputIterator __first, _InputIterator __last)
 464         {
 465           __glibcxx_check_valid_range(__first, __last);
 466           _Base::insert(__first, __last);
 467         }
 468
 469       iterator
 470       find(const key_type& __key)
 471       { return iterator(_Base::find(__key), this); }
 472
 473       const_iterator
 474       find(const key_type& __key) const
 475       { return const_iterator(_Base::find(__key), this); }
 476
 477       std::pair<iterator, iterator>
 478       equal_range(const key_type& __key)
 479       {
 480         typedef typename _Base::iterator _Base_iterator;
 481         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 482         __pair_type __res = _Base::equal_range(__key);
 483         return std::make_pair(iterator(__res.first, this),
 484                               iterator(__res.second, this));
 485       }
 486
 487       std::pair<const_iterator, const_iterator>
 488       equal_range(const key_type& __key) const
 489       {
 490         typedef typename _Base::const_iterator _Base_iterator;
 491         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 492         __pair_type __res = _Base::equal_range(__key);
 493         return std::make_pair(const_iterator(__res.first, this),
 494                               const_iterator(__res.second, this));
 495       }
 496
 497       size_type
 498       erase(const key_type& __key)
 499       {
 500         size_type __ret(0);
 501         iterator __victim(_Base::find(__key), this);
 502         if (__victim != end())
 503           {
 504             this->erase(__victim);
 505             __ret = 1;
 506           }
 507         return __ret;
 508       }
 509
 510       iterator
 511       erase(iterator __it)
 512       {
 513         __glibcxx_check_erase(__it);
 514         __it._M_invalidate();
 515         return iterator(_Base::erase(__it.base()), this);
 516       }
 517
 518       const_iterator
 519       erase(const_iterator __it)
 520       {
 521         __glibcxx_check_erase(__it);
 522         __it._M_invalidate();
 523         return const_iterator(_Base::erase(__it.base()), this);
 524       }
 525
 526       iterator
 527       erase(iterator __first, iterator __last)
 528       {
 529         __glibcxx_check_erase_range(__first, __last);
 530         for (iterator __tmp = __first; __tmp != __last;)
 531         {
 532           iterator __victim = __tmp++;
 533           __victim._M_invalidate();
 534         }
 535         return iterator(_Base::erase(__first.base(),
 536                                      __last.base()), this);
 537       }
 538
 539       const_iterator
 540       erase(const_iterator __first, const_iterator __last)
 541       {
 542         __glibcxx_check_erase_range(__first, __last);
 543         for (const_iterator __tmp = __first; __tmp != __last;)
 544         {
 545           const_iterator __victim = __tmp++;
 546           __victim._M_invalidate();
 547         }
 548         return const_iterator(_Base::erase(__first.base(),
 549                                            __last.base()), this);
 550       }
 551
 552       _Base&
 553       _M_base() { return *this; }
 554
 555       const _Base&
 556       _M_base() const { return *this; }
 557
 558     private:
 559       void
 560       _M_invalidate_all()
 561       {
 562         typedef typename _Base::const_iterator _Base_const_iterator;
 563         typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
 564         this->_M_invalidate_if(_Not_equal(_M_base().end()));
 565       }
 566     };
 567
 568   template<typename _Value, typename _Hash, typename _Pred, typename _Alloc>
 569     inline void
 570     swap(unordered_multiset<_Value, _Hash, _Pred, _Alloc>& __x,
 571          unordered_multiset<_Value, _Hash, _Pred, _Alloc>& __y)
 572     { __x.swap(__y); }
 573
 574 } // namespace __debug
 575 } // namespace std
 576
 577 #endif