libstdc++-v3/include/profile/set.h

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