libstdc++
point_iterator.hpp
Go to the documentation of this file.
1 // -*- C++ -*-
2 
3 // Copyright (C) 2005-2020 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  * 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
46 /// Find type iterator.
47 class point_iterator_
48 {
49 public:
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  /// Default constructor.
72  inline
73  point_iterator_()
74  : m_p_value(0)
75  { }
76 
77  /// Copy constructor.
78  inline
79  point_iterator_(const point_iterator_& other)
80  : m_p_value(other.m_p_value)
81  { }
82 
83  /// Access.
84  pointer
85  operator->() const
86  {
87  _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
88  return (m_p_value);
89  }
90 
91  /// Access.
92  reference
93  operator*() const
94  {
95  _GLIBCXX_DEBUG_ASSERT(m_p_value != 0);
96  return (*m_p_value);
97  }
98 
99  /// Compares content to a different iterator object.
100  bool
101  operator==(const point_iterator_& other) const
102  { return m_p_value == other.m_p_value; }
103 
104  /// Compares content to a different iterator object.
105  bool
106  operator==(const point_const_iterator_& other) const
107  { return m_p_value == other.m_p_value; }
108 
109  /// Compares content to a different iterator object.
110  bool
111  operator!=(const point_iterator_& other) const
112  { return m_p_value != other.m_p_value; }
113 
114  /// Compares content (negatively) to a different iterator object.
115  bool
116  operator!=(const point_const_iterator_& other) const
117  { return m_p_value != other.m_p_value; }
118 
119  inline
120  point_iterator_(pointer p_value) : m_p_value(p_value)
121  { }
122 
123 protected:
124  friend class point_const_iterator_;
125 
126  friend class PB_DS_CLASS_C_DEC;
127 
128 protected:
129  pointer m_p_value;
130 };
131 #endif
constexpr complex< _Tp > operator*(const complex< _Tp > &__x, const complex< _Tp > &__y)
Return new complex value x times y.
Definition: complex:391
void trivial_iterator_difference_type
Prohibit moving trivial iterators.