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