libstdc++
profile/set.h
Go to the documentation of this file.
00001 // Profiling set implementation -*- C++ -*-
00002 
00003 // Copyright (C) 2009, 2010 Free Software Foundation, Inc.
00004 //
00005 // This file is part of the GNU ISO C++ Library.  This library is free
00006 // software; you can redistribute it and/or modify it under the
00007 // terms of the GNU General Public License as published by the
00008 // Free Software Foundation; either version 3, or (at your option)
00009 // any later version.
00010 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014 // GNU General Public License for more details.
00015 
00016 // Under Section 7 of GPL version 3, you are granted additional
00017 // permissions described in the GCC Runtime Library Exception, version
00018 // 3.1, as published by the Free Software Foundation.
00019 
00020 // You should have received a copy of the GNU General Public License and
00021 // a copy of the GCC Runtime Library Exception along with this program;
00022 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
00023 // <http://www.gnu.org/licenses/>.
00024 
00025 /** @file profile/set.h
00026  *  This file is a GNU profile extension to the Standard C++ Library.
00027  */
00028 
00029 #ifndef _GLIBCXX_PROFILE_SET_H
00030 #define _GLIBCXX_PROFILE_SET_H 1
00031 
00032 #include <utility>
00033 
00034 namespace std _GLIBCXX_VISIBILITY(default) 
00035 {
00036 namespace __profile
00037 {
00038   /// Class std::set wrapper with performance instrumentation.
00039   template<typename _Key, typename _Compare = std::less<_Key>,
00040        typename _Allocator = std::allocator<_Key> >
00041     class set
00042     : public _GLIBCXX_STD_C::set<_Key,_Compare,_Allocator>
00043     {
00044       typedef _GLIBCXX_STD_C::set<_Key, _Compare, _Allocator> _Base;
00045 
00046     public:
00047       // types:
00048       typedef _Key                  key_type;
00049       typedef _Key                  value_type;
00050       typedef _Compare                  key_compare;
00051       typedef _Compare                  value_compare;
00052       typedef _Allocator                allocator_type;
00053       typedef typename _Base::reference             reference;
00054       typedef typename _Base::const_reference       const_reference;
00055 
00056       typedef typename _Base::iterator               iterator;
00057       typedef typename _Base::const_iterator         const_iterator;
00058       typedef typename _Base::reverse_iterator       reverse_iterator;
00059       typedef typename _Base::const_reverse_iterator const_reverse_iterator;
00060 
00061       typedef typename _Base::size_type             size_type;
00062       typedef typename _Base::difference_type       difference_type;
00063       typedef typename _Base::pointer               pointer;
00064       typedef typename _Base::const_pointer         const_pointer;
00065 
00066       // 23.3.3.1 construct/copy/destroy:
00067       explicit set(const _Compare& __comp = _Compare(),
00068            const _Allocator& __a = _Allocator())
00069       : _Base(__comp, __a) { }
00070 
00071       template<typename _InputIterator>
00072         set(_InputIterator __first, _InputIterator __last,
00073         const _Compare& __comp = _Compare(),
00074         const _Allocator& __a = _Allocator())
00075     : _Base(__first, __last, __comp, __a) { }
00076 
00077       set(const set& __x)
00078       : _Base(__x) { }
00079 
00080       set(const _Base& __x)
00081       : _Base(__x) { }
00082 
00083 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00084       set(set&& __x)
00085       : _Base(std::move(__x))
00086       { }
00087 
00088       set(initializer_list<value_type> __l,
00089       const _Compare& __comp = _Compare(),
00090       const allocator_type& __a = allocator_type())
00091       : _Base(__l, __comp, __a) { }
00092 #endif
00093 
00094       ~set() { }
00095 
00096       set&
00097       operator=(const set& __x)
00098       {
00099     *static_cast<_Base*>(this) = __x;
00100     return *this;
00101       }
00102 
00103 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00104       set&
00105       operator=(set&& __x)
00106       {
00107     // NB: DR 1204.
00108     // NB: DR 675.
00109     this->clear();
00110     this->swap(__x);
00111     return *this;
00112       }
00113 
00114       set&
00115       operator=(initializer_list<value_type> __l)
00116       {
00117     this->clear();
00118     this->insert(__l);
00119     return *this;
00120       }
00121 #endif
00122 
00123       using _Base::get_allocator;
00124 
00125       // iterators:
00126       iterator
00127       begin()
00128       { return iterator(_Base::begin()); }
00129 
00130       const_iterator
00131       begin() const
00132       { return const_iterator(_Base::begin()); }
00133 
00134       iterator
00135       end()
00136       { return iterator(_Base::end()); }
00137 
00138       const_iterator
00139       end() const
00140       { return const_iterator(_Base::end()); }
00141 
00142       reverse_iterator
00143       rbegin()
00144       { return reverse_iterator(end()); }
00145 
00146       const_reverse_iterator
00147       rbegin() const
00148       { return const_reverse_iterator(end()); }
00149 
00150       reverse_iterator
00151       rend()
00152       { return reverse_iterator(begin()); }
00153 
00154       const_reverse_iterator
00155       rend() const
00156       { return const_reverse_iterator(begin()); }
00157 
00158 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00159       const_iterator
00160       cbegin() const
00161       { return const_iterator(_Base::begin()); }
00162 
00163       const_iterator
00164       cend() const
00165       { return const_iterator(_Base::end()); }
00166 
00167       const_reverse_iterator
00168       crbegin() const
00169       { return const_reverse_iterator(end()); }
00170 
00171       const_reverse_iterator
00172       crend() const
00173       { return const_reverse_iterator(begin()); }
00174 #endif
00175 
00176       // capacity:
00177       using _Base::empty;
00178       using _Base::size;
00179       using _Base::max_size;
00180 
00181       // modifiers:
00182       std::pair<iterator, bool>
00183       insert(const value_type& __x)
00184       {
00185     typedef typename _Base::iterator _Base_iterator;
00186     std::pair<_Base_iterator, bool> __res = _Base::insert(__x);
00187     return std::pair<iterator, bool>(iterator(__res.first),
00188                      __res.second);
00189       }
00190 
00191 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00192       std::pair<iterator, bool>
00193       insert(value_type&& __x)
00194       {
00195     typedef typename _Base::iterator _Base_iterator;
00196     std::pair<_Base_iterator, bool> __res
00197       = _Base::insert(std::move(__x));
00198     return std::pair<iterator, bool>(iterator(__res.first),
00199                      __res.second);
00200       }
00201 #endif
00202 
00203       iterator
00204       insert(const_iterator __position, const value_type& __x)
00205       { return iterator(_Base::insert(__position, __x)); }
00206 
00207 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00208       iterator
00209       insert(const_iterator __position, value_type&& __x)
00210       { return iterator(_Base::insert(__position, std::move(__x))); }
00211 #endif
00212 
00213       template <typename _InputIterator>
00214         void
00215         insert(_InputIterator __first, _InputIterator __last)
00216         { _Base::insert(__first, __last); }
00217 
00218 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00219       void
00220       insert(initializer_list<value_type> __l)
00221       { _Base::insert(__l); }
00222 #endif
00223 
00224 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00225       iterator
00226       erase(const_iterator __position)
00227       { return iterator(_Base::erase(__position)); }
00228 #else
00229       void
00230       erase(iterator __position)
00231       { _Base::erase(__position); }
00232 #endif
00233 
00234       size_type
00235       erase(const key_type& __x)
00236       {
00237     iterator __victim = find(__x);
00238     if (__victim == end())
00239           return 0;
00240     else
00241         {
00242       _Base::erase(__victim);
00243       return 1;
00244         }
00245       }
00246 
00247 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00248       iterator
00249       erase(const_iterator __first, const_iterator __last)
00250       { return iterator(_Base::erase(__first, __last)); }
00251 #else
00252       void
00253       erase(iterator __first, iterator __last)
00254       { _Base::erase(__first, __last); }
00255 #endif
00256 
00257       void
00258       swap(set& __x)
00259       { _Base::swap(__x); }
00260 
00261       void
00262       clear()
00263       { this->erase(begin(), end()); }
00264 
00265       // observers:
00266       using _Base::key_comp;
00267       using _Base::value_comp;
00268 
00269       // set operations:
00270       iterator
00271       find(const key_type& __x)
00272       { return iterator(_Base::find(__x)); }
00273 
00274       // _GLIBCXX_RESOLVE_LIB_DEFECTS
00275       // 214. set::find() missing const overload
00276       const_iterator
00277       find(const key_type& __x) const
00278       { return const_iterator(_Base::find(__x)); }
00279 
00280       using _Base::count;
00281 
00282       iterator
00283       lower_bound(const key_type& __x)
00284       { return iterator(_Base::lower_bound(__x)); }
00285 
00286       // _GLIBCXX_RESOLVE_LIB_DEFECTS
00287       // 214. set::find() missing const overload
00288       const_iterator
00289       lower_bound(const key_type& __x) const
00290       { return const_iterator(_Base::lower_bound(__x)); }
00291 
00292       iterator
00293       upper_bound(const key_type& __x)
00294       { return iterator(_Base::upper_bound(__x)); }
00295 
00296       // _GLIBCXX_RESOLVE_LIB_DEFECTS
00297       // 214. set::find() missing const overload
00298       const_iterator
00299       upper_bound(const key_type& __x) const
00300       { return const_iterator(_Base::upper_bound(__x)); }
00301 
00302       std::pair<iterator,iterator>
00303       equal_range(const key_type& __x)
00304       {
00305     typedef typename _Base::iterator _Base_iterator;
00306     std::pair<_Base_iterator, _Base_iterator> __res =
00307         _Base::equal_range(__x);
00308     return std::make_pair(iterator(__res.first),
00309                   iterator(__res.second));
00310       }
00311 
00312       // _GLIBCXX_RESOLVE_LIB_DEFECTS
00313       // 214. set::find() missing const overload
00314       std::pair<const_iterator,const_iterator>
00315       equal_range(const key_type& __x) const
00316       {
00317     typedef typename _Base::const_iterator _Base_iterator;
00318     std::pair<_Base_iterator, _Base_iterator> __res =
00319         _Base::equal_range(__x);
00320     return std::make_pair(const_iterator(__res.first),
00321                   const_iterator(__res.second));
00322       }
00323 
00324       _Base&
00325       _M_base() { return *this; }
00326 
00327       const _Base&
00328       _M_base() const { return *this; }
00329 
00330     };
00331 
00332   template<typename _Key, typename _Compare, typename _Allocator>
00333     inline bool
00334     operator==(const set<_Key, _Compare, _Allocator>& __lhs,
00335            const set<_Key, _Compare, _Allocator>& __rhs)
00336     { return __lhs._M_base() == __rhs._M_base(); }
00337 
00338   template<typename _Key, typename _Compare, typename _Allocator>
00339     inline bool
00340     operator!=(const set<_Key, _Compare, _Allocator>& __lhs,
00341            const set<_Key, _Compare, _Allocator>& __rhs)
00342     { return __lhs._M_base() != __rhs._M_base(); }
00343 
00344   template<typename _Key, typename _Compare, typename _Allocator>
00345     inline bool
00346     operator<(const set<_Key, _Compare, _Allocator>& __lhs,
00347           const set<_Key, _Compare, _Allocator>& __rhs)
00348     { return __lhs._M_base() < __rhs._M_base(); }
00349 
00350   template<typename _Key, typename _Compare, typename _Allocator>
00351     inline bool
00352     operator<=(const set<_Key, _Compare, _Allocator>& __lhs,
00353            const set<_Key, _Compare, _Allocator>& __rhs)
00354     { return __lhs._M_base() <= __rhs._M_base(); }
00355 
00356   template<typename _Key, typename _Compare, typename _Allocator>
00357     inline bool
00358     operator>=(const set<_Key, _Compare, _Allocator>& __lhs,
00359            const set<_Key, _Compare, _Allocator>& __rhs)
00360     { return __lhs._M_base() >= __rhs._M_base(); }
00361 
00362   template<typename _Key, typename _Compare, typename _Allocator>
00363     inline bool
00364     operator>(const set<_Key, _Compare, _Allocator>& __lhs,
00365           const set<_Key, _Compare, _Allocator>& __rhs)
00366     { return __lhs._M_base() > __rhs._M_base(); }
00367 
00368   template<typename _Key, typename _Compare, typename _Allocator>
00369     void
00370     swap(set<_Key, _Compare, _Allocator>& __x,
00371      set<_Key, _Compare, _Allocator>& __y)
00372     { return __x.swap(__y); }
00373 
00374 } // namespace __profile
00375 } // namespace std
00376 
00377 #endif