libstdc++
unordered_iterator/const_iterator.hpp
Go to the documentation of this file.
1// -*- C++ -*-
2
3// Copyright (C) 2005-2021 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/const_iterator.hpp
38 * Contains an iterator class used for const 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/// Const range-type iterator.
47class const_iterator_
48: public point_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 const_iterator_() : m_p_tbl(0)
74 { }
75
76 /// Increments.
77 const_iterator_&
78 operator++()
79 {
80 m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
81 return *this;
82 }
83
84 /// Increments.
85 const_iterator_
86 operator++(int)
87 {
88 const_iterator_ ret =* this;
89 m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
90 return ret;
91 }
92
93protected:
94 typedef point_const_iterator_ base_type;
95
96 /**
97 * Constructor used by the table to initiate the generalized
98 * pointer and position (e.g., this is called from within a find()
99 * of a table.
100 * */
101 const_iterator_(const_pointer_ p_value, PB_DS_GEN_POS pos,
102 const PB_DS_CLASS_C_DEC* p_tbl)
103 : point_const_iterator_(p_value), m_p_tbl(p_tbl), m_pos(pos)
104 { }
105
106 /**
107 * Pointer to the table object which created the iterator (used for
108 * incrementing its position.
109 * */
110 const PB_DS_CLASS_C_DEC* m_p_tbl;
111
112 PB_DS_GEN_POS m_pos;
113
114 friend class PB_DS_CLASS_C_DEC;
115};
116#endif
Forward iterators support a superset of input iterator operations.