libstdc++
unordered_iterator/point_const_iterator.hpp
Go to the documentation of this file.
1// -*- C++ -*-
2
3// Copyright (C) 2005-2019 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
42class point_iterator_;
43
44/// Const point-type iterator.
46{
47public:
48 /// Category.
49 typedef trivial_iterator_tag iterator_category;
50
51 /// 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 inline
70 point_const_iterator_(const_pointer p_value) : m_p_value(p_value)
71 { }
72
73 /// Default constructor.
74 inline
75 point_const_iterator_() : m_p_value(0)
76 { }
77
78 /// Copy constructor.
79 inline
81 : m_p_value(other.m_p_value)
82 { }
83
84 /// Copy constructor.
85 inline
87 : m_p_value(other.m_p_value)
88 { }
89
90 /// Access.
92 operator->() const
93 {
94 _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
95 return m_p_value;
96 }
97
98 /// Access.
100 operator*() const
101 {
102 _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
103 return *m_p_value;
104 }
105
106 /// Compares content to a different iterator object.
107 bool
108 operator==(const point_iterator_& other) const
109 { return m_p_value == other.m_p_value; }
110
111 /// Compares content to a different iterator object.
112 bool
114 { return m_p_value == other.m_p_value; }
115
116 /// Compares content (negatively) to a different iterator object.
117 bool
118 operator!=(const point_iterator_& other) const
119 { return m_p_value != other.m_p_value; }
120
121 /// Compares content (negatively) to a different iterator object.
122 bool
124 { return m_p_value != other.m_p_value; }
125
126protected:
127 const_pointer m_p_value;
128
129 friend class point_iterator_;
130
131 friend class PB_DS_CLASS_C_DEC;
132};
133
void trivial_iterator_difference_type
Prohibit moving trivial iterators.
pointer_ pointer
Iterator's pointer type.
reference_ reference
Iterator's reference type.
bool operator!=(const point_iterator_ &other) const
Compares content (negatively) to a different iterator object.
bool operator!=(const point_const_iterator_ &other) const
Compares content (negatively) to a different iterator object.
const_pointer_ const_pointer
Iterator's const pointer type.
value_type_ value_type
Iterator's value type.
bool operator==(const point_iterator_ &other) const
Compares content to a different iterator object.
bool operator==(const point_const_iterator_ &other) const
Compares content to a different iterator object.
trivial_iterator_tag iterator_category
Category.
point_const_iterator_(const point_const_iterator_ &other)
Copy constructor.
const_reference_ const_reference
Iterator's const reference type.
trivial_iterator_difference_type difference_type
Difference type.
point_const_iterator_(const point_iterator_ &other)
Copy constructor.
Find type iterator.