libstdc++: const_iterator.hpp Source File

libstdc++

binary_heap_/const_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 binary_heap_/const_iterator.hpp
38 * Contains an iterator class returned by the table's const find and insert
39 * methods.
40 */
41
42#ifndef PB_DS_BINARY_HEAP_CONST_ITERATOR_HPP
43#define PB_DS_BINARY_HEAP_CONST_ITERATOR_HPP
44
45#include <ext/pb_ds/detail/binary_heap_/point_const_iterator.hpp>
46#include <debug/debug.h>
47
48namespace __gnu_pbds
49{
50 namespace detail
51 {
52#define PB_DS_BIN_HEAP_CIT_BASE \
53 binary_heap_point_const_iterator_<Value_Type, Entry, Simple, _Alloc>
54
55 /// Const point-type iterator.
56 template<typename Value_Type,
57 typename Entry,
58 bool Simple,
59 typename _Alloc>
60 class binary_heap_const_iterator_ : public PB_DS_BIN_HEAP_CIT_BASE
61 {
62 private:
63 typedef PB_DS_BIN_HEAP_CIT_BASE base_type;
64 typedef typename base_type::entry_pointer entry_pointer;
65
66 public:
67 /// Category.
68 typedef std::forward_iterator_tag iterator_category;
69
70 /// Difference type.
71 typedef typename _Alloc::difference_type difference_type;
72
73 /// Iterator's value type.
74 typedef typename base_type::value_type value_type;
75
76 /// Iterator's pointer type.
77 typedef typename base_type::pointer pointer;
78
79 /// Iterator's const pointer type.
80 typedef typename base_type::const_pointer const_pointer;
81
82 /// Iterator's reference type.
83 typedef typename base_type::reference reference;
84
85 /// Iterator's const reference type.
86 typedef typename base_type::const_reference const_reference;
87
88 inline
89 binary_heap_const_iterator_(entry_pointer p_e) : base_type(p_e)
90 { }
91
92 /// Default constructor.
93 inline
94 binary_heap_const_iterator_()
95 { }
96
97 /// Copy constructor.
98 inline
99 binary_heap_const_iterator_(const binary_heap_const_iterator_& other)
100 : base_type(other)
101 { }
102
103 /// Compares content to a different iterator object.
104 inline bool
105 operator==(const binary_heap_const_iterator_& other) const
106 { return base_type::m_p_e == other.m_p_e; }
107
108 /// Compares content (negatively) to a different iterator object.
109 inline bool
110 operator!=(const binary_heap_const_iterator_& other) const
111 { return base_type::m_p_e != other.m_p_e; }
112
113 inline binary_heap_const_iterator_&
114 operator++()
115 {
116 _GLIBCXX_DEBUG_ASSERT(base_type::m_p_e != 0);
117 inc();
118 return *this;
119 }
120
121 inline binary_heap_const_iterator_
122 operator++(int)
123 {
124 binary_heap_const_iterator_ ret_it(base_type::m_p_e);
125 operator++();
126 return ret_it;
127 }
128
129 private:
130 void
131 inc()
132 { ++base_type::m_p_e; }
133 };
134
135#undef PB_DS_BIN_HEAP_CIT_BASE
136 } // namespace detail
137} // namespace __gnu_pbds
138
139#endif
debug.h
__gnu_pbds
GNU extensions for policy-based data structures for public use.
Definition assoc_container.hpp:52
std::forward_iterator_tag
Forward iterators support a superset of input iterator operations.
Definition stl_iterator_base_types.h:101
__gnu_pbds::detail::binary_heap_const_iterator_
Const point-type iterator.
Definition binary_heap_/const_iterator.hpp:61
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::pointer
base_type::pointer pointer
Definition binary_heap_/const_iterator.hpp:77
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::const_reference
base_type::const_reference const_reference
Definition binary_heap_/const_iterator.hpp:86
__gnu_pbds::detail::binary_heap_const_iterator_::operator==
bool operator==(const binary_heap_const_iterator_ &other) const
Compares content to a different iterator object.
Definition binary_heap_/const_iterator.hpp:105
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::difference_type
_Alloc::difference_type difference_type
Definition binary_heap_/const_iterator.hpp:71
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::const_pointer
base_type::const_pointer const_pointer
Definition binary_heap_/const_iterator.hpp:80
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::iterator_category
std::forward_iterator_tag iterator_category
Definition binary_heap_/const_iterator.hpp:68
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::reference
base_type::reference reference
Definition binary_heap_/const_iterator.hpp:83
__gnu_pbds::detail::binary_heap_const_iterator_::operator!=
bool operator!=(const binary_heap_const_iterator_ &other) const
Compares content (negatively) to a different iterator object.
Definition binary_heap_/const_iterator.hpp:110
__gnu_pbds::detail::binary_heap_const_iterator_::binary_heap_const_iterator_
binary_heap_const_iterator_(const binary_heap_const_iterator_ &other)
Copy constructor.
Definition binary_heap_/const_iterator.hpp:99
__gnu_pbds::detail::binary_heap_const_iterator_::binary_heap_const_iterator_
binary_heap_const_iterator_()
Default constructor.
Definition binary_heap_/const_iterator.hpp:94
__gnu_pbds::detail::binary_heap_const_iterator_< value_type, entry, simple_value, _Alloc >::value_type
base_type::value_type value_type
Definition binary_heap_/const_iterator.hpp:74
__gnu_pbds::detail::binary_heap_point_const_iterator_::const_pointer
rebind_traits< _Alloc, value_type >::const_pointer const_pointer
Iterator's const pointer type.
Definition binary_heap_/point_const_iterator.hpp:75
__gnu_pbds::detail::binary_heap_point_const_iterator_::pointer
rebind_traits< _Alloc, value_type >::pointer pointer
Iterator's pointer type.
Definition binary_heap_/point_const_iterator.hpp:71
__gnu_pbds::detail::binary_heap_point_const_iterator_::value_type
Value_Type value_type
Iterator's value type.
Definition binary_heap_/point_const_iterator.hpp:68
__gnu_pbds::detail::binary_heap_point_const_iterator_::reference
rebind_traits< _Alloc, value_type >::reference reference
Iterator's reference type.
Definition binary_heap_/point_const_iterator.hpp:79
__gnu_pbds::detail::binary_heap_point_const_iterator_::const_reference
rebind_traits< _Alloc, value_type >::const_reference const_reference
Iterator's const reference type.
Definition binary_heap_/point_const_iterator.hpp:83
point_const_iterator.hpp