1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
|
// -*- C++ -*-
// Copyright (C) 2005-2015 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
// of the GNU General Public License as published by the Free Software
// Foundation; either version 3, or (at your option) any later
// version.
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.
// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
// Permission to use, copy, modify, sell, and distribute this software
// is hereby granted without fee, provided that the above copyright
// notice appears in all copies, and that both that copyright notice
// and this permission notice appear in supporting documentation. None
// of the above authors, nor IBM Haifa Research Laboratories, make any
// representation about the suitability of this software for any
// purpose. It is provided "as is" without express or implied
// warranty.
/**
* @file hash_policy.hpp
* Contains hash-related policies.
*/
#ifndef PB_DS_HASH_POLICY_HPP
#define PB_DS_HASH_POLICY_HPP
#include <bits/c++config.h>
#include <algorithm>
#include <vector>
#include <cmath>
#include <ext/pb_ds/exception.hpp>
#include <ext/pb_ds/detail/type_utils.hpp>
#include <ext/pb_ds/detail/hash_fn/mask_based_range_hashing.hpp>
#include <ext/pb_ds/detail/hash_fn/mod_based_range_hashing.hpp>
#include <ext/pb_ds/detail/resize_policy/hash_load_check_resize_trigger_size_base.hpp>
namespace __gnu_pbds
{
#define PB_DS_CLASS_T_DEC template<typename Size_Type>
#define PB_DS_CLASS_C_DEC linear_probe_fn<Size_Type>
/// A probe sequence policy using fixed increments.
template<typename Size_Type = std::size_t>
class linear_probe_fn
{
public:
typedef Size_Type size_type;
void
swap(PB_DS_CLASS_C_DEC& other);
protected:
/// Returns the i-th offset from the hash value.
inline size_type
operator()(size_type i) const;
};
#include <ext/pb_ds/detail/hash_fn/linear_probe_fn_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC template<typename Size_Type>
#define PB_DS_CLASS_C_DEC quadratic_probe_fn<Size_Type>
/// A probe sequence policy using square increments.
template<typename Size_Type = std::size_t>
class quadratic_probe_fn
{
public:
typedef Size_Type size_type;
void
swap(PB_DS_CLASS_C_DEC& other);
protected:
/// Returns the i-th offset from the hash value.
inline size_type
operator()(size_type i) const;
};
#include <ext/pb_ds/detail/hash_fn/quadratic_probe_fn_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC template<typename Size_Type>
#define PB_DS_CLASS_C_DEC direct_mask_range_hashing<Size_Type>
/// A mask range-hashing class (uses a bitmask).
template<typename Size_Type = std::size_t>
class direct_mask_range_hashing
: public detail::mask_based_range_hashing<Size_Type>
{
private:
typedef detail::mask_based_range_hashing<Size_Type> mask_based_base;
public:
typedef Size_Type size_type;
void
swap(PB_DS_CLASS_C_DEC& other);
protected:
void
notify_resized(size_type size);
/// Transforms the __hash value hash into a ranged-hash value
/// (using a bit-mask).
inline size_type
operator()(size_type hash) const;
};
#include <ext/pb_ds/detail/hash_fn/direct_mask_range_hashing_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC template<typename Size_Type>
#define PB_DS_CLASS_C_DEC direct_mod_range_hashing<Size_Type>
/// A mod range-hashing class (uses the modulo function).
template<typename Size_Type = std::size_t>
class direct_mod_range_hashing
: public detail::mod_based_range_hashing<Size_Type>
{
public:
typedef Size_Type size_type;
void
swap(PB_DS_CLASS_C_DEC& other);
protected:
void
notify_resized(size_type size);
/// Transforms the __hash value hash into a ranged-hash value
/// (using a modulo operation).
inline size_type
operator()(size_type hash) const;
private:
typedef detail::mod_based_range_hashing<size_type> mod_based_base;
};
#include <ext/pb_ds/detail/hash_fn/direct_mod_range_hashing_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC template<bool External_Load_Access, typename Size_Type>
#define PB_DS_CLASS_C_DEC hash_load_check_resize_trigger<External_Load_Access, Size_Type>
#define PB_DS_SIZE_BASE_C_DEC detail::hash_load_check_resize_trigger_size_base<Size_Type, External_Load_Access>
/// A resize trigger policy based on a load check. It keeps the
/// load factor between some load factors load_min and load_max.
template<bool External_Load_Access = false, typename Size_Type = std::size_t>
class hash_load_check_resize_trigger : private PB_DS_SIZE_BASE_C_DEC
{
public:
typedef Size_Type size_type;
enum
{
/// Specifies whether the load factor can be accessed
/// externally. The two options have different trade-offs in
/// terms of flexibility, genericity, and encapsulation.
external_load_access = External_Load_Access
};
/// Default constructor, or constructor taking load_min and
/// load_max load factors between which this policy will keep the
/// actual load.
hash_load_check_resize_trigger(float load_min = 0.125,
float load_max = 0.5);
void
swap(hash_load_check_resize_trigger& other);
virtual
~hash_load_check_resize_trigger();
/// Returns a pair of the minimal and maximal loads, respectively.
inline std::pair<float, float>
get_loads() const;
/// Sets the loads through a pair of the minimal and maximal
/// loads, respectively.
void
set_loads(std::pair<float, float> load_pair);
protected:
inline void
notify_insert_search_start();
inline void
notify_insert_search_collision();
inline void
notify_insert_search_end();
inline void
notify_find_search_start();
inline void
notify_find_search_collision();
inline void
notify_find_search_end();
inline void
notify_erase_search_start();
inline void
notify_erase_search_collision();
inline void
notify_erase_search_end();
/// Notifies an element was inserted. The total number of entries
/// in the table is num_entries.
inline void
notify_inserted(size_type num_entries);
inline void
notify_erased(size_type num_entries);
/// Notifies the table was cleared.
void
notify_cleared();
/// Notifies the table was resized as a result of this object's
/// signifying that a resize is needed.
void
notify_resized(size_type new_size);
void
notify_externally_resized(size_type new_size);
inline bool
is_resize_needed() const;
inline bool
is_grow_needed(size_type size, size_type num_entries) const;
private:
virtual void
do_resize(size_type new_size);
typedef PB_DS_SIZE_BASE_C_DEC size_base;
#ifdef _GLIBCXX_DEBUG
void
assert_valid(const char* file, int line) const;
#endif
float m_load_min;
float m_load_max;
size_type m_next_shrink_size;
size_type m_next_grow_size;
bool m_resize_needed;
};
#include <ext/pb_ds/detail/resize_policy/hash_load_check_resize_trigger_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#undef PB_DS_SIZE_BASE_C_DEC
#define PB_DS_CLASS_T_DEC template<bool External_Load_Access, typename Size_Type>
#define PB_DS_CLASS_C_DEC cc_hash_max_collision_check_resize_trigger<External_Load_Access, Size_Type>
/// A resize trigger policy based on collision checks. It keeps the
/// simulated load factor lower than some given load factor.
template<bool External_Load_Access = false, typename Size_Type = std::size_t>
class cc_hash_max_collision_check_resize_trigger
{
public:
typedef Size_Type size_type;
enum
{
/// Specifies whether the load factor can be accessed
/// externally. The two options have different trade-offs in
/// terms of flexibility, genericity, and encapsulation.
external_load_access = External_Load_Access
};
/// Default constructor, or constructor taking load, a __load
/// factor which it will attempt to maintain.
cc_hash_max_collision_check_resize_trigger(float load = 0.5);
void
swap(PB_DS_CLASS_C_DEC& other);
/// Returns the current load.
inline float
get_load() const;
/// Sets the load; does not resize the container.
void
set_load(float load);
protected:
/// Notifies an insert search started.
inline void
notify_insert_search_start();
/// Notifies a search encountered a collision.
inline void
notify_insert_search_collision();
/// Notifies a search ended.
inline void
notify_insert_search_end();
/// Notifies a find search started.
inline void
notify_find_search_start();
/// Notifies a search encountered a collision.
inline void
notify_find_search_collision();
/// Notifies a search ended.
inline void
notify_find_search_end();
/// Notifies an erase search started.
inline void
notify_erase_search_start();
/// Notifies a search encountered a collision.
inline void
notify_erase_search_collision();
/// Notifies a search ended.
inline void
notify_erase_search_end();
/// Notifies an element was inserted.
inline void
notify_inserted(size_type num_entries);
/// Notifies an element was erased.
inline void
notify_erased(size_type num_entries);
/// Notifies the table was cleared.
void
notify_cleared();
/// Notifies the table was resized as a result of this object's
/// signifying that a resize is needed.
void
notify_resized(size_type new_size);
/// Notifies the table was resized externally.
void
notify_externally_resized(size_type new_size);
/// Queries whether a resize is needed.
inline bool
is_resize_needed() const;
/// Queries whether a grow is needed. This method is called only
/// if this object indicated is needed.
inline bool
is_grow_needed(size_type size, size_type num_entries) const;
private:
void
calc_max_num_coll();
inline void
calc_resize_needed();
float m_load;
size_type m_size;
size_type m_num_col;
size_type m_max_col;
bool m_resize_needed;
};
#include <ext/pb_ds/detail/resize_policy/cc_hash_max_collision_check_resize_trigger_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC template<typename Size_Type>
#define PB_DS_CLASS_C_DEC hash_exponential_size_policy<Size_Type>
/// A size policy whose sequence of sizes form an exponential
/// sequence (typically powers of 2.
template<typename Size_Type = std::size_t>
class hash_exponential_size_policy
{
public:
typedef Size_Type size_type;
/// Default constructor, or onstructor taking a start_size, or
/// constructor taking a start size and grow_factor. The policy
/// will use the sequence of sizes start_size, start_size*
/// grow_factor, start_size* grow_factor^2, ...
hash_exponential_size_policy(size_type start_size = 8,
size_type grow_factor = 2);
void
swap(PB_DS_CLASS_C_DEC& other);
protected:
size_type
get_nearest_larger_size(size_type size) const;
size_type
get_nearest_smaller_size(size_type size) const;
private:
size_type m_start_size;
size_type m_grow_factor;
};
#include <ext/pb_ds/detail/resize_policy/hash_exponential_size_policy_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC
#define PB_DS_CLASS_C_DEC hash_prime_size_policy
/// A size policy whose sequence of sizes form a nearly-exponential
/// sequence of primes.
class hash_prime_size_policy
{
public:
/// Size type.
typedef std::size_t size_type;
/// Default constructor, or onstructor taking a start_size The
/// policy will use the sequence of sizes approximately
/// start_size, start_size* 2, start_size* 2^2, ...
hash_prime_size_policy(size_type start_size = 8);
inline void
swap(PB_DS_CLASS_C_DEC& other);
protected:
size_type
get_nearest_larger_size(size_type size) const;
size_type
get_nearest_smaller_size(size_type size) const;
private:
size_type m_start_size;
};
#include <ext/pb_ds/detail/resize_policy/hash_prime_size_policy_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#define PB_DS_CLASS_T_DEC template<typename Size_Policy, typename Trigger_Policy, bool External_Size_Access, typename Size_Type>
#define PB_DS_CLASS_C_DEC hash_standard_resize_policy<Size_Policy, Trigger_Policy, External_Size_Access, Size_Type>
/// A resize policy which delegates operations to size and trigger policies.
template<typename Size_Policy = hash_exponential_size_policy<>,
typename Trigger_Policy = hash_load_check_resize_trigger<>,
bool External_Size_Access = false,
typename Size_Type = std::size_t>
class hash_standard_resize_policy
: public Size_Policy, public Trigger_Policy
{
public:
typedef Size_Type size_type;
typedef Trigger_Policy trigger_policy;
typedef Size_Policy size_policy;
enum
{
external_size_access = External_Size_Access
};
/// Default constructor.
hash_standard_resize_policy();
/// constructor taking some policies r_size_policy will be copied
/// by the Size_Policy object of this object.
hash_standard_resize_policy(const Size_Policy& r_size_policy);
/// constructor taking some policies. r_size_policy will be
/// copied by the Size_Policy object of this
/// object. r_trigger_policy will be copied by the Trigger_Policy
/// object of this object.
hash_standard_resize_policy(const Size_Policy& r_size_policy,
const Trigger_Policy& r_trigger_policy);
virtual
~hash_standard_resize_policy();
inline void
swap(PB_DS_CLASS_C_DEC& other);
/// Access to the Size_Policy object used.
Size_Policy&
get_size_policy();
/// Const access to the Size_Policy object used.
const Size_Policy&
get_size_policy() const;
/// Access to the Trigger_Policy object used.
Trigger_Policy&
get_trigger_policy();
/// Access to the Trigger_Policy object used.
const Trigger_Policy&
get_trigger_policy() const;
/// Returns the actual size of the container.
inline size_type
get_actual_size() const;
/// Resizes the container to suggested_new_size, a suggested size
/// (the actual size will be determined by the Size_Policy
/// object).
void
resize(size_type suggested_new_size);
protected:
inline void
notify_insert_search_start();
inline void
notify_insert_search_collision();
inline void
notify_insert_search_end();
inline void
notify_find_search_start();
inline void
notify_find_search_collision();
inline void
notify_find_search_end();
inline void
notify_erase_search_start();
inline void
notify_erase_search_collision();
inline void
notify_erase_search_end();
inline void
notify_inserted(size_type num_e);
inline void
notify_erased(size_type num_e);
void
notify_cleared();
void
notify_resized(size_type new_size);
inline bool
is_resize_needed() const;
/// Queries what the new size should be, when the container is
/// resized naturally. The current __size of the container is
/// size, and the number of used entries within the container is
/// num_used_e.
size_type
get_new_size(size_type size, size_type num_used_e) const;
private:
/// Resizes to new_size.
virtual void
do_resize(size_type new_size);
typedef Trigger_Policy trigger_policy_base;
typedef Size_Policy size_policy_base;
size_type m_size;
};
#include <ext/pb_ds/detail/resize_policy/hash_standard_resize_policy_imp.hpp>
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
} // namespace __gnu_pbds
#endif
|