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 cc_ht_map_.hpp
44 * Contains an implementation class for cc_ht_map_.
49 #include <ext/pb_ds/detail/cond_dealtor.hpp>
50 #include <ext/pb_ds/tag_and_trait.hpp>
51 #include <ext/pb_ds/detail/hash_fn/ranged_hash_fn.hpp>
52 #include <ext/pb_ds/detail/types_traits.hpp>
53 #include <ext/pb_ds/exception.hpp>
54 #include <ext/pb_ds/detail/eq_fn/hash_eq_fn.hpp>
56 #include <ext/pb_ds/detail/map_debug_base.hpp>
58 #ifdef PB_DS_HT_MAP_TRACE_
61 #include <debug/debug.h>
68 #define PB_DS_CLASS_T_DEC \
69 template<typename Key, typename Mapped, typename Hash_Fn, \
70 typename Eq_Fn, typename Allocator, bool Store_Hash, \
71 typename Comb_Hash_Fn, typename Resize_Policy>
73 #ifdef PB_DS_DATA_TRUE_INDICATOR
74 #define PB_DS_CLASS_NAME cc_ht_map_data_
77 #ifdef PB_DS_DATA_FALSE_INDICATOR
78 #define PB_DS_CLASS_NAME cc_ht_map_no_data_
81 #define PB_DS_CLASS_C_DEC \
82 PB_DS_CLASS_NAME<Key, Mapped, Hash_Fn, Eq_Fn, Allocator, \
83 Store_Hash, Comb_Hash_Fn, Resize_Policy>
85 #define PB_DS_HASH_EQ_FN_C_DEC \
86 hash_eq_fn<Key, Eq_Fn, Allocator, Store_Hash>
88 #define PB_DS_RANGED_HASH_FN_C_DEC \
89 ranged_hash_fn<Key, Hash_Fn, Allocator, Comb_Hash_Fn, Store_Hash>
91 #define PB_DS_TYPES_TRAITS_C_DEC \
92 types_traits<Key, Mapped, Allocator, Store_Hash>
95 #define PB_DS_MAP_DEBUG_BASE_C_DEC \
96 map_debug_base<Key, Eq_Fn, typename Allocator::template rebind<Key>::other::const_reference>
99 #ifdef PB_DS_DATA_TRUE_INDICATOR
100 #define PB_DS_V2F(X) (X).first
101 #define PB_DS_V2S(X) (X).second
104 #ifdef PB_DS_DATA_FALSE_INDICATOR
105 #define PB_DS_V2F(X) (X)
106 #define PB_DS_V2S(X) Mapped_Data()
109 #define PB_DS_STATIC_ASSERT(UNIQUE, E) \
110 typedef static_assert_dumclass<sizeof(static_assert<(bool)(E)>)> \
111 UNIQUE##static_assert_type
113 // <011i$i0|\|-<|-|4i|\|i|\|g |-|4$|-| 74813.
114 template<typename Key,
120 typename Comb_Hash_Fn,
121 typename Resize_Policy >
122 class PB_DS_CLASS_NAME:
123 #ifdef _GLIBCXX_DEBUG
124 protected PB_DS_MAP_DEBUG_BASE_C_DEC,
126 public PB_DS_HASH_EQ_FN_C_DEC,
127 public Resize_Policy,
128 public PB_DS_RANGED_HASH_FN_C_DEC,
129 public PB_DS_TYPES_TRAITS_C_DEC
132 typedef PB_DS_TYPES_TRAITS_C_DEC traits_base;
133 typedef typename traits_base::comp_hash comp_hash;
134 typedef typename traits_base::value_type value_type_;
135 typedef typename traits_base::pointer pointer_;
136 typedef typename traits_base::const_pointer const_pointer_;
137 typedef typename traits_base::reference reference_;
138 typedef typename traits_base::const_reference const_reference_;
139 typedef typename traits_base::store_extra_false_type store_hash_false_type;
140 typedef typename traits_base::store_extra_true_type store_hash_true_type;
141 typedef typename traits_base::no_throw_copies_false_type no_throw_copies_false_type;
142 typedef typename traits_base::no_throw_copies_true_type no_throw_copies_true_type;
144 struct entry : public traits_base::stored_value_type
146 typename Allocator::template rebind<entry>::other::pointer m_p_next;
149 typedef cond_dealtor<entry, Allocator> cond_dealtor_t;
151 typedef typename Allocator::template rebind<entry>::other entry_allocator;
152 typedef typename entry_allocator::pointer entry_pointer;
153 typedef typename entry_allocator::const_pointer const_entry_pointer;
154 typedef typename entry_allocator::reference entry_reference;
155 typedef typename entry_allocator::const_reference const_entry_reference;
157 typedef typename Allocator::template rebind<entry_pointer>::other entry_pointer_allocator;
158 typedef typename entry_pointer_allocator::pointer entry_pointer_array;
160 typedef PB_DS_RANGED_HASH_FN_C_DEC ranged_hash_fn_base;
161 typedef PB_DS_HASH_EQ_FN_C_DEC hash_eq_fn_base;
162 typedef Resize_Policy resize_base;
164 #ifdef _GLIBCXX_DEBUG
165 typedef PB_DS_MAP_DEBUG_BASE_C_DEC map_debug_base;
168 #define PB_DS_GEN_POS std::pair<entry_pointer, typename Allocator::size_type>
170 #include <ext/pb_ds/detail/unordered_iterator/const_point_iterator.hpp>
171 #include <ext/pb_ds/detail/unordered_iterator/point_iterator.hpp>
172 #include <ext/pb_ds/detail/unordered_iterator/const_iterator.hpp>
173 #include <ext/pb_ds/detail/unordered_iterator/iterator.hpp>
178 typedef Allocator allocator;
179 typedef typename Allocator::size_type size_type;
180 typedef typename Allocator::difference_type difference_type;
181 typedef Hash_Fn hash_fn;
183 typedef Comb_Hash_Fn comb_hash_fn;
184 typedef Resize_Policy resize_policy;
188 store_hash = Store_Hash
191 typedef typename traits_base::key_type key_type;
192 typedef typename traits_base::key_pointer key_pointer;
193 typedef typename traits_base::const_key_pointer const_key_pointer;
194 typedef typename traits_base::key_reference key_reference;
195 typedef typename traits_base::const_key_reference const_key_reference;
196 typedef typename traits_base::mapped_type mapped_type;
197 typedef typename traits_base::mapped_pointer mapped_pointer;
198 typedef typename traits_base::const_mapped_pointer const_mapped_pointer;
199 typedef typename traits_base::mapped_reference mapped_reference;
200 typedef typename traits_base::const_mapped_reference const_mapped_reference;
201 typedef typename traits_base::value_type value_type;
202 typedef typename traits_base::pointer pointer;
203 typedef typename traits_base::const_pointer const_pointer;
204 typedef typename traits_base::reference reference;
205 typedef typename traits_base::const_reference const_reference;
207 #ifdef PB_DS_DATA_TRUE_INDICATOR
208 typedef point_iterator_ point_iterator;
211 #ifdef PB_DS_DATA_FALSE_INDICATOR
212 typedef const_point_iterator_ point_iterator;
215 typedef const_point_iterator_ const_point_iterator;
217 #ifdef PB_DS_DATA_TRUE_INDICATOR
218 typedef iterator_ iterator;
221 #ifdef PB_DS_DATA_FALSE_INDICATOR
222 typedef const_iterator_ iterator;
225 typedef const_iterator_ const_iterator;
229 PB_DS_CLASS_NAME(const Hash_Fn&);
231 PB_DS_CLASS_NAME(const Hash_Fn&, const Eq_Fn&);
233 PB_DS_CLASS_NAME(const Hash_Fn&, const Eq_Fn&, const Comb_Hash_Fn&);
235 PB_DS_CLASS_NAME(const Hash_Fn&, const Eq_Fn&, const Comb_Hash_Fn&,
236 const Resize_Policy&);
238 PB_DS_CLASS_NAME(const PB_DS_CLASS_C_DEC&);
244 swap(PB_DS_CLASS_C_DEC&);
246 template<typename It>
248 copy_from_range(It, It);
278 get_comb_hash_fn() const;
284 get_resize_policy() const;
286 inline std::pair<point_iterator, bool>
287 insert(const_reference r_val)
288 { return insert_imp(r_val, traits_base::m_store_extra_indicator); }
290 inline mapped_reference
291 operator[](const_key_reference r_key)
293 #ifdef PB_DS_DATA_TRUE_INDICATOR
294 return (subscript_imp(r_key, traits_base::m_store_extra_indicator));
297 return traits_base::s_null_mapped;
301 inline point_iterator
302 find(const_key_reference);
304 inline const_point_iterator
305 find(const_key_reference) const;
307 inline point_iterator
310 inline const_point_iterator
314 erase(const_key_reference);
316 template<typename Pred>
326 inline const_iterator
332 inline const_iterator
335 #ifdef _GLIBCXX_DEBUG
337 assert_valid() const;
340 #ifdef PB_DS_HT_MAP_TRACE_
350 do_resize_if_needed();
353 do_resize_if_needed_no_throw();
356 resize_imp(size_type new_size);
359 do_resize(size_type new_size);
362 resize_imp_no_exceptions(size_type, entry_pointer_array, size_type);
365 resize_imp_no_exceptions_reassign_pointer(entry_pointer, entry_pointer_array, store_hash_false_type);
368 resize_imp_no_exceptions_reassign_pointer(entry_pointer, entry_pointer_array, store_hash_true_type);
371 deallocate_links_in_list(entry_pointer);
374 get_entry(const_reference, no_throw_copies_false_type);
377 get_entry(const_reference, no_throw_copies_true_type);
380 rels_entry(entry_pointer);
382 #ifdef PB_DS_DATA_TRUE_INDICATOR
383 inline mapped_reference
384 subscript_imp(const_key_reference r_key, store_hash_false_type)
386 _GLIBCXX_DEBUG_ONLY(assert_valid();)
387 const size_type pos = ranged_hash_fn_base::operator()(r_key);
388 entry_pointer p_e = m_entries[pos];
389 resize_base::notify_insert_search_start();
392 && !hash_eq_fn_base::operator()(p_e->m_value.first, r_key))
394 resize_base::notify_insert_search_collision();
398 resize_base::notify_insert_search_end();
401 _GLIBCXX_DEBUG_ONLY(map_debug_base::check_key_exists(r_key);)
402 return (p_e->m_value.second);
405 _GLIBCXX_DEBUG_ONLY(map_debug_base::check_key_does_not_exist(r_key);)
406 return insert_new_imp(value_type(r_key, mapped_type()), pos)->second;
409 inline mapped_reference
410 subscript_imp(const_key_reference r_key, store_hash_true_type)
412 _GLIBCXX_DEBUG_ONLY(assert_valid();)
413 comp_hash pos_hash_pair = ranged_hash_fn_base::operator()(r_key);
414 entry_pointer p_e = m_entries[pos_hash_pair.first];
415 resize_base::notify_insert_search_start();
416 while (p_e != NULL &&
417 !hash_eq_fn_base::operator()(p_e->m_value.first, p_e->m_hash, r_key, pos_hash_pair.second))
419 resize_base::notify_insert_search_collision();
423 resize_base::notify_insert_search_end();
426 _GLIBCXX_DEBUG_ONLY(map_debug_base::check_key_exists(r_key);)
427 return p_e->m_value.second;
430 _GLIBCXX_DEBUG_ONLY(map_debug_base::check_key_does_not_exist(r_key);)
431 return insert_new_imp(value_type(r_key, mapped_type()),
432 pos_hash_pair)->second;
436 inline std::pair<point_iterator, bool>
437 insert_imp(const_reference, store_hash_false_type);
439 inline std::pair<point_iterator, bool>
440 insert_imp(const_reference, store_hash_true_type);
443 insert_new_imp(const_reference r_val, size_type pos)
445 if (do_resize_if_needed())
446 pos = ranged_hash_fn_base::operator()(PB_DS_V2F(r_val));
448 // Following lines might throw an exception.
449 entry_pointer p_e = get_entry(r_val, traits_base::m_no_throw_copies_indicator);
451 // At this point no exceptions can be thrown.
452 p_e->m_p_next = m_entries[pos];
453 m_entries[pos] = p_e;
454 resize_base::notify_inserted(++m_num_used_e);
456 _GLIBCXX_DEBUG_ONLY(map_debug_base::insert_new(PB_DS_V2F(r_val));)
457 _GLIBCXX_DEBUG_ONLY(assert_valid();)
458 return &p_e->m_value;
462 insert_new_imp(const_reference r_val, comp_hash& r_pos_hash_pair)
464 // Following lines might throw an exception.
465 if (do_resize_if_needed())
466 r_pos_hash_pair = ranged_hash_fn_base::operator()(PB_DS_V2F(r_val));
468 entry_pointer p_e = get_entry(r_val, traits_base::m_no_throw_copies_indicator);
470 // At this point no exceptions can be thrown.
471 p_e->m_hash = r_pos_hash_pair.second;
472 p_e->m_p_next = m_entries[r_pos_hash_pair.first];
473 m_entries[r_pos_hash_pair.first] = p_e;
474 resize_base::notify_inserted(++m_num_used_e);
475 _GLIBCXX_DEBUG_ONLY(map_debug_base::insert_new(PB_DS_V2F(r_val));)
476 _GLIBCXX_DEBUG_ONLY(assert_valid();)
477 return &p_e->m_value;
481 find_key_pointer(const_key_reference r_key, store_hash_false_type)
483 entry_pointer p_e = m_entries[ranged_hash_fn_base::operator()(r_key)];
484 resize_base::notify_find_search_start();
485 while (p_e != NULL &&
486 !hash_eq_fn_base::operator()(PB_DS_V2F(p_e->m_value), r_key))
488 resize_base::notify_find_search_collision();
492 resize_base::notify_find_search_end();
494 #ifdef _GLIBCXX_DEBUG
496 map_debug_base::check_key_does_not_exist(r_key);
498 map_debug_base::check_key_exists(r_key);
500 return &p_e->m_value;
504 find_key_pointer(const_key_reference r_key, store_hash_true_type)
506 comp_hash pos_hash_pair = ranged_hash_fn_base::operator()(r_key);
507 entry_pointer p_e = m_entries[pos_hash_pair.first];
508 resize_base::notify_find_search_start();
509 while (p_e != NULL &&
510 !hash_eq_fn_base::operator()(PB_DS_V2F(p_e->m_value),
512 r_key, pos_hash_pair.second))
514 resize_base::notify_find_search_collision();
518 resize_base::notify_find_search_end();
520 #ifdef _GLIBCXX_DEBUG
522 map_debug_base::check_key_does_not_exist(r_key);
524 map_debug_base::check_key_exists(r_key);
526 return &p_e->m_value;
530 erase_in_pos_imp(const_key_reference, size_type);
533 erase_in_pos_imp(const_key_reference, const comp_hash&);
536 erase_entry_pointer(entry_pointer&);
538 #ifdef PB_DS_DATA_TRUE_INDICATOR
540 inc_it_state(pointer& r_p_value,
541 std::pair<entry_pointer, size_type>& r_pos) const
543 inc_it_state((const_mapped_pointer& )r_p_value, r_pos);
548 inc_it_state(const_pointer& r_p_value,
549 std::pair<entry_pointer, size_type>& r_pos) const
551 _GLIBCXX_DEBUG_ASSERT(r_p_value != NULL);
552 r_pos.first = r_pos.first->m_p_next;
553 if (r_pos.first != NULL)
555 r_p_value = &r_pos.first->m_value;
559 for (++r_pos.second; r_pos.second < m_num_e; ++r_pos.second)
560 if (m_entries[r_pos.second] != NULL)
562 r_pos.first = m_entries[r_pos.second];
563 r_p_value = &r_pos.first->m_value;
570 get_start_it_state(pointer& r_p_value,
571 std::pair<entry_pointer, size_type>& r_pos) const
573 for (r_pos.second = 0; r_pos.second < m_num_e; ++r_pos.second)
574 if (m_entries[r_pos.second] != NULL)
576 r_pos.first = m_entries[r_pos.second];
577 r_p_value = &r_pos.first->m_value;
583 #ifdef _GLIBCXX_DEBUG
585 assert_entry_pointer_array_valid(const entry_pointer_array) const;
588 assert_entry_pointer_valid(const entry_pointer,
589 store_hash_true_type) const;
592 assert_entry_pointer_valid(const entry_pointer,
593 store_hash_false_type) const;
596 #ifdef PB_DS_HT_MAP_TRACE_
598 trace_list(const_entry_pointer p_l) const;
602 #ifdef PB_DS_DATA_TRUE_INDICATOR
603 friend class iterator_;
606 friend class const_iterator_;
608 static entry_allocator s_entry_allocator;
609 static entry_pointer_allocator s_entry_pointer_allocator;
610 static iterator s_end_it;
611 static const_iterator s_const_end_it;
612 static point_iterator s_find_end_it;
613 static const_point_iterator s_const_find_end_it;
616 size_type m_num_used_e;
617 entry_pointer_array m_entries;
621 store_hash_ok = !Store_Hash
622 || !is_same<Hash_Fn, pb_ds::null_hash_fn>::value
625 PB_DS_STATIC_ASSERT(sth, store_hash_ok);
628 #include <ext/pb_ds/detail/cc_hash_table_map_/constructor_destructor_fn_imps.hpp>
629 #include <ext/pb_ds/detail/cc_hash_table_map_/entry_list_fn_imps.hpp>
630 #include <ext/pb_ds/detail/cc_hash_table_map_/find_fn_imps.hpp>
631 #include <ext/pb_ds/detail/cc_hash_table_map_/resize_fn_imps.hpp>
632 #include <ext/pb_ds/detail/cc_hash_table_map_/debug_fn_imps.hpp>
633 #include <ext/pb_ds/detail/cc_hash_table_map_/size_fn_imps.hpp>
634 #include <ext/pb_ds/detail/cc_hash_table_map_/policy_access_fn_imps.hpp>
635 #include <ext/pb_ds/detail/cc_hash_table_map_/erase_fn_imps.hpp>
636 #include <ext/pb_ds/detail/cc_hash_table_map_/iterators_fn_imps.hpp>
637 #include <ext/pb_ds/detail/cc_hash_table_map_/insert_fn_imps.hpp>
638 #include <ext/pb_ds/detail/cc_hash_table_map_/trace_fn_imps.hpp>
640 #undef PB_DS_CLASS_T_DEC
641 #undef PB_DS_CLASS_C_DEC
642 #undef PB_DS_HASH_EQ_FN_C_DEC
643 #undef PB_DS_RANGED_HASH_FN_C_DEC
644 #undef PB_DS_TYPES_TRAITS_C_DEC
645 #undef PB_DS_MAP_DEBUG_BASE_C_DEC
646 #undef PB_DS_CLASS_NAME
649 #undef PB_DS_STATIC_ASSERT
651 } // namespace detail