libstdc++-v3/include/bits/stl_map.h

   1 // Map implementation -*- C++ -*-
   2
   3 // Copyright (C) 2001 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 2, 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 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /*
  31  *
  32  * Copyright (c) 1994
  33  * Hewlett-Packard Company
  34  *
  35  * Permission to use, copy, modify, distribute and sell this software
  36  * and its documentation for any purpose is hereby granted without fee,
  37  * provided that the above copyright notice appear in all copies and
  38  * that both that copyright notice and this permission notice appear
  39  * in supporting documentation.  Hewlett-Packard Company makes no
  40  * representations about the suitability of this software for any
  41  * purpose.  It is provided "as is" without express or implied warranty.
  42  *
  43  *
  44  * Copyright (c) 1996,1997
  45  * Silicon Graphics Computer Systems, Inc.
  46  *
  47  * Permission to use, copy, modify, distribute and sell this software
  48  * and its documentation for any purpose is hereby granted without fee,
  49  * provided that the above copyright notice appear in all copies and
  50  * that both that copyright notice and this permission notice appear
  51  * in supporting documentation.  Silicon Graphics makes no
  52  * representations about the suitability of this software for any
  53  * purpose.  It is provided "as is" without express or implied warranty.
  54  */
  55
  56 /** @file stl_map.h
  57  *  This is an internal header file, included by other library headers.
  58  *  You should not attempt to use it directly.
  59  */
  60
  61 #ifndef _CPP_BITS_STL_MAP_H
  62 #define _CPP_BITS_STL_MAP_H 1
  63
  64 #include <bits/concept_check.h>
  65
  66 namespace std
  67 {
  68
  69 template <class _Key, class _Tp, class _Compare = less<_Key>,
  70           class _Alloc = allocator<pair<const _Key, _Tp> > >
  71 class map
  72 {
  73   // concept requirements
  74   __glibcpp_class_requires(_Tp, _SGIAssignableConcept)
  75   __glibcpp_class_requires4(_Compare, bool, _Key, _Key, _BinaryFunctionConcept);
  76
  77 public:
  78   // typedefs:
  79   typedef _Key                 key_type;
  80   typedef _Tp                   data_type;
  81   typedef _Tp                   mapped_type;
  82   typedef pair<const _Key, _Tp> value_type;
  83   typedef _Compare             key_compare;
  84
  85   class value_compare
  86     : public binary_function<value_type, value_type, bool> {
  87   friend class map<_Key,_Tp,_Compare,_Alloc>;
  88   protected :
  89     _Compare comp;
  90     value_compare(_Compare __c) : comp(__c) {}
  91   public:
  92     bool operator()(const value_type& __x, const value_type& __y) const {
  93       return comp(__x.first, __y.first);
  94     }
  95   };
  96
  97 private:
  98   typedef _Rb_tree<key_type, value_type,
  99                    _Select1st<value_type>, key_compare, _Alloc> _Rep_type;
 100   _Rep_type _M_t;  // red-black tree representing map
 101 public:
 102   typedef typename _Rep_type::pointer pointer;
 103   typedef typename _Rep_type::const_pointer const_pointer;
 104   typedef typename _Rep_type::reference reference;
 105   typedef typename _Rep_type::const_reference const_reference;
 106   typedef typename _Rep_type::iterator iterator;
 107   typedef typename _Rep_type::const_iterator const_iterator;
 108   typedef typename _Rep_type::reverse_iterator reverse_iterator;
 109   typedef typename _Rep_type::const_reverse_iterator const_reverse_iterator;
 110   typedef typename _Rep_type::size_type size_type;
 111   typedef typename _Rep_type::difference_type difference_type;
 112   typedef typename _Rep_type::allocator_type allocator_type;
 113
 114   // allocation/deallocation
 115
 116   map() : _M_t(_Compare(), allocator_type()) {}
 117   explicit map(const _Compare& __comp,
 118                const allocator_type& __a = allocator_type())
 119     : _M_t(__comp, __a) {}
 120
 121   template <class _InputIterator>
 122   map(_InputIterator __first, _InputIterator __last)
 123     : _M_t(_Compare(), allocator_type())
 124     { _M_t.insert_unique(__first, __last); }
 125
 126   template <class _InputIterator>
 127   map(_InputIterator __first, _InputIterator __last, const _Compare& __comp,
 128       const allocator_type& __a = allocator_type())
 129     : _M_t(__comp, __a) { _M_t.insert_unique(__first, __last); }
 130   map(const map<_Key,_Tp,_Compare,_Alloc>& __x) : _M_t(__x._M_t) {}
 131
 132   map<_Key,_Tp,_Compare,_Alloc>&
 133   operator=(const map<_Key, _Tp, _Compare, _Alloc>& __x)
 134   {
 135     _M_t = __x._M_t;
 136     return *this;
 137   }
 138
 139   // accessors:
 140
 141   key_compare key_comp() const { return _M_t.key_comp(); }
 142   value_compare value_comp() const { return value_compare(_M_t.key_comp()); }
 143   allocator_type get_allocator() const { return _M_t.get_allocator(); }
 144
 145   iterator begin() { return _M_t.begin(); }
 146   const_iterator begin() const { return _M_t.begin(); }
 147   iterator end() { return _M_t.end(); }
 148   const_iterator end() const { return _M_t.end(); }
 149   reverse_iterator rbegin() { return _M_t.rbegin(); }
 150   const_reverse_iterator rbegin() const { return _M_t.rbegin(); }
 151   reverse_iterator rend() { return _M_t.rend(); }
 152   const_reverse_iterator rend() const { return _M_t.rend(); }
 153   bool empty() const { return _M_t.empty(); }
 154   size_type size() const { return _M_t.size(); }
 155   size_type max_size() const { return _M_t.max_size(); }
 156   _Tp& operator[](const key_type& __k) {
 157     iterator __i = lower_bound(__k);
 158     // __i->first is greater than or equivalent to __k.
 159     if (__i == end() || key_comp()(__k, (*__i).first))
 160       __i = insert(__i, value_type(__k, _Tp()));
 161     return (*__i).second;
 162   }
 163   void swap(map<_Key,_Tp,_Compare,_Alloc>& __x) { _M_t.swap(__x._M_t); }
 164
 165   // insert/erase
 166
 167   pair<iterator,bool> insert(const value_type& __x)
 168     { return _M_t.insert_unique(__x); }
 169   iterator insert(iterator position, const value_type& __x)
 170     { return _M_t.insert_unique(position, __x); }
 171   template <class _InputIterator>
 172   void insert(_InputIterator __first, _InputIterator __last) {
 173     _M_t.insert_unique(__first, __last);
 174   }
 175
 176   void erase(iterator __position) { _M_t.erase(__position); }
 177   size_type erase(const key_type& __x) { return _M_t.erase(__x); }
 178   void erase(iterator __first, iterator __last)
 179     { _M_t.erase(__first, __last); }
 180   void clear() { _M_t.clear(); }
 181
 182   // map operations:
 183
 184   iterator find(const key_type& __x) { return _M_t.find(__x); }
 185   const_iterator find(const key_type& __x) const { return _M_t.find(__x); }
 186   size_type count(const key_type& __x) const {
 187     return _M_t.find(__x) == _M_t.end() ? 0 : 1;
 188   }
 189   iterator lower_bound(const key_type& __x) {return _M_t.lower_bound(__x); }
 190   const_iterator lower_bound(const key_type& __x) const {
 191     return _M_t.lower_bound(__x);
 192   }
 193   iterator upper_bound(const key_type& __x) {return _M_t.upper_bound(__x); }
 194   const_iterator upper_bound(const key_type& __x) const {
 195     return _M_t.upper_bound(__x);
 196   }
 197
 198   pair<iterator,iterator> equal_range(const key_type& __x) {
 199     return _M_t.equal_range(__x);
 200   }
 201   pair<const_iterator,const_iterator> equal_range(const key_type& __x) const {
 202     return _M_t.equal_range(__x);
 203   }
 204
 205   template <class _K1, class _T1, class _C1, class _A1>
 206   friend bool operator== (const map<_K1, _T1, _C1, _A1>&,
 207                           const map<_K1, _T1, _C1, _A1>&);
 208   template <class _K1, class _T1, class _C1, class _A1>
 209   friend bool operator< (const map<_K1, _T1, _C1, _A1>&,
 210                          const map<_K1, _T1, _C1, _A1>&);
 211 };
 212
 213 template <class _Key, class _Tp, class _Compare, class _Alloc>
 214 inline bool operator==(const map<_Key,_Tp,_Compare,_Alloc>& __x,
 215                        const map<_Key,_Tp,_Compare,_Alloc>& __y) {
 216   return __x._M_t == __y._M_t;
 217 }
 218
 219 template <class _Key, class _Tp, class _Compare, class _Alloc>
 220 inline bool operator<(const map<_Key,_Tp,_Compare,_Alloc>& __x,
 221                       const map<_Key,_Tp,_Compare,_Alloc>& __y) {
 222   return __x._M_t < __y._M_t;
 223 }
 224
 225 template <class _Key, class _Tp, class _Compare, class _Alloc>
 226 inline bool operator!=(const map<_Key,_Tp,_Compare,_Alloc>& __x,
 227                        const map<_Key,_Tp,_Compare,_Alloc>& __y) {
 228   return !(__x == __y);
 229 }
 230
 231 template <class _Key, class _Tp, class _Compare, class _Alloc>
 232 inline bool operator>(const map<_Key,_Tp,_Compare,_Alloc>& __x,
 233                       const map<_Key,_Tp,_Compare,_Alloc>& __y) {
 234   return __y < __x;
 235 }
 236
 237 template <class _Key, class _Tp, class _Compare, class _Alloc>
 238 inline bool operator<=(const map<_Key,_Tp,_Compare,_Alloc>& __x,
 239                        const map<_Key,_Tp,_Compare,_Alloc>& __y) {
 240   return !(__y < __x);
 241 }
 242
 243 template <class _Key, class _Tp, class _Compare, class _Alloc>
 244 inline bool operator>=(const map<_Key,_Tp,_Compare,_Alloc>& __x,
 245                        const map<_Key,_Tp,_Compare,_Alloc>& __y) {
 246   return !(__x < __y);
 247 }
 248
 249 template <class _Key, class _Tp, class _Compare, class _Alloc>
 250 inline void swap(map<_Key,_Tp,_Compare,_Alloc>& __x,
 251                  map<_Key,_Tp,_Compare,_Alloc>& __y) {
 252   __x.swap(__y);
 253 }
 254
 255 } // namespace std
 256
 257 #endif /* _CPP_BITS_STL_MAP_H */
 258
 259 // Local Variables:
 260 // mode:C++
 261 // End: