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

   1 // Profiling map implementation -*- C++ -*-
   2
   3 // Copyright (C) 2009-2014 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 along
  21 // with this library; see the file COPYING3.  If not see
  22 // <http://www.gnu.org/licenses/>.
  23
  24 /** @file profile/map.h
  25  *  This file is a GNU profile extension to the Standard C++ Library.
  26  */
  27
  28 #ifndef _GLIBCXX_PROFILE_MAP_H
  29 #define _GLIBCXX_PROFILE_MAP_H 1
  30
  31 #include <profile/base.h>
  32 #include <profile/ordered_base.h>
  33
  34 namespace std _GLIBCXX_VISIBILITY(default)
  35 {
  36 namespace __profile
  37 {
  38   /// Class std::map wrapper with performance instrumentation.
  39   template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>,
  40            typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > >
  41     class map
  42     : public _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator>,
  43       public _Ordered_profile<map<_Key, _Tp, _Compare, _Allocator> >
  44     {
  45       typedef _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator> _Base;
  46
  47     public:
  48       // types:
  49       typedef _Key                                      key_type;
  50       typedef _Tp                                       mapped_type;
  51       typedef typename _Base::value_type                value_type;
  52       typedef _Compare                                  key_compare;
  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::size_type                 size_type;
  59       typedef typename _Base::difference_type           difference_type;
  60       typedef typename _Base::reverse_iterator          reverse_iterator;
  61       typedef typename _Base::const_reverse_iterator    const_reverse_iterator;
  62
  63       // 23.3.1.1 construct/copy/destroy:
  64
  65 #if __cplusplus < 201103L
  66       map()
  67       : _Base() { }
  68       map(const map& __x)
  69         : _Base(__x) { }
  70       ~map()
  71       { }
  72 #else
  73       map() = default;
  74       map(const map&) = default;
  75       map(map&&) = default;
  76       ~map() = default;
  77 #endif
  78
  79       explicit
  80       map(const _Compare& __comp,
  81           const _Allocator& __a = _Allocator())
  82       : _Base(__comp, __a) { }
  83
  84 #if __cplusplus >= 201103L
  85       template<typename _InputIterator,
  86                typename = std::_RequireInputIter<_InputIterator>>
  87 #else
  88       template<typename _InputIterator>
  89 #endif
  90         map(_InputIterator __first, _InputIterator __last,
  91             const _Compare& __comp = _Compare(),
  92             const _Allocator& __a = _Allocator())
  93         : _Base(__first, __last, __comp, __a) { }
  94
  95       map(const _Base& __x)
  96       : _Base(__x) { }
  97
  98 #if __cplusplus >= 201103L
  99       map(initializer_list<value_type> __l,
 100           const _Compare& __c = _Compare(),
 101           const _Allocator& __a = _Allocator())
 102       : _Base(__l, __c, __a) { }
 103
 104       explicit
 105       map(const _Allocator& __a)
 106       : _Base(__a) { }
 107
 108       map(const map& __x, const _Allocator& __a)
 109       : _Base(__x, __a) { }
 110
 111       map(map&& __x, const _Allocator& __a)
 112       noexcept( noexcept(_Base(std::move(__x), __a)) )
 113       : _Base(std::move(__x), __a) { }
 114
 115       map(initializer_list<value_type> __l, const _Allocator& __a)
 116       : _Base(__l, __a) { }
 117
 118       template<typename _InputIterator>
 119         map(_InputIterator __first, _InputIterator __last,
 120             const _Allocator& __a)
 121         : _Base(__first, __last, __a) { }
 122 #endif
 123
 124 #if __cplusplus < 201103L
 125       map&
 126       operator=(const map& __x)
 127       {
 128         _M_base() = __x;
 129         return *this;
 130       }
 131 #else
 132       map&
 133       operator=(const map&) = default;
 134
 135       map&
 136       operator=(map&&) = default;
 137
 138       map&
 139       operator=(initializer_list<value_type> __l)
 140       {
 141         _M_base() = __l;
 142         return *this;
 143       }
 144 #endif
 145
 146       reverse_iterator
 147       rbegin() _GLIBCXX_NOEXCEPT
 148       {
 149         __profcxx_map_to_unordered_map_invalidate(this);
 150         return _Base::rbegin();
 151       }
 152
 153       const_reverse_iterator
 154       rbegin() const _GLIBCXX_NOEXCEPT
 155       {
 156         __profcxx_map_to_unordered_map_invalidate(this);
 157         return _Base::rbegin();
 158       }
 159
 160       reverse_iterator
 161       rend() _GLIBCXX_NOEXCEPT
 162       {
 163         __profcxx_map_to_unordered_map_invalidate(this);
 164         return _Base::rend();
 165       }
 166
 167       const_reverse_iterator
 168       rend() const _GLIBCXX_NOEXCEPT
 169       {
 170         __profcxx_map_to_unordered_map_invalidate(this);
 171         return _Base::rend();
 172       }
 173
 174 #if __cplusplus >= 201103L
 175       const_reverse_iterator
 176       crbegin() const noexcept
 177       {
 178         __profcxx_map_to_unordered_map_invalidate(this);
 179         return _Base::crbegin();
 180       }
 181
 182       const_reverse_iterator
 183       crend() const noexcept
 184       {
 185         __profcxx_map_to_unordered_map_invalidate(this);
 186         return _Base::crend();
 187       }
 188 #endif
 189
 190       // 23.3.1.2 element access:
 191       mapped_type&
 192       operator[](const key_type& __k)
 193       {
 194         __profcxx_map_to_unordered_map_find(this, this->size());
 195         return _Base::operator[](__k);
 196       }
 197
 198 #if __cplusplus >= 201103L
 199       mapped_type&
 200       operator[](key_type&& __k)
 201       {
 202         __profcxx_map_to_unordered_map_find(this, this->size());
 203         return _Base::operator[](std::move(__k));
 204       }
 205 #endif
 206
 207       mapped_type&
 208       at(const key_type& __k)
 209       {
 210         __profcxx_map_to_unordered_map_find(this, this->size());
 211         return _Base::at(__k);
 212       }
 213
 214       const mapped_type&
 215       at(const key_type& __k) const
 216       {
 217         __profcxx_map_to_unordered_map_find(this, this->size());
 218         return _Base::at(__k);
 219       }
 220
 221       // modifiers:
 222 #if __cplusplus >= 201103L
 223       template<typename... _Args>
 224         std::pair<iterator, bool>
 225         emplace(_Args&&... __args)
 226         {
 227           // The cost is the same whether or not the element is inserted so we
 228           // always report insertion of 1 element.
 229           __profcxx_map_to_unordered_map_insert(this, this->size(), 1);
 230           return _Base::emplace(std::forward<_Args>(__args)...);
 231         }
 232
 233       template<typename... _Args>
 234         iterator
 235         emplace_hint(const_iterator __pos, _Args&&... __args)
 236         {
 237           auto size_before = this->size();
 238           auto __res = _Base::emplace_hint(__pos, std::forward<_Args>(__args)...);
 239           __profcxx_map_to_unordered_map_insert(this, size_before,
 240                                         _M_hint_used(__pos, __res) ? 0 : 1);
 241           return __res;
 242         }
 243 #endif
 244
 245       std::pair<iterator, bool>
 246       insert(const value_type& __x)
 247       {
 248         __profcxx_map_to_unordered_map_insert(this, this->size(), 1);
 249         return _Base::insert(__x);
 250       }
 251
 252 #if __cplusplus >= 201103L
 253       template<typename _Pair, typename = typename
 254                std::enable_if<std::is_constructible<value_type,
 255                                                     _Pair&&>::value>::type>
 256         std::pair<iterator, bool>
 257         insert(_Pair&& __x)
 258         {
 259           __profcxx_map_to_unordered_map_insert(this, this->size(), 1);
 260           return _Base::insert(std::forward<_Pair>(__x));
 261         }
 262 #endif
 263
 264 #if __cplusplus >= 201103L
 265       void
 266       insert(std::initializer_list<value_type> __list)
 267       { insert(__list.begin(), __list.end()); }
 268 #endif
 269
 270       iterator
 271 #if __cplusplus >= 201103L
 272       insert(const_iterator __pos, const value_type& __x)
 273 #else
 274       insert(iterator __pos, const value_type& __x)
 275 #endif
 276       {
 277         size_type size_before = this->size();
 278         iterator __res = _Base::insert(__pos, __x);
 279
 280         __profcxx_map_to_unordered_map_insert(this, size_before,
 281                                         _M_hint_used(__pos, __res) ? 0 : 1);
 282         return __res;
 283       }
 284
 285 #if __cplusplus >= 201103L
 286       template<typename _Pair, typename = typename
 287                std::enable_if<std::is_constructible<value_type,
 288                                                     _Pair&&>::value>::type>
 289         iterator
 290         insert(const_iterator __pos, _Pair&& __x)
 291         {
 292           size_type size_before = this->size();
 293           auto __res = _Base::insert(__pos, std::forward<_Pair>(__x));
 294
 295           __profcxx_map_to_unordered_map_insert(this, size_before,
 296                                         _M_hint_used(__pos, __res) ? 0 : 1);
 297           return __res;
 298       }
 299 #endif
 300
 301 #if __cplusplus >= 201103L
 302       template<typename _InputIterator,
 303                typename = std::_RequireInputIter<_InputIterator>>
 304 #else
 305       template<typename _InputIterator>
 306 #endif
 307         void
 308         insert(_InputIterator __first, _InputIterator __last)
 309         {
 310           for (; __first != __last; ++__first)
 311             insert(*__first);
 312         }
 313
 314 #if __cplusplus >= 201103L
 315       iterator
 316       erase(const_iterator __position)
 317       {
 318         __profcxx_map_to_unordered_map_erase(this, this->size(), 1);
 319         return _Base::erase(__position);
 320       }
 321
 322       iterator
 323       erase(iterator __position)
 324       {
 325         __profcxx_map_to_unordered_map_erase(this, this->size(), 1);
 326         return _Base::erase(__position);
 327       }
 328 #else
 329       void
 330       erase(iterator __position)
 331       {
 332         __profcxx_map_to_unordered_map_erase(this, this->size(), 1);
 333         _Base::erase(__position);
 334       }
 335 #endif
 336
 337       size_type
 338       erase(const key_type& __x)
 339       {
 340         __profcxx_map_to_unordered_map_find(this, this->size());
 341         __profcxx_map_to_unordered_map_erase(this, this->size(), 1);
 342         return _Base::erase(__x);
 343       }
 344
 345 #if __cplusplus >= 201103L
 346       iterator
 347       erase(const_iterator __first, const_iterator __last)
 348       {
 349         if (__first != __last)
 350           {
 351             iterator __ret;
 352             for (; __first != __last;)
 353               __ret = erase(__first++);
 354             return __ret;
 355           }
 356         else
 357           return _Base::erase(__first, __last);
 358       }
 359 #else
 360       void
 361       erase(iterator __first, iterator __last)
 362       {
 363         for (; __first != __last;)
 364           erase(__first++);
 365       }
 366 #endif
 367
 368       void
 369       swap(map& __x)
 370 #if __cplusplus >= 201103L
 371         noexcept( noexcept(declval<_Base>().swap(__x)) )
 372 #endif
 373       { _Base::swap(__x); }
 374
 375       // 23.3.1.3 map operations:
 376       iterator
 377       find(const key_type& __x)
 378       {
 379         __profcxx_map_to_unordered_map_find(this, this->size());
 380         return _Base::find(__x);
 381       }
 382
 383       const_iterator
 384       find(const key_type& __x) const
 385       {
 386         __profcxx_map_to_unordered_map_find(this, this->size());
 387         return _Base::find(__x);
 388       }
 389
 390       size_type
 391       count(const key_type& __x) const
 392       {
 393         __profcxx_map_to_unordered_map_find(this, this->size());
 394         return _Base::count(__x);
 395       }
 396
 397       iterator
 398       lower_bound(const key_type& __x)
 399       {
 400         __profcxx_map_to_unordered_map_find(this, this->size());
 401         __profcxx_map_to_unordered_map_invalidate(this);
 402         return _Base::lower_bound(__x);
 403       }
 404
 405       const_iterator
 406       lower_bound(const key_type& __x) const
 407       {
 408         __profcxx_map_to_unordered_map_find(this, this->size());
 409         __profcxx_map_to_unordered_map_invalidate(this);
 410         return _Base::lower_bound(__x);
 411       }
 412
 413       iterator
 414       upper_bound(const key_type& __x)
 415       {
 416         __profcxx_map_to_unordered_map_find(this, this->size());
 417         __profcxx_map_to_unordered_map_invalidate(this);
 418         return _Base::upper_bound(__x);
 419       }
 420
 421       const_iterator
 422       upper_bound(const key_type& __x) const
 423       {
 424         __profcxx_map_to_unordered_map_find(this, this->size());
 425         __profcxx_map_to_unordered_map_invalidate(this);
 426         return _Base::upper_bound(__x);
 427       }
 428
 429       std::pair<iterator,iterator>
 430       equal_range(const key_type& __x)
 431       {
 432         __profcxx_map_to_unordered_map_find(this, this->size());
 433         return _Base::equal_range(__x);
 434       }
 435
 436       std::pair<const_iterator,const_iterator>
 437       equal_range(const key_type& __x) const
 438       {
 439         __profcxx_map_to_unordered_map_find(this, this->size());
 440         return _Base::equal_range(__x);
 441       }
 442
 443       _Base&
 444       _M_base() _GLIBCXX_NOEXCEPT       { return *this; }
 445
 446       const _Base&
 447       _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
 448
 449     private:
 450       /** If hint is used we consider that the map and unordered_map
 451        * operations have equivalent insertion cost so we do not update metrics
 452        * about it.
 453        * Note that to find out if hint has been used is libstdc++
 454        * implementation dependent.
 455        */
 456       bool
 457       _M_hint_used(const_iterator __hint, iterator __res)
 458       {
 459         return (__hint == __res
 460                 || (__hint == this->end() && ++__res == this->end())
 461                 || (__hint != this->end() && (++__hint == __res
 462                                               || ++__res == --__hint)));
 463       }
 464     };
 465
 466   template<typename _Key, typename _Tp,
 467            typename _Compare, typename _Allocator>
 468     inline bool
 469     operator==(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 470                const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 471     {
 472       __profcxx_map_to_unordered_map_invalidate(&__lhs);
 473       __profcxx_map_to_unordered_map_invalidate(&__rhs);
 474       return __lhs._M_base() == __rhs._M_base();
 475     }
 476
 477   template<typename _Key, typename _Tp,
 478            typename _Compare, typename _Allocator>
 479     inline bool
 480     operator!=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 481                const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 482     {
 483       __profcxx_map_to_unordered_map_invalidate(&__lhs);
 484       __profcxx_map_to_unordered_map_invalidate(&__rhs);
 485       return __lhs._M_base() != __rhs._M_base();
 486     }
 487
 488   template<typename _Key, typename _Tp,
 489            typename _Compare, typename _Allocator>
 490     inline bool
 491     operator<(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 492               const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 493     {
 494       __profcxx_map_to_unordered_map_invalidate(&__lhs);
 495       __profcxx_map_to_unordered_map_invalidate(&__rhs);
 496       return __lhs._M_base() < __rhs._M_base();
 497     }
 498
 499   template<typename _Key, typename _Tp,
 500            typename _Compare, typename _Allocator>
 501     inline bool
 502     operator<=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 503                const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 504     {
 505       __profcxx_map_to_unordered_map_invalidate(&__lhs);
 506       __profcxx_map_to_unordered_map_invalidate(&__rhs);
 507       return __lhs._M_base() <= __rhs._M_base();
 508     }
 509
 510   template<typename _Key, typename _Tp,
 511            typename _Compare, typename _Allocator>
 512     inline bool
 513     operator>=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 514                const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 515     {
 516       __profcxx_map_to_unordered_map_invalidate(&__lhs);
 517       __profcxx_map_to_unordered_map_invalidate(&__rhs);
 518       return __lhs._M_base() >= __rhs._M_base();
 519     }
 520
 521   template<typename _Key, typename _Tp,
 522            typename _Compare, typename _Allocator>
 523     inline bool
 524     operator>(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 525               const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 526     {
 527       __profcxx_map_to_unordered_map_invalidate(&__lhs);
 528       __profcxx_map_to_unordered_map_invalidate(&__rhs);
 529       return __lhs._M_base() > __rhs._M_base();
 530     }
 531
 532   template<typename _Key, typename _Tp,
 533            typename _Compare, typename _Allocator>
 534     inline void
 535     swap(map<_Key, _Tp, _Compare, _Allocator>& __lhs,
 536          map<_Key, _Tp, _Compare, _Allocator>& __rhs)
 537     { __lhs.swap(__rhs); }
 538
 539 } // namespace __profile
 540 } // namespace std
 541
 542 #endif