3 // Copyright (C) 2005, 2006 Free Software Foundation, Inc.
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 2, or (at your option) any later
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.
16 // You should have received a copy of the GNU General Public License
17 // along with this library; see the file COPYING. If not, write to
18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
19 // MA 02111-1307, USA.
21 // As a special exception, you may use this file as part of a free
22 // software library without restriction. Specifically, if other files
23 // instantiate templates or use macros or inline functions from this
24 // file, or you compile this file and link it with other files to
25 // produce an executable, this file does not by itself cause the
26 // resulting executable to be covered by the GNU General Public
27 // License. This exception does not however invalidate any other
28 // reasons why the executable file might be covered by the GNU General
31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
33 // Permission to use, copy, modify, sell, and distribute this software
34 // is hereby granted without fee, provided that the above copyright
35 // notice appears in all copies, and that both that copyright notice
36 // and this permission notice appear in supporting documentation. None
37 // of the above authors, nor IBM Haifa Research Laboratories, make any
38 // representation about the suitability of this software for any
39 // purpose. It is provided "as is" without express or implied
43 * @file node_iterators.hpp
44 * Contains an implementation class for ov_tree_.
47 #ifndef PB_DS_OV_TREE_NODE_ITERATORS_HPP
48 #define PB_DS_OV_TREE_NODE_ITERATORS_HPP
50 #include <ext/pb_ds/tag_and_trait.hpp>
51 #include <ext/pb_ds/detail/type_utils.hpp>
52 #include <debug/debug.h>
59 #define PB_DS_STATIC_ASSERT(UNIQUE, E) \
61 static_assert_dumclass<sizeof(static_assert<(bool)(E)>)> \
62 UNIQUE##static_assert_type
64 #define PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC \
65 ov_tree_node_const_it_<Value_Type, Metadata_Type, Allocator>
67 // Const node reference.
68 template<typename Value_Type
, typename Metadata_Type
, class Allocator
>
69 class ov_tree_node_const_it_
74 typename
Allocator::template rebind
<
75 Value_Type
>::other::pointer
79 typename
Allocator::template rebind
<
80 Value_Type
>::other::const_pointer
84 typename
Allocator::template rebind
<
85 Metadata_Type
>::other::const_pointer
86 const_metadata_pointer
;
88 typedef PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC this_type
;
92 template<typename Ptr
>
94 mid_pointer(Ptr p_begin
, Ptr p_end
)
96 _GLIBCXX_DEBUG_ASSERT(p_end
>= p_begin
);
97 return (p_begin
+ (p_end
- p_begin
) / 2);
102 typedef trivial_iterator_tag iterator_category
;
104 typedef trivial_iterator_difference_type difference_type
;
107 typename
Allocator::template rebind
<
108 Value_Type
>::other::const_pointer
112 typename
Allocator::template rebind
<
113 typename remove_const
<
114 Value_Type
>::type
>::other::const_pointer
118 typename
Allocator::template rebind
<
119 typename remove_const
<
120 Value_Type
>::type
>::other::const_pointer
123 typedef Metadata_Type metadata_type
;
126 typename
Allocator::template rebind
<
127 metadata_type
>::other::const_reference
128 const_metadata_reference
;
132 ov_tree_node_const_it_(const_pointer p_nd
= NULL
, const_pointer p_begin_nd
= NULL
, const_pointer p_end_nd
= NULL
, const_metadata_pointer p_metadata
= NULL
) : m_p_value(const_cast<pointer
>(p_nd
)), m_p_begin_value(const_cast<pointer
>(p_begin_nd
)), m_p_end_value(const_cast<pointer
>(p_end_nd
)), m_p_metadata(p_metadata
)
135 inline const_reference
137 { return m_p_value
; }
139 inline const_metadata_reference
144 has_metadata
= !is_same
<Metadata_Type
, null_node_metadata
>::value
147 PB_DS_STATIC_ASSERT(should_have_metadata
, has_metadata
);
148 _GLIBCXX_DEBUG_ASSERT(m_p_metadata
!= NULL
);
149 return *m_p_metadata
;
155 if (m_p_begin_value
== m_p_value
)
156 return (this_type(m_p_begin_value
, m_p_begin_value
, m_p_begin_value
));
158 const_metadata_pointer p_begin_metadata
=
159 m_p_metadata
- (m_p_value
- m_p_begin_value
);
161 return (this_type(mid_pointer(m_p_begin_value
, m_p_value
),
164 mid_pointer(p_begin_metadata
, m_p_metadata
)));
170 if (m_p_value
== m_p_end_value
)
171 return (this_type(m_p_end_value
, m_p_end_value
, m_p_end_value
));
173 const_metadata_pointer p_end_metadata
=
174 m_p_metadata
+ (m_p_end_value
- m_p_value
);
176 return (this_type(mid_pointer(m_p_value
+ 1, m_p_end_value
),
178 m_p_end_value
,(m_p_metadata
== NULL
) ?
179 NULL
: mid_pointer(m_p_metadata
+ 1, p_end_metadata
)));
183 operator==(const this_type
& other
) const
185 const bool is_end
= m_p_begin_value
== m_p_end_value
;
186 const bool is_other_end
= other
.m_p_begin_value
== other
.m_p_end_value
;
189 return (is_other_end
);
194 return m_p_value
== other
.m_p_value
;
198 operator!=(const this_type
& other
) const
199 { return !operator==(other
); }
203 pointer m_p_begin_value
;
204 pointer m_p_end_value
;
206 const_metadata_pointer m_p_metadata
;
209 #define PB_DS_OV_TREE_NODE_ITERATOR_C_DEC \
210 ov_tree_node_it_<Value_Type, Metadata_Type, Allocator>
213 template<typename Value_Type
, typename Metadata_Type
, class Allocator
>
214 class ov_tree_node_it_
: public PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC
218 typedef PB_DS_OV_TREE_NODE_ITERATOR_C_DEC this_type
;
220 typedef PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC base_type
;
222 typedef typename
base_type::pointer pointer
;
224 typedef typename
base_type::const_pointer const_pointer
;
227 typename
base_type::const_metadata_pointer
228 const_metadata_pointer
;
232 typedef trivial_iterator_tag iterator_category
;
234 typedef trivial_iterator_difference_type difference_type
;
237 typename
Allocator::template rebind
<
238 Value_Type
>::other::pointer
242 typename
Allocator::template rebind
<
243 typename remove_const
<
244 Value_Type
>::type
>::other::pointer
248 typename
Allocator::template rebind
<
249 typename remove_const
<
250 Value_Type
>::type
>::other::pointer
255 ov_tree_node_it_(const_pointer p_nd
= NULL
, const_pointer p_begin_nd
= NULL
, const_pointer p_end_nd
= NULL
, const_metadata_pointer p_metadata
= NULL
) : base_type( p_nd
, p_begin_nd
, p_end_nd
, p_metadata
)
261 { return reference(base_type::m_p_value
); }
263 // Returns the node reference associated with the left node.
264 inline ov_tree_node_it_
267 if (base_type::m_p_begin_value
== base_type::m_p_value
)
268 return (this_type(base_type::m_p_begin_value
, base_type::m_p_begin_value
, base_type::m_p_begin_value
));
270 const_metadata_pointer p_begin_metadata
=
271 base_type::m_p_metadata
- (base_type::m_p_value
- base_type::m_p_begin_value
);
273 return (this_type(base_type::mid_pointer(base_type::m_p_begin_value
, base_type::m_p_value
),
274 base_type::m_p_begin_value
,
275 base_type::m_p_value
,
276 base_type::mid_pointer(p_begin_metadata
, base_type::m_p_metadata
)));
279 // Returns the node reference associated with the right node.
280 inline ov_tree_node_it_
283 if (base_type::m_p_value
== base_type::m_p_end_value
)
284 return (this_type(base_type::m_p_end_value
, base_type::m_p_end_value
, base_type::m_p_end_value
));
286 const_metadata_pointer p_end_metadata
=
287 base_type::m_p_metadata
+ (base_type::m_p_end_value
- base_type::m_p_value
);
289 return (this_type(base_type::mid_pointer(base_type::m_p_value
+ 1, base_type::m_p_end_value
),
290 base_type::m_p_value
+ 1,
291 base_type::m_p_end_value
,(base_type::m_p_metadata
== NULL
)?
292 NULL
: base_type::mid_pointer(base_type::m_p_metadata
+ 1, p_end_metadata
)));
297 #undef PB_DS_OV_TREE_NODE_ITERATOR_C_DEC
298 #undef PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC
299 #undef PB_DS_STATIC_ASSERT
301 } // namespace detail