3 // Copyright (C) 2005, 2006, 2009, 2011 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_.hpp
38 * Contains an implementation class for ov_tree_.
43 #include <ext/pb_ds/tree_policy.hpp>
44 #include <ext/pb_ds/detail/eq_fn/eq_by_less.hpp>
45 #include <ext/pb_ds/detail/types_traits.hpp>
46 #include <ext/pb_ds/detail/debug_map_base.hpp>
47 #include <ext/pb_ds/detail/type_utils.hpp>
48 #include <ext/pb_ds/exception.hpp>
49 #include <ext/pb_ds/detail/tree_trace_base.hpp>
55 #include <debug/debug.h>
61 #define PB_DS_CLASS_T_DEC \
62 template<typename Key, typename Mapped, class Cmp_Fn, \
63 class Node_And_It_Traits, class Allocator>
65 #ifdef PB_DS_DATA_TRUE_INDICATOR
66 #define PB_DS_OV_TREE_CLASS_NAME ov_tree_data_
69 #ifdef PB_DS_DATA_FALSE_INDICATOR
70 #define PB_DS_OV_TREE_CLASS_NAME ov_tree_no_data_
73 #ifdef PB_DS_DATA_TRUE_INDICATOR
74 #define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_const_node_iterator_data_
76 #define PB_DS_CONST_NODE_ITERATOR_NAME ov_tree_const_node_iterator_no_data_
79 #define PB_DS_CLASS_C_DEC \
80 PB_DS_OV_TREE_CLASS_NAME<Key, Mapped, Cmp_Fn, Node_And_It_Traits, Allocator>
82 #define PB_DS_TYPES_TRAITS_C_DEC \
83 types_traits<Key, Mapped, Allocator, false>
86 #define PB_DS_DEBUG_MAP_BASE_C_DEC \
87 debug_map_base<Key, eq_by_less<Key, Cmp_Fn>, \
88 typename Allocator::template rebind<Key>::other::const_reference>
91 #ifdef PB_DS_DATA_TRUE_INDICATOR
92 #define PB_DS_V2F(X) (X).first
93 #define PB_DS_V2S(X) (X).second
94 #define PB_DS_EP2VP(X)& ((X)->m_value)
97 #ifdef PB_DS_DATA_FALSE_INDICATOR
98 #define PB_DS_V2F(X) (X)
99 #define PB_DS_V2S(X) Mapped_Data()
100 #define PB_DS_EP2VP(X)& ((X)->m_value.first)
103 #ifdef PB_DS_TREE_TRACE
104 #define PB_DS_TREE_TRACE_BASE_C_DEC \
105 tree_trace_base<typename Node_And_It_Traits::const_node_iterator, \
106 typename Node_And_It_Traits::node_iterator, \
107 Cmp_Fn, false, Allocator>
110 #define PB_DS_ASSERT_VALID(X) \
111 _GLIBCXX_DEBUG_ONLY(X.assert_valid(__FILE__, __LINE__);)
113 #define PB_DS_CHECK_KEY_EXISTS(_Key) \
114 _GLIBCXX_DEBUG_ONLY(debug_base::check_key_exists(_Key, __FILE__, __LINE__);)
116 #define PB_DS_CHECK_KEY_DOES_NOT_EXIST(_Key) \
117 _GLIBCXX_DEBUG_ONLY(debug_base::check_key_does_not_exist(_Key, \
118 __FILE__, __LINE__);)
120 // Ordered-vector tree associative-container.
121 template<typename Key, typename Mapped, class Cmp_Fn,
122 class Node_And_It_Traits, class Allocator>
123 class PB_DS_OV_TREE_CLASS_NAME :
124 #ifdef _GLIBCXX_DEBUG
125 protected PB_DS_DEBUG_MAP_BASE_C_DEC,
127 #ifdef PB_DS_TREE_TRACE
128 public PB_DS_TREE_TRACE_BASE_C_DEC,
131 public Node_And_It_Traits::node_update,
132 public PB_DS_TYPES_TRAITS_C_DEC
135 typedef PB_DS_TYPES_TRAITS_C_DEC traits_base;
137 typedef typename remove_const<typename traits_base::value_type>::type non_const_value_type;
139 typedef typename Allocator::template rebind<non_const_value_type>::other value_allocator;
140 typedef typename value_allocator::pointer value_vector;
143 typedef Cmp_Fn cmp_fn_base;
145 #ifdef _GLIBCXX_DEBUG
146 typedef PB_DS_DEBUG_MAP_BASE_C_DEC debug_base;
149 typedef typename traits_base::pointer mapped_pointer_;
150 typedef typename traits_base::const_pointer const_mapped_pointer_;
152 typedef typename Node_And_It_Traits::metadata_type metadata_type;
154 typedef typename Allocator::template rebind<metadata_type>::other metadata_allocator;
155 typedef typename metadata_allocator::pointer metadata_pointer;
156 typedef typename metadata_allocator::const_reference const_metadata_reference;
157 typedef typename metadata_allocator::reference metadata_reference;
160 typename Node_And_It_Traits::null_node_update_pointer
161 null_node_update_pointer;
165 typedef Allocator allocator_type;
166 typedef typename Allocator::size_type size_type;
167 typedef typename Allocator::difference_type difference_type;
169 typedef Cmp_Fn cmp_fn;
171 typedef typename Node_And_It_Traits::node_update node_update;
173 typedef typename traits_base::key_type key_type;
174 typedef typename traits_base::key_pointer key_pointer;
175 typedef typename traits_base::const_key_pointer const_key_pointer;
176 typedef typename traits_base::key_reference key_reference;
177 typedef typename traits_base::const_key_reference const_key_reference;
178 typedef typename traits_base::mapped_type mapped_type;
179 typedef typename traits_base::mapped_pointer mapped_pointer;
180 typedef typename traits_base::const_mapped_pointer const_mapped_pointer;
181 typedef typename traits_base::mapped_reference mapped_reference;
182 typedef typename traits_base::const_mapped_reference const_mapped_reference;
183 typedef typename traits_base::value_type value_type;
184 typedef typename traits_base::pointer pointer;
185 typedef typename traits_base::const_pointer const_pointer;
186 typedef typename traits_base::reference reference;
187 typedef typename traits_base::const_reference const_reference;
189 typedef const_pointer const_point_iterator;
191 #ifdef PB_DS_DATA_TRUE_INDICATOR
192 typedef pointer point_iterator;
194 typedef const_point_iterator point_iterator;
197 typedef const_point_iterator const_iterator;
199 typedef point_iterator iterator;
201 #include <ext/pb_ds/detail/ov_tree_map_/cond_dtor.hpp>
204 typename Node_And_It_Traits::const_node_iterator
207 typedef typename Node_And_It_Traits::node_iterator node_iterator;
211 PB_DS_OV_TREE_CLASS_NAME();
213 PB_DS_OV_TREE_CLASS_NAME(const Cmp_Fn&);
215 PB_DS_OV_TREE_CLASS_NAME(const Cmp_Fn&, const node_update&);
217 PB_DS_OV_TREE_CLASS_NAME(const PB_DS_CLASS_C_DEC&);
219 ~PB_DS_OV_TREE_CLASS_NAME();
222 swap(PB_DS_CLASS_C_DEC&);
224 template<typename It>
226 copy_from_range(It, It);
243 inline mapped_reference
244 operator[](const_key_reference r_key)
246 #ifdef PB_DS_DATA_TRUE_INDICATOR
247 PB_DS_ASSERT_VALID((*this))
248 point_iterator it = lower_bound(r_key);
249 if (it != end() && !Cmp_Fn::operator()(r_key, PB_DS_V2F(*it)))
251 PB_DS_CHECK_KEY_EXISTS(r_key)
252 PB_DS_ASSERT_VALID((*this))
256 return (insert_new_val(it, std::make_pair(r_key, mapped_type()))->second);
259 return traits_base::s_null_mapped;
263 inline std::pair<point_iterator, bool>
264 insert(const_reference r_value)
266 PB_DS_ASSERT_VALID((*this))
267 const_key_reference r_key = PB_DS_V2F(r_value);
268 point_iterator it = lower_bound(r_key);
270 if (it != end()&& !Cmp_Fn::operator()(r_key, PB_DS_V2F(*it)))
272 PB_DS_ASSERT_VALID((*this))
273 PB_DS_CHECK_KEY_EXISTS(r_key)
274 return std::make_pair(it, false);
277 return std::make_pair(insert_new_val(it, r_value), true);
280 inline point_iterator
281 lower_bound(const_key_reference r_key)
283 pointer it = m_a_values;
284 pointer e_it = m_a_values + m_size;
287 pointer mid_it = it + ((e_it - it) >> 1);
288 if (cmp_fn_base::operator()(PB_DS_V2F(*mid_it), r_key))
296 inline const_point_iterator
297 lower_bound(const_key_reference r_key) const
298 { return const_cast<PB_DS_CLASS_C_DEC& >(*this).lower_bound(r_key); }
300 inline point_iterator
301 upper_bound(const_key_reference r_key)
303 iterator pot_it = lower_bound(r_key);
304 if (pot_it != end()&& !Cmp_Fn::operator()(r_key, PB_DS_V2F(*pot_it)))
306 PB_DS_CHECK_KEY_EXISTS(r_key)
310 PB_DS_CHECK_KEY_DOES_NOT_EXIST(r_key)
314 inline const_point_iterator
315 upper_bound(const_key_reference r_key) const
316 { return const_cast<PB_DS_CLASS_C_DEC&>(*this).upper_bound(r_key); }
318 inline point_iterator
319 find(const_key_reference r_key)
321 PB_DS_ASSERT_VALID((*this))
322 iterator pot_it = lower_bound(r_key);
323 if (pot_it != end() && !Cmp_Fn::operator()(r_key, PB_DS_V2F(*pot_it)))
325 PB_DS_CHECK_KEY_EXISTS(r_key)
329 PB_DS_CHECK_KEY_DOES_NOT_EXIST(r_key)
333 inline const_point_iterator
334 find(const_key_reference r_key) const
335 { return (const_cast<PB_DS_CLASS_C_DEC& >(*this).find(r_key)); }
338 erase(const_key_reference);
340 template<typename Pred>
346 { return erase_imp<iterator>(it); }
352 join(PB_DS_CLASS_C_DEC&);
355 split(const_key_reference, PB_DS_CLASS_C_DEC&);
359 { return m_a_values; }
361 inline const_iterator
363 { return m_a_values; }
369 inline const_iterator
373 inline const_node_iterator
376 inline const_node_iterator
388 update(node_iterator /*it*/, null_node_update_pointer);
390 template<typename Node_Update>
392 update(node_iterator, Node_Update*);
395 reallocate_metadata(null_node_update_pointer, size_type);
397 template<typename Node_Update_>
399 reallocate_metadata(Node_Update_*, size_type);
401 template<typename It>
403 copy_from_ordered_range(It, It);
406 value_swap(PB_DS_CLASS_C_DEC&);
408 template<typename It>
410 copy_from_ordered_range(It, It, It, It);
412 template<typename Ptr>
414 mid_pointer(Ptr p_begin, Ptr p_end)
416 _GLIBCXX_DEBUG_ASSERT(p_end >= p_begin);
417 return (p_begin + (p_end - p_begin) / 2);
421 insert_new_val(iterator it, const_reference r_value)
423 #ifdef PB_DS_REGRESSION
424 typename Allocator::group_adjustor adjust(m_size);
427 PB_DS_CHECK_KEY_DOES_NOT_EXIST(PB_DS_V2F(r_value))
429 value_vector a_values = s_value_alloc.allocate(m_size + 1);
431 iterator source_it = begin();
432 iterator source_end_it = end();
433 iterator target_it = a_values;
436 cond_dtor<size_type> cd(a_values, target_it, m_size + 1);
437 while (source_it != it)
439 new (const_cast<void* >(static_cast<const void* >(target_it)))
440 value_type(*source_it++);
444 new (const_cast<void* >(static_cast<const void* >(ret_it = target_it)))
448 while (source_it != source_end_it)
450 new (const_cast<void* >(static_cast<const void* >(target_it)))
451 value_type(*source_it++);
455 reallocate_metadata((node_update* )this, m_size + 1);
459 cond_dtor<size_type> cd1(m_a_values, m_end_it, m_size);
463 m_a_values = a_values;
464 m_end_it = m_a_values + m_size;
465 _GLIBCXX_DEBUG_ONLY(debug_base::insert_new(PB_DS_V2F(r_value)));
466 update(node_begin(), (node_update* )this);
467 PB_DS_ASSERT_VALID((*this))
471 #ifdef _GLIBCXX_DEBUG
473 assert_valid(const char* file, int line) const;
476 assert_iterators(const char* file, int line) const;
479 template<typename It>
483 inline const_node_iterator
484 PB_DS_node_begin_imp() const;
486 inline const_node_iterator
487 PB_DS_node_end_imp() const;
490 PB_DS_node_begin_imp();
493 PB_DS_node_end_imp();
496 static value_allocator s_value_alloc;
497 static metadata_allocator s_metadata_alloc;
499 value_vector m_a_values;
500 metadata_pointer m_a_metadata;
505 #define PB_DS_DEBUG_VERIFY(_Cond) \
506 _GLIBCXX_DEBUG_VERIFY_AT(_Cond, \
507 _M_message(#_Cond" assertion from %1;:%2;") \
508 ._M_string(__FILE__)._M_integer(__LINE__) \
511 #include <ext/pb_ds/detail/ov_tree_map_/constructors_destructor_fn_imps.hpp>
512 #include <ext/pb_ds/detail/ov_tree_map_/iterators_fn_imps.hpp>
513 #include <ext/pb_ds/detail/ov_tree_map_/debug_fn_imps.hpp>
514 #include <ext/pb_ds/detail/ov_tree_map_/erase_fn_imps.hpp>
515 #include <ext/pb_ds/detail/ov_tree_map_/insert_fn_imps.hpp>
516 #include <ext/pb_ds/detail/ov_tree_map_/info_fn_imps.hpp>
517 #include <ext/pb_ds/detail/ov_tree_map_/split_join_fn_imps.hpp>
518 #include <ext/pb_ds/detail/bin_search_tree_/policy_access_fn_imps.hpp>
520 #undef PB_DS_DEBUG_VERIFY
521 #undef PB_DS_CHECK_KEY_DOES_NOT_EXIST
522 #undef PB_DS_CHECK_KEY_EXISTS
523 #undef PB_DS_ASSERT_VALID
524 #undef PB_DS_CLASS_C_DEC
525 #undef PB_DS_CLASS_T_DEC
526 #undef PB_DS_OV_TREE_CLASS_NAME
527 #undef PB_DS_TYPES_TRAITS_C_DEC
528 #undef PB_DS_DEBUG_MAP_BASE_C_DEC
529 #ifdef PB_DS_TREE_TRACE
530 #undef PB_DS_TREE_TRACE_BASE_C_DEC
536 #undef PB_DS_CONST_NODE_ITERATOR_NAME
538 } // namespace detail
539 } // namespace __gnu_pbds