libstdc++: point_const_iterator.hpp Source File

libstdc++

unordered_iterator/point_const_iterator.hpp
Go to the documentation of this file.
1// -*- C++ -*-
2
3// Copyright (C) 2005-2026 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 * * This file is intended to be included inside a class definition, with
42 * PB_DS_CLASS_C_DEC defined to the name of the enclosing class.
43 */
44
45#ifdef PB_DS_CLASS_C_DEC
46class point_iterator_;
47
48/// Const point-type iterator.
49class point_const_iterator_
50{
51public:
52 /// Category.
53 typedef trivial_iterator_tag iterator_category;
54
55 /// Difference type.
56 typedef trivial_iterator_difference_type difference_type;
57
58 /// Iterator's value type.
59 typedef value_type_ value_type;
60
61 /// Iterator's pointer type.
62 typedef pointer_ pointer;
63
64 /// Iterator's const pointer type.
65 typedef const_pointer_ const_pointer;
66
67 /// Iterator's reference type.
68 typedef reference_ reference;
69
70 /// Iterator's const reference type.
71 typedef const_reference_ const_reference;
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_() : m_p_value(0)
80 { }
81
82 /// Copy constructor.
83 inline
84 point_const_iterator_(const point_const_iterator_& other)
85 : m_p_value(other.m_p_value)
86 { }
87
88 /// Copy constructor.
89 inline
90 point_const_iterator_(const point_iterator_& other)
91 : m_p_value(other.m_p_value)
92 { }
93
94 /// Access.
95 const_pointer
96 operator->() const
97 {
98 _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
99 return m_p_value;
100 }
101
102 /// Access.
103 const_reference
104 operator*() const
105 {
106 _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
107 return *m_p_value;
108 }
109
110 /// Compares content to a different iterator object.
111 bool
112 operator==(const point_iterator_& other) const
113 { return m_p_value == other.m_p_value; }
114
115 /// Compares content to a different iterator object.
116 bool
117 operator==(const point_const_iterator_& other) const
118 { return m_p_value == other.m_p_value; }
119
120 /// Compares content (negatively) to a different iterator object.
121 bool
122 operator!=(const point_iterator_& other) const
123 { return m_p_value != other.m_p_value; }
124
125 /// Compares content (negatively) to a different iterator object.
126 bool
127 operator!=(const point_const_iterator_& other) const
128 { return m_p_value != other.m_p_value; }
129
130protected:
131 const_pointer m_p_value;
132
133 friend class point_iterator_;
134
135 friend class PB_DS_CLASS_C_DEC;
136};
137#endif
std::operator*
constexpr complex< _Tp > operator*(const complex< _Tp > &__x, const complex< _Tp > &__y)
Return new complex value x times y.
Definition complex:434
__gnu_pbds::trivial_iterator_difference_type
void trivial_iterator_difference_type
Prohibit moving trivial iterators.
Definition tag_and_trait.hpp:79