libstdc++-v3/include/ext/pb_ds/detail/unordered_iterator/point_const_iterator.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006, 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 terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 3, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // 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 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  26
  27 // Permission to use, copy, modify, sell, and distribute this software
  28 // is hereby granted without fee, provided that the above copyright
  29 // notice appears in all copies, and that both that copyright notice
  30 // and this permission notice appear in supporting documentation. None
  31 // of the above authors, nor IBM Haifa Research Laboratories, make any
  32 // representation about the suitability of this software for any
  33 // purpose. It is provided "as is" without express or implied
  34 // warranty.
  35
  36 /**
  37  * @file unordered_iterator/point_const_iterator.hpp
  38  * Contains an iterator class returned by the tables' const find and insert
  39  *     methods.
  40  */
  41
  42 class point_iterator_;
  43
  44 // Const point-type iterator.
  45 class point_const_iterator_
  46 {
  47
  48 public:
  49
  50   // Category.
  51   typedef trivial_iterator_tag iterator_category;
  52
  53   // Difference type.
  54   typedef trivial_iterator_difference_type difference_type;
  55
  56   // Iterator's value type.
  57   typedef value_type_ value_type;
  58
  59   // Iterator's pointer type.
  60   typedef pointer_ pointer;
  61
  62   // Iterator's const pointer type.
  63   typedef const_pointer_ const_pointer;
  64
  65   // Iterator's reference type.
  66   typedef reference_ reference;
  67
  68   // Iterator's const reference type.
  69   typedef const_reference_ const_reference;
  70
  71 public:
  72
  73   inline
  74   point_const_iterator_(const_pointer p_value) : m_p_value(p_value)
  75   { }
  76
  77   // Default constructor.
  78   inline
  79   point_const_iterator_()
  80
  81     : m_p_value(0)
  82   { }
  83
  84   // Copy constructor.
  85   inline
  86   point_const_iterator_(const point_const_iterator_& other)
  87
  88     : m_p_value(other.m_p_value)
  89   { }
  90
  91   // Copy constructor.
  92   inline
  93   point_const_iterator_(const point_iterator_& other)
  94
  95     : m_p_value(other.m_p_value)
  96   { }
  97
  98   // Access.
  99   inline const_pointer
 100   operator->() const
 101   {
 102     _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
 103
 104     return (m_p_value);
 105   }
 106
 107   // Access.
 108   inline const_reference
 109   operator*() const
 110   {
 111     _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
 112
 113     return (*m_p_value);
 114   }
 115
 116   // Compares content to a different iterator object.
 117   inline bool
 118   operator==(const point_iterator_& other) const
 119   {
 120     return (m_p_value == other.m_p_value);
 121   }
 122
 123   // Compares content to a different iterator object.
 124   inline bool
 125   operator==(const point_const_iterator_& other) const
 126   {
 127     return (m_p_value == other.m_p_value);
 128   }
 129
 130   // Compares content (negatively) to a different iterator object.
 131   inline bool
 132   operator!=(const point_iterator_& other) const
 133   {
 134     return (m_p_value != other.m_p_value);
 135   }
 136
 137   // Compares content (negatively) to a different iterator object.
 138   inline bool
 139   operator!=(const point_const_iterator_& other) const
 140   {
 141     return (m_p_value != other.m_p_value);
 142   }
 143
 144 protected:
 145   const_pointer m_p_value;
 146
 147   friend class point_iterator_;
 148
 149   friend class PB_DS_CLASS_C_DEC;
 150 };
 151