xref: /openbsd-src/gnu/gcc/libstdc++-v3/include/ext/pb_ds/detail/unordered_iterator/point_iterator.hpp (revision 404b540a9034ac75a6199ad1a32d1bbc7a0d4210)
1 // -*- C++ -*-
2 
3 // Copyright (C) 2005, 2006 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 2, 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 // You should have received a copy of the GNU General Public License
17 // along with this library; see the file COPYING.  If not, write to
18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
19 // MA 02111-1307, USA.
20 
21 // As a special exception, you may use this file as part of a free
22 // software library without restriction.  Specifically, if other files
23 // instantiate templates or use macros or inline functions from this
24 // file, or you compile this file and link it with other files to
25 // produce an executable, this file does not by itself cause the
26 // resulting executable to be covered by the GNU General Public
27 // License.  This exception does not however invalidate any other
28 // reasons why the executable file might be covered by the GNU General
29 // Public License.
30 
31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
32 
33 // Permission to use, copy, modify, sell, and distribute this software
34 // is hereby granted without fee, provided that the above copyright
35 // notice appears in all copies, and that both that copyright notice
36 // and this permission notice appear in supporting documentation. None
37 // of the above authors, nor IBM Haifa Research Laboratories, make any
38 // representation about the suitability of this software for any
39 // purpose. It is provided "as is" without express or implied
40 // warranty.
41 
42 /**
43  * @file point_iterator.hpp
44  * Contains an iterator class returned by the tables' find and insert
45  *     methods.
46  */
47 
48 // Find type iterator.
49 class point_iterator_
50 {
51 
52 public:
53 
54   // Category.
55   typedef trivial_iterator_tag iterator_category;
56 
57   // Difference type.
58   typedef trivial_iterator_difference_type difference_type;
59 
60   // Iterator's value type.
61   typedef value_type_ value_type;
62 
63   // Iterator's pointer type.
64   typedef pointer_ pointer;
65 
66   // Iterator's const pointer type.
67   typedef const_pointer_ const_pointer;
68 
69   // Iterator's reference type.
70   typedef reference_ reference;
71 
72   // Iterator's const reference type.
73   typedef const_reference_ const_reference;
74 
75 public:
76 
77   // Default constructor.
78   inline
point_iterator_()79   point_iterator_()
80 
81     : m_p_value(NULL)
82   { }
83 
84   // Copy constructor.
85   inline
point_iterator_(const point_iterator_ & other)86   point_iterator_(const point_iterator_& other)
87 
88     : m_p_value(other.m_p_value)
89   { }
90 
91   // Access.
92   inline pointer
operator ->() const93   operator->() const
94   {
95     _GLIBCXX_DEBUG_ASSERT(m_p_value != NULL);
96 
97     return (m_p_value);
98   }
99 
100   // Access.
101   inline reference
operator *() const102   operator*() const
103   {
104     _GLIBCXX_DEBUG_ASSERT(m_p_value != NULL);
105 
106     return (*m_p_value);
107   }
108 
109   // Compares content to a different iterator object.
110   inline bool
operator ==(const point_iterator_ & other) const111   operator==(const point_iterator_& other) const
112   {
113     return (m_p_value == other.m_p_value);
114   }
115 
116   // Compares content to a different iterator object.
117   inline bool
operator ==(const const_point_iterator_ & other) const118   operator==(const const_point_iterator_& other) const
119   {
120     return (m_p_value == other.m_p_value);
121   }
122 
123   // Compares content to a different iterator object.
124   inline bool
operator !=(const point_iterator_ & other) const125   operator!=(const point_iterator_& other) const
126   {
127     return (m_p_value != other.m_p_value);
128   }
129 
130   // Compares content (negatively) to a different iterator object.
131   inline bool
operator !=(const const_point_iterator_ & other) const132   operator!=(const const_point_iterator_& other) const
133   {
134     return (m_p_value != other.m_p_value);
135   }
136 
137   inline
point_iterator_(pointer p_value)138   point_iterator_(pointer p_value) : m_p_value(p_value)
139   { }
140 
141 protected:
142   friend class const_point_iterator_;
143 
144   friend class PB_DS_CLASS_C_DEC;
145 
146 protected:
147   pointer m_p_value;
148 };
149 
150