libstdc++
unordered_iterator/const_iterator.hpp
Go to the documentation of this file.
1 // -*- C++ -*-
2 
3 // Copyright (C) 2005-2017 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 
42 /// Const range-type iterator.
44 : public point_const_iterator_
45 {
46 public:
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.
70  { }
71 
72  /// Increments.
75  {
76  m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
77  return *this;
78  }
79 
80  /// Increments.
83  {
84  const_iterator_ ret =* this;
85  m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
86  return ret;
87  }
88 
89 protected:
91 
92  /**
93  * Constructor used by the table to initiate the generalized
94  * pointer and position (e.g., this is called from within a find()
95  * of a table.
96  * */
97  const_iterator_(const_pointer_ p_value, PB_DS_GEN_POS pos,
98  const PB_DS_CLASS_C_DEC* p_tbl)
99  : point_const_iterator_(p_value), m_p_tbl(p_tbl), m_pos(pos)
100  { }
101 
102  /**
103  * Pointer to the table object which created the iterator (used for
104  * incrementing its position.
105  * */
106  const PB_DS_CLASS_C_DEC* m_p_tbl;
107 
108  PB_DS_GEN_POS m_pos;
109 
110  friend class PB_DS_CLASS_C_DEC;
111 };
Const range-type iterator.
const_iterator_(const_pointer_ p_value, PB_DS_GEN_POS pos, const PB_DS_CLASS_C_DEC *p_tbl)
const_iterator_()
Default constructor.
const_iterator_ operator++(int)
Increments.
const_reference_ const_reference
Iterator&#39;s const reference type.
const PB_DS_CLASS_C_DEC * m_p_tbl
std::forward_iterator_tag iterator_category
Category.
const_pointer_ const_pointer
Iterator&#39;s const pointer type.
value_type_ value_type
Iterator&#39;s value type.
const_iterator_ & operator++()
Increments.
Forward iterators support a superset of input iterator operations.
pointer_ pointer
Iterator&#39;s pointer type.
_Alloc::difference_type difference_type
Difference type.
reference_ reference
Iterator&#39;s reference type.