3 // Copyright (C) 2005-2019 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 ov_tree_map_/ov_tree_map_.hpp
38 * Contains an implementation class for ov_tree.
43 #include <ext/pb_ds/exception.hpp>
44 #include <ext/pb_ds/tree_policy.hpp>
45 #include <ext/pb_ds/detail/eq_fn/eq_by_less.hpp>
46 #include <ext/pb_ds/detail/types_traits.hpp>
47 #include <ext/pb_ds/detail/type_utils.hpp>
48 #include <ext/pb_ds/detail/tree_trace_base.hpp>
50 #include <ext/pb_ds/detail/debug_map_base.hpp>
57 #include <debug/debug.h>
63 #ifdef PB_DS_DATA_TRUE_INDICATOR
64 #define PB_DS_OV_TREE_NAME ov_tree_map
65 #define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_node_const_iterator_map
68 #ifdef PB_DS_DATA_FALSE_INDICATOR
69 #define PB_DS_OV_TREE_NAME ov_tree_set
70 #define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_node_const_iterator_set
73 #define PB_DS_CLASS_T_DEC \
74 template<typename Key, typename Mapped, typename Cmp_Fn, \
75 typename Node_And_It_Traits, typename _Alloc>
77 #define PB_DS_CLASS_C_DEC \
78 PB_DS_OV_TREE_NAME<Key, Mapped, Cmp_Fn, Node_And_It_Traits, _Alloc>
80 #define PB_DS_OV_TREE_TRAITS_BASE \
81 types_traits<Key, Mapped, _Alloc, false>
84 #define PB_DS_DEBUG_MAP_BASE_C_DEC \
85 debug_map_base<Key, eq_by_less<Key, Cmp_Fn>, \
86 typename _Alloc::template rebind<Key>::other::const_reference>
89 #ifdef PB_DS_TREE_TRACE
90 #define PB_DS_TREE_TRACE_BASE_C_DEC \
91 tree_trace_base<typename Node_And_It_Traits::node_const_iterator, \
92 typename Node_And_It_Traits::node_iterator, \
93 Cmp_Fn, false, _Alloc>
96 #ifndef PB_DS_CHECK_KEY_EXISTS
97 # error Missing definition
101 * @brief Ordered-vector tree associative-container.
102 * @ingroup branch-detail
104 template<typename Key, typename Mapped, typename Cmp_Fn,
105 typename Node_And_It_Traits, typename _Alloc>
106 class PB_DS_OV_TREE_NAME :
107 #ifdef _GLIBCXX_DEBUG
108 protected PB_DS_DEBUG_MAP_BASE_C_DEC,
110 #ifdef PB_DS_TREE_TRACE
111 public PB_DS_TREE_TRACE_BASE_C_DEC,
114 public Node_And_It_Traits::node_update,
115 public PB_DS_OV_TREE_TRAITS_BASE
118 typedef PB_DS_OV_TREE_TRAITS_BASE traits_base;
119 typedef Node_And_It_Traits traits_type;
121 typedef typename remove_const<typename traits_base::value_type>::type non_const_value_type;
123 typedef typename _Alloc::template rebind<non_const_value_type>::other value_allocator;
124 typedef typename value_allocator::pointer value_vector;
126 #ifdef _GLIBCXX_DEBUG
127 typedef PB_DS_DEBUG_MAP_BASE_C_DEC debug_base;
130 #ifdef PB_DS_TREE_TRACE
131 typedef PB_DS_TREE_TRACE_BASE_C_DEC trace_base;
134 typedef typename traits_base::pointer mapped_pointer_;
135 typedef typename traits_base::const_pointer mapped_const_pointer_;
137 typedef typename traits_type::metadata_type metadata_type;
139 typedef typename _Alloc::template rebind<metadata_type>::other metadata_allocator;
140 typedef typename metadata_allocator::pointer metadata_pointer;
141 typedef typename metadata_allocator::const_reference metadata_const_reference;
142 typedef typename metadata_allocator::reference metadata_reference;
144 typedef typename traits_type::null_node_update_pointer
145 null_node_update_pointer;
148 typedef ov_tree_tag container_category;
149 typedef _Alloc allocator_type;
150 typedef typename _Alloc::size_type size_type;
151 typedef typename _Alloc::difference_type difference_type;
152 typedef Cmp_Fn cmp_fn;
154 typedef typename traits_base::key_type key_type;
155 typedef typename traits_base::key_pointer key_pointer;
156 typedef typename traits_base::key_const_pointer key_const_pointer;
157 typedef typename traits_base::key_reference key_reference;
158 typedef typename traits_base::key_const_reference key_const_reference;
159 typedef typename traits_base::mapped_type mapped_type;
160 typedef typename traits_base::mapped_pointer mapped_pointer;
161 typedef typename traits_base::mapped_const_pointer mapped_const_pointer;
162 typedef typename traits_base::mapped_reference mapped_reference;
163 typedef typename traits_base::mapped_const_reference mapped_const_reference;
164 typedef typename traits_base::value_type value_type;
165 typedef typename traits_base::pointer pointer;
166 typedef typename traits_base::const_pointer const_pointer;
167 typedef typename traits_base::reference reference;
168 typedef typename traits_base::const_reference const_reference;
170 typedef const_pointer point_const_iterator;
171 #ifdef PB_DS_DATA_TRUE_INDICATOR
172 typedef pointer point_iterator;
174 typedef point_const_iterator point_iterator;
177 typedef point_iterator iterator;
178 typedef point_const_iterator const_iterator;
180 /// Conditional destructor.
181 template<typename Size_Type>
185 cond_dtor(value_vector a_vec, iterator& r_last_it,
186 Size_Type total_size)
187 : m_a_vec(a_vec), m_r_last_it(r_last_it), m_max_size(total_size),
195 iterator it = m_a_vec;
196 while (it != m_r_last_it)
203 value_allocator().deallocate(m_a_vec, m_max_size);
208 { m_no_action = true; }
211 value_vector m_a_vec;
212 iterator& m_r_last_it;
213 const Size_Type m_max_size;
217 typedef typename traits_type::node_update node_update;
218 typedef typename traits_type::node_iterator node_iterator;
219 typedef typename traits_type::node_const_iterator node_const_iterator;
222 PB_DS_OV_TREE_NAME();
224 PB_DS_OV_TREE_NAME(const Cmp_Fn&);
226 PB_DS_OV_TREE_NAME(const Cmp_Fn&, const node_update&);
228 PB_DS_OV_TREE_NAME(const PB_DS_CLASS_C_DEC&);
230 ~PB_DS_OV_TREE_NAME();
233 swap(PB_DS_CLASS_C_DEC&);
235 template<typename It>
237 copy_from_range(It, It);
254 inline mapped_reference
255 operator[](key_const_reference r_key)
257 #ifdef PB_DS_DATA_TRUE_INDICATOR
258 PB_DS_ASSERT_VALID((*this))
259 point_iterator it = lower_bound(r_key);
260 if (it != end() && !Cmp_Fn::operator()(r_key, PB_DS_V2F(*it)))
262 PB_DS_CHECK_KEY_EXISTS(r_key)
263 PB_DS_ASSERT_VALID((*this))
266 return insert_new_val(it, std::make_pair(r_key, mapped_type()))->second;
269 return traits_base::s_null_type;
273 inline std::pair<point_iterator, bool>
274 insert(const_reference r_value)
276 PB_DS_ASSERT_VALID((*this))
277 key_const_reference r_key = PB_DS_V2F(r_value);
278 point_iterator it = lower_bound(r_key);
280 if (it != end()&& !Cmp_Fn::operator()(r_key, PB_DS_V2F(*it)))
282 PB_DS_ASSERT_VALID((*this))
283 PB_DS_CHECK_KEY_EXISTS(r_key)
284 return std::make_pair(it, false);
287 return std::make_pair(insert_new_val(it, r_value), true);
290 inline point_iterator
291 lower_bound(key_const_reference r_key)
293 pointer it = m_a_values;
294 pointer e_it = m_a_values + m_size;
297 pointer mid_it = it + ((e_it - it) >> 1);
298 if (cmp_fn::operator()(PB_DS_V2F(*mid_it), r_key))
306 inline point_const_iterator
307 lower_bound(key_const_reference r_key) const
308 { return const_cast<PB_DS_CLASS_C_DEC& >(*this).lower_bound(r_key); }
310 inline point_iterator
311 upper_bound(key_const_reference r_key)
313 iterator pot_it = lower_bound(r_key);
314 if (pot_it != end() && !Cmp_Fn::operator()(r_key, PB_DS_V2F(*pot_it)))
316 PB_DS_CHECK_KEY_EXISTS(r_key)
320 PB_DS_CHECK_KEY_DOES_NOT_EXIST(r_key)
324 inline point_const_iterator
325 upper_bound(key_const_reference r_key) const
326 { return const_cast<PB_DS_CLASS_C_DEC&>(*this).upper_bound(r_key); }
328 inline point_iterator
329 find(key_const_reference r_key)
331 PB_DS_ASSERT_VALID((*this))
332 iterator pot_it = lower_bound(r_key);
333 if (pot_it != end() && !Cmp_Fn::operator()(r_key, PB_DS_V2F(*pot_it)))
335 PB_DS_CHECK_KEY_EXISTS(r_key)
339 PB_DS_CHECK_KEY_DOES_NOT_EXIST(r_key)
343 inline point_const_iterator
344 find(key_const_reference r_key) const
345 { return (const_cast<PB_DS_CLASS_C_DEC&>(*this).find(r_key)); }
348 erase(key_const_reference);
350 template<typename Pred>
356 { return erase_imp<iterator>(it); }
362 join(PB_DS_CLASS_C_DEC&);
365 split(key_const_reference, PB_DS_CLASS_C_DEC&);
369 { return m_a_values; }
371 inline const_iterator
373 { return m_a_values; }
379 inline const_iterator
383 /// Returns a const node_iterator corresponding to the node at the
384 /// root of the tree.
385 inline node_const_iterator
388 /// Returns a node_iterator corresponding to the node at the
389 /// root of the tree.
393 /// Returns a const node_iterator corresponding to a node just
394 /// after a leaf of the tree.
395 inline node_const_iterator
398 /// Returns a node_iterator corresponding to a node just
399 /// after a leaf of the tree.
406 update(node_iterator, null_node_update_pointer);
408 template<typename Node_Update>
410 update(node_iterator, Node_Update*);
413 reallocate_metadata(null_node_update_pointer, size_type);
415 template<typename Node_Update_>
417 reallocate_metadata(Node_Update_*, size_type);
419 template<typename It>
421 copy_from_ordered_range(It, It);
424 value_swap(PB_DS_CLASS_C_DEC&);
426 template<typename It>
428 copy_from_ordered_range(It, It, It, It);
430 template<typename Ptr>
432 mid_pointer(Ptr p_begin, Ptr p_end)
434 _GLIBCXX_DEBUG_ASSERT(p_end >= p_begin);
435 return (p_begin + (p_end - p_begin) / 2);
439 insert_new_val(iterator it, const_reference r_value)
441 #ifdef PB_DS_REGRESSION
442 typename _Alloc::group_adjustor adjust(m_size);
445 PB_DS_CHECK_KEY_DOES_NOT_EXIST(PB_DS_V2F(r_value))
447 value_vector a_values = s_value_alloc.allocate(m_size + 1);
449 iterator source_it = begin();
450 iterator source_end_it = end();
451 iterator target_it = a_values;
454 cond_dtor<size_type> cd(a_values, target_it, m_size + 1);
455 while (source_it != it)
457 new (const_cast<void*>(static_cast<const void*>(target_it)))
458 value_type(*source_it++);
462 new (const_cast<void*>(static_cast<const void*>(ret_it = target_it)))
466 while (source_it != source_end_it)
468 new (const_cast<void*>(static_cast<const void*>(target_it)))
469 value_type(*source_it++);
473 reallocate_metadata((node_update*)this, m_size + 1);
477 cond_dtor<size_type> cd1(m_a_values, m_end_it, m_size);
481 m_a_values = a_values;
482 m_end_it = m_a_values + m_size;
483 _GLIBCXX_DEBUG_ONLY(debug_base::insert_new(PB_DS_V2F(r_value)));
484 update(node_begin(), (node_update* )this);
485 PB_DS_ASSERT_VALID((*this))
489 #ifdef _GLIBCXX_DEBUG
491 assert_valid(const char*, int) const;
494 assert_iterators(const char*, int) const;
497 template<typename It>
501 inline node_const_iterator
502 PB_DS_node_begin_imp() const;
504 inline node_const_iterator
505 PB_DS_node_end_imp() const;
508 PB_DS_node_begin_imp();
511 PB_DS_node_end_imp();
514 static value_allocator s_value_alloc;
515 static metadata_allocator s_metadata_alloc;
517 value_vector m_a_values;
518 metadata_pointer m_a_metadata;
523 #include <ext/pb_ds/detail/ov_tree_map_/constructors_destructor_fn_imps.hpp>
524 #include <ext/pb_ds/detail/ov_tree_map_/iterators_fn_imps.hpp>
525 #include <ext/pb_ds/detail/ov_tree_map_/debug_fn_imps.hpp>
526 #include <ext/pb_ds/detail/ov_tree_map_/erase_fn_imps.hpp>
527 #include <ext/pb_ds/detail/ov_tree_map_/insert_fn_imps.hpp>
528 #include <ext/pb_ds/detail/ov_tree_map_/info_fn_imps.hpp>
529 #include <ext/pb_ds/detail/ov_tree_map_/split_join_fn_imps.hpp>
530 #include <ext/pb_ds/detail/bin_search_tree_/policy_access_fn_imps.hpp>
532 #undef PB_DS_CLASS_C_DEC
533 #undef PB_DS_CLASS_T_DEC
534 #undef PB_DS_OV_TREE_NAME
535 #undef PB_DS_OV_TREE_TRAITS_BASE
536 #undef PB_DS_DEBUG_MAP_BASE_C_DEC
537 #ifdef PB_DS_TREE_TRACE
538 #undef PB_DS_TREE_TRACE_BASE_C_DEC
540 #undef PB_DS_CONST_NODE_ITERATOR_NAME
541 } // namespace detail
542 } // namespace __gnu_pbds