1// -*- C++ -*-
2
3// Copyright (C) 2005-2015 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.
43class point_iterator_
44{
45public:
46  /// Category.
47  typedef trivial_iterator_tag iterator_category;
48
49  /// Difference type.
50  typedef trivial_iterator_difference_type difference_type;
51
52  /// Iterator's value type.
53  typedef value_type_ value_type;
54
55  /// Iterator's pointer type.
56  typedef pointer_ pointer;
57
58  /// Iterator's const pointer type.
59  typedef const_pointer_ const_pointer;
60
61  /// Iterator's reference type.
62  typedef reference_ reference;
63
64  /// Iterator's const reference type.
65  typedef const_reference_ const_reference;
66
67  /// Default constructor.
68  inline
69  point_iterator_()
70  : m_p_value(0)
71  { }
72
73  /// Copy constructor.
74  inline
75  point_iterator_(const point_iterator_& other)
76  : m_p_value(other.m_p_value)
77  { }
78
79  /// Access.
80  pointer
81  operator->() const
82  {
83    _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
84    return (m_p_value);
85  }
86
87  /// Access.
88  reference
89  operator*() const
90  {
91    _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
92    return (*m_p_value);
93  }
94
95  /// Compares content to a different iterator object.
96  bool
97  operator==(const point_iterator_& other) const
98  { return m_p_value == other.m_p_value; }
99
100  /// Compares content to a different iterator object.
101  bool
102  operator==(const point_const_iterator_& other) const
103  { return m_p_value == other.m_p_value; }
104
105  /// Compares content to a different iterator object.
106  bool
107  operator!=(const point_iterator_& other) const
108  { return m_p_value != other.m_p_value; }
109
110  /// Compares content (negatively) to a different iterator object.
111  bool
112  operator!=(const point_const_iterator_& other) const
113  { return m_p_value != other.m_p_value; }
114
115  inline
116  point_iterator_(pointer p_value) : m_p_value(p_value)
117  { }
118
119protected:
120  friend class point_const_iterator_;
121
122  friend class PB_DS_CLASS_C_DEC;
123
124protected:
125  pointer m_p_value;
126};
127