1 // -*- C++ -*-
2 
3 // Copyright (C) 2005-2022 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_/point_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_FIND_ITERATOR_HPP
43 #define PB_DS_BINARY_HEAP_CONST_FIND_ITERATOR_HPP
44 
45 #include <ext/pb_ds/tag_and_trait.hpp>
46 #include <debug/debug.h>
47 
48 namespace __gnu_pbds
49 {
50   namespace detail
51   {
52     /// Const point-type iterator.
53     template<typename Value_Type, typename Entry, bool Simple,
54                typename _Alloc>
55     class binary_heap_point_const_iterator_
56     {
57     protected:
58       typedef typename rebind_traits<_Alloc, Entry>::pointer entry_pointer;
59 
60     public:
61       /// Category.
62       typedef trivial_iterator_tag iterator_category;
63 
64       /// Difference type.
65       typedef trivial_iterator_difference_type difference_type;
66 
67       /// Iterator's value type.
68       typedef Value_Type value_type;
69 
70       /// Iterator's pointer type.
71       typedef typename rebind_traits<_Alloc, value_type>::pointer pointer;
72 
73       /// Iterator's const pointer type.
74       typedef typename rebind_traits<_Alloc, value_type>::const_pointer
75           const_pointer;
76 
77       /// Iterator's reference type.
78       typedef typename rebind_traits<_Alloc, value_type>::reference
79           reference;
80 
81       /// Iterator's const reference type.
82       typedef typename rebind_traits<_Alloc, value_type>::const_reference
83           const_reference;
84 
85       inline
binary_heap_point_const_iterator_(entry_pointer p_e)86       binary_heap_point_const_iterator_(entry_pointer p_e) : m_p_e(p_e)
87       { }
88 
89       /// Default constructor.
90       inline
binary_heap_point_const_iterator_()91       binary_heap_point_const_iterator_() : m_p_e(0) { }
92 
93       /// Copy constructor.
94       inline
binary_heap_point_const_iterator_(const binary_heap_point_const_iterator_ & other)95       binary_heap_point_const_iterator_(const binary_heap_point_const_iterator_& other)
96       : m_p_e(other.m_p_e)
97       { }
98 
99       /// Access.
100       inline const_pointer
operator ->() const101       operator->() const
102       {
103           _GLIBCXX_DEBUG_ASSERT(m_p_e != 0);
104           return to_ptr(integral_constant<int, Simple>());
105       }
106 
107       /// Access.
108       inline const_reference
operator *() const109       operator*() const
110       {
111           _GLIBCXX_DEBUG_ASSERT(m_p_e != 0);
112           return *to_ptr(integral_constant<int, Simple>());
113       }
114 
115       /// Compares content to a different iterator object.
116       inline bool
operator ==(const binary_heap_point_const_iterator_ & other) const117       operator==(const binary_heap_point_const_iterator_& other) const
118       { return m_p_e == other.m_p_e; }
119 
120       /// Compares content (negatively) to a different iterator object.
121       inline bool
operator !=(const binary_heap_point_const_iterator_ & other) const122       operator!=(const binary_heap_point_const_iterator_& other) const
123       { return m_p_e != other.m_p_e; }
124 
125     private:
126       inline const_pointer
to_ptr(true_type) const127       to_ptr(true_type) const
128       { return m_p_e; }
129 
130       inline const_pointer
to_ptr(false_type) const131       to_ptr(false_type) const
132       { return *m_p_e; }
133 
134     public:
135       entry_pointer m_p_e;
136     };
137   } // namespace detail
138 } // namespace __gnu_pbds
139 
140 #endif
141