libstdc++: iterator.hpp Source File

libstdc++

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 iterator.hpp
38 * Contains an iterator_ class used for ranging over the elements of the
39 * table.
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/// Range-type iterator.
47class iterator_
48: public const_iterator_
49{
50public:
51 /// Category.
52 typedef std::forward_iterator_tag iterator_category;
53
54 /// Difference type.
55 typedef typename _Alloc::difference_type difference_type;
56
57 /// Iterator's value type.
58 typedef value_type_ value_type;
59
60 /// Iterator's pointer type.
61 typedef pointer_ pointer;
62
63 /// Iterator's const pointer type.
64 typedef const_pointer_ const_pointer;
65
66 /// Iterator's reference type.
67 typedef reference_ reference;
68
69 /// Iterator's const reference type.
70 typedef const_reference_ const_reference;
71
72 /// Default constructor.
73 inline
74 iterator_()
75 : const_iterator_(0, PB_DS_GEN_POS(), 0) { }
76
77 /// Conversion to a point-type iterator.
78 inline
79 operator point_iterator_()
80 { return point_iterator_(const_cast<pointer>(const_iterator_::m_p_value)); }
81
82 /// Conversion to a point-type iterator.
83 inline
84 operator const point_iterator_() const
85 { return point_iterator_(const_cast<pointer>(const_iterator_::m_p_value)); }
86
87 /// Access.
88 pointer
89 operator->() const
90 {
91 _GLIBCXX_DEBUG_ASSERT(base_type::m_p_value != 0);
92 return (const_cast<pointer>(base_type::m_p_value));
93 }
94
95 /// Access.
96 reference
97 operator*() const
98 {
99 _GLIBCXX_DEBUG_ASSERT(base_type::m_p_value != 0);
100 return (const_cast<reference>(*base_type::m_p_value));
101 }
102
103 /// Increments.
104 iterator_&
105 operator++()
106 {
107 base_type::m_p_tbl->inc_it_state(base_type::m_p_value, base_type::m_pos);
108 return *this;
109 }
110
111 /// Increments.
112 iterator_
113 operator++(int)
114 {
115 iterator_ ret =* this;
116 base_type::m_p_tbl->inc_it_state(base_type::m_p_value, base_type::m_pos);
117 return ret;
118 }
119
120protected:
121 typedef const_iterator_ base_type;
122
123 /**
124 * Constructor used by the table to initiate the generalized
125 * pointer and position (e.g., this is called from within a find()
126 * of a table.
127 * */
128 inline
129 iterator_(pointer p_value, PB_DS_GEN_POS pos, PB_DS_CLASS_C_DEC* p_tbl)
130 : const_iterator_(p_value, pos, p_tbl)
131 { }
132
133 friend class PB_DS_CLASS_C_DEC;
134};
135#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