libstdc++-v3/include/ext/pb_ds/detail/unordered_iterator/point_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 point_iterator.hpp
  38  * Contains an iterator class returned by the tables' find and insert
  39  *     methods.
  40  */
  41
  42 // Find type iterator.
  43 class point_iterator_
  44 {
  45
  46 public:
  47
  48   // Category.
  49   typedef trivial_iterator_tag iterator_category;
  50
  51   // Difference type.
  52   typedef trivial_iterator_difference_type difference_type;
  53
  54   // Iterator's value type.
  55   typedef value_type_ value_type;
  56
  57   // Iterator's pointer type.
  58   typedef pointer_ pointer;
  59
  60   // Iterator's const pointer type.
  61   typedef const_pointer_ const_pointer;
  62
  63   // Iterator's reference type.
  64   typedef reference_ reference;
  65
  66   // Iterator's const reference type.
  67   typedef const_reference_ const_reference;
  68
  69 public:
  70
  71   // Default constructor.
  72   inline
  73   point_iterator_()
  74
  75     : m_p_value(0)
  76   { }
  77
  78   // Copy constructor.
  79   inline
  80   point_iterator_(const point_iterator_& other)
  81
  82     : m_p_value(other.m_p_value)
  83   { }
  84
  85   // Access.
  86   inline pointer
  87   operator->() const
  88   {
  89     _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
  90
  91     return (m_p_value);
  92   }
  93
  94   // Access.
  95   inline reference
  96   operator*() const
  97   {
  98     _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
  99
 100     return (*m_p_value);
 101   }
 102
 103   // Compares content to a different iterator object.
 104   inline bool
 105   operator==(const point_iterator_& other) const
 106   {
 107     return (m_p_value == other.m_p_value);
 108   }
 109
 110   // Compares content to a different iterator object.
 111   inline bool
 112   operator==(const const_point_iterator_& other) const
 113   {
 114     return (m_p_value == other.m_p_value);
 115   }
 116
 117   // Compares content to a different iterator object.
 118   inline bool
 119   operator!=(const point_iterator_& other) const
 120   {
 121     return (m_p_value != other.m_p_value);
 122   }
 123
 124   // Compares content (negatively) to a different iterator object.
 125   inline bool
 126   operator!=(const const_point_iterator_& other) const
 127   {
 128     return (m_p_value != other.m_p_value);
 129   }
 130
 131   inline
 132   point_iterator_(pointer p_value) : m_p_value(p_value)
 133   { }
 134
 135 protected:
 136   friend class const_point_iterator_;
 137
 138   friend class PB_DS_CLASS_C_DEC;
 139
 140 protected:
 141   pointer m_p_value;
 142 };
 143