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 bin_search_tree_.
47 #ifndef PB_DS_BIN_SEARCH_TREE_NODE_ITERATORS_HPP
48 #define PB_DS_BIN_SEARCH_TREE_NODE_ITERATORS_HPP
50 #include <ext/pb_ds/tag_and_trait.hpp>
57 #define PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC \
58 bin_search_tree_const_node_it_< \
64 // Const node iterator.
65 template<typename Node,
69 class bin_search_tree_const_node_it_
75 typename Allocator::template rebind<
82 typedef trivial_iterator_tag iterator_category;
85 typedef trivial_iterator_difference_type difference_type;
87 // __Iterator's value type.
88 typedef Const_Iterator value_type;
90 // __Iterator's reference type.
91 typedef Const_Iterator reference;
93 // __Iterator's __const reference type.
94 typedef Const_Iterator const_reference;
97 typedef typename Node::metadata_type metadata_type;
99 // Const metadata reference type.
101 typename Allocator::template rebind<
102 metadata_type>::other::const_reference
103 const_metadata_reference;
107 // Default constructor.
110 bin_search_tree_const_node_it_()
114 bin_search_tree_const_node_it_(const node_pointer p_nd = NULL) : m_p_nd(const_cast<node_pointer>(p_nd))
118 inline const_reference
121 return (Const_Iterator(m_p_nd));
125 inline const_metadata_reference
128 return (m_p_nd->get_metadata());
131 // Returns the __const node iterator associated with the left node.
132 inline PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
135 return (PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC(m_p_nd->m_p_left));
138 // Returns the __const node iterator associated with the right node.
139 inline PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
142 return (PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC(m_p_nd->m_p_right));
145 // Compares to a different iterator object.
147 operator==(const PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC& other) const
149 return (m_p_nd == other.m_p_nd);
152 // Compares (negatively) to a different iterator object.
154 operator!=(const PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC& other) const
156 return (m_p_nd != other.m_p_nd);
163 #define PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC \
164 bin_search_tree_node_it_< \
171 template<typename Node,
172 class Const_Iterator,
175 class bin_search_tree_node_it_ :
176 public PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
182 typename Allocator::template rebind<
183 Node>::other::pointer
188 // __Iterator's value type.
189 typedef Iterator value_type;
191 // __Iterator's reference type.
192 typedef Iterator reference;
194 // __Iterator's __const reference type.
195 typedef Iterator const_reference;
199 // Default constructor.
202 bin_search_tree_node_it_();
206 bin_search_tree_node_it_(const node_pointer p_nd = NULL) : PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC(
207 const_cast<node_pointer>(p_nd))
214 return (Iterator(PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC::m_p_nd));
217 // Returns the node iterator associated with the left node.
218 inline PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC
221 return (PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC(
222 PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC::m_p_nd->m_p_left));
225 // Returns the node iterator associated with the right node.
226 inline PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC
229 return (PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC(
230 PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC::m_p_nd->m_p_right));
235 #undef PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
237 #undef PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC
239 } // namespace detail
242 #endif // #ifndef PB_DS_BIN_SEARCH_TREE_NODE_ITERATORS_HPP