1 // -*- C++ -*-
2 
3 // Copyright (C) 2005-2018 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 left_child_next_sibling_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_LEFT_CHILD_NEXT_SIBLING_HEAP_CONST_FIND_ITERATOR_HPP
43 #define PB_DS_LEFT_CHILD_NEXT_SIBLING_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 
53 #define PB_DS_CLASS_T_DEC			\
54     template<typename Node, typename _Alloc>
55 
56 #define PB_DS_CLASS_C_DEC \
57     left_child_next_sibling_heap_node_point_const_iterator_<Node, _Alloc>
58 
59     /// Const point-type iterator.
60     template<typename Node, typename _Alloc>
61     class left_child_next_sibling_heap_node_point_const_iterator_
62     {
63     protected:
64       typedef typename _Alloc::template rebind<Node>::other::pointer node_pointer;
65 
66     public:
67       /// Category.
68       typedef trivial_iterator_tag iterator_category;
69 
70       /// Difference type.
71       typedef trivial_iterator_difference_type difference_type;
72 
73       /// Iterator's value type.
74       typedef typename Node::value_type value_type;
75 
76       /// Iterator's pointer type.
77       typedef
78       typename _Alloc::template rebind<
79 	value_type>::other::pointer
80       pointer;
81 
82       /// Iterator's const pointer type.
83       typedef
84       typename _Alloc::template rebind<
85 	value_type>::other::const_pointer
86       const_pointer;
87 
88       /// Iterator's reference type.
89       typedef
90       typename _Alloc::template rebind<
91 	value_type>::other::reference
92       reference;
93 
94       /// Iterator's const reference type.
95       typedef
96       typename _Alloc::template rebind<
97 	value_type>::other::const_reference
98       const_reference;
99 
100       inline
101       left_child_next_sibling_heap_node_point_const_iterator_(node_pointer p_nd) : m_p_nd(p_nd)
102       { }
103 
104       /// Default constructor.
105       inline
106       left_child_next_sibling_heap_node_point_const_iterator_() : m_p_nd(0)
107       { }
108 
109       /// Copy constructor.
110       inline
111       left_child_next_sibling_heap_node_point_const_iterator_(const PB_DS_CLASS_C_DEC& other) : m_p_nd(other.m_p_nd)
112       { }
113 
114       /// Access.
115       const_pointer
116       operator->() const
117       {
118 	_GLIBCXX_DEBUG_ASSERT(m_p_nd != 0);
119 	return &m_p_nd->m_value;
120       }
121 
122       /// Access.
123       const_reference
124       operator*() const
125       {
126 	_GLIBCXX_DEBUG_ASSERT(m_p_nd != 0);
127 	return m_p_nd->m_value;
128       }
129 
130       /// Compares content to a different iterator object.
131       bool
132       operator==(const PB_DS_CLASS_C_DEC& other) const
133       { return m_p_nd == other.m_p_nd; }
134 
135       /// Compares content (negatively) to a different iterator object.
136       bool
137       operator!=(const PB_DS_CLASS_C_DEC& other) const
138       { return m_p_nd != other.m_p_nd; }
139 
140       node_pointer m_p_nd;
141     };
142 
143 #undef PB_DS_CLASS_T_DEC
144 #undef PB_DS_CLASS_C_DEC
145 
146   } // namespace detail
147 } // namespace __gnu_pbds
148 
149 #endif
150