3 // Copyright (C) 2005-2022 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 3, 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 // 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.
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/>.
25 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
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
37 * @file bin_search_tree_/node_iterators.hpp
38 * Contains an implementation class for bin_search_tree_.
41 #ifndef PB_DS_BIN_SEARCH_TREE_NODE_ITERATORS_HPP
42 #define PB_DS_BIN_SEARCH_TREE_NODE_ITERATORS_HPP
44 #include <ext/pb_ds/tag_and_trait.hpp>
50 #define PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC \
51 bin_search_tree_const_node_it_<Node, Const_Iterator, Iterator, _Alloc>
53 /// Const node iterator.
54 template<typename Node,
58 class bin_search_tree_const_node_it_
61 typedef typename rebind_traits<_Alloc, Node>::pointer node_pointer;
65 typedef trivial_iterator_tag iterator_category;
68 typedef trivial_iterator_difference_type difference_type;
70 /// Iterator's value type.
71 typedef Const_Iterator value_type;
73 /// Iterator's reference type.
74 typedef Const_Iterator reference;
76 /// Iterator's __const reference type.
77 typedef Const_Iterator const_reference;
80 typedef typename Node::metadata_type metadata_type;
82 /// Const metadata reference type.
83 typedef typename rebind_traits<_Alloc, metadata_type>::const_reference
84 metadata_const_reference;
87 bin_search_tree_const_node_it_(const node_pointer p_nd = 0)
88 : m_p_nd(const_cast<node_pointer>(p_nd))
94 { return Const_Iterator(m_p_nd); }
97 metadata_const_reference
99 { return m_p_nd->get_metadata(); }
101 /// Returns the __const node iterator associated with the left node.
102 PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
104 { return PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC(m_p_nd->m_p_left); }
106 /// Returns the __const node iterator associated with the right node.
107 PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
109 { return PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC(m_p_nd->m_p_right); }
111 /// Compares to a different iterator object.
113 operator==(const PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC& other) const
114 { return m_p_nd == other.m_p_nd; }
116 /// Compares (negatively) to a different iterator object.
118 operator!=(const PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC& other) const
119 { return m_p_nd != other.m_p_nd; }
124 #define PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC \
125 bin_search_tree_node_it_<Node, Const_Iterator, Iterator, _Alloc>
128 template<typename Node,
129 class Const_Iterator,
132 class bin_search_tree_node_it_
133 : public PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
136 typedef typename rebind_traits<_Alloc, Node>::pointer node_pointer;
139 /// Iterator's value type.
140 typedef Iterator value_type;
142 /// Iterator's reference type.
143 typedef Iterator reference;
145 /// Iterator's __const reference type.
146 typedef Iterator const_reference;
149 bin_search_tree_node_it_(const node_pointer p_nd = 0)
150 : PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC(const_cast<node_pointer>(p_nd))
156 { return Iterator(PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC::m_p_nd); }
158 /// Returns the node iterator associated with the left node.
159 PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC
162 return PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC(
163 PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC::m_p_nd->m_p_left);
166 /// Returns the node iterator associated with the right node.
167 PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC
170 return PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC(
171 PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC::m_p_nd->m_p_right);
176 #undef PB_DS_TREE_CONST_NODE_ITERATOR_CLASS_C_DEC
177 #undef PB_DS_TREE_NODE_ITERATOR_CLASS_C_DEC
179 } // namespace detail
180 } // namespace __gnu_pbds
182 #endif // #ifndef PB_DS_BIN_SEARCH_TREE_NODE_ITERATORS_HPP