aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/include/ext/pb_assoc/detail/hash_fn/ranged_probe_fn.hpp
blob: 61643d8d24675518257a7b58d955d8001910b369 (plain)
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
// -*- C++ -*-

// Copyright (C) 2005 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 2, 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.

// You should have received a copy of the GNU General Public License along
// with this library; see the file COPYING.  If not, write to the Free
// Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
// USA.

// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.

// 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 ranged_probe_fn.hpp
 * Contains a unified ranged probe functor, allowing the probe tables to deal with
 *	a single class for ranged probeing.
 */

#ifndef RANGED_PROBE_FN_HPP
#define RANGED_PROBE_FN_HPP

#include <ext/pb_assoc/hash_policy.hpp>
#include <utility>

namespace pb_assoc
{

  namespace detail
  {

#ifdef PB_ASSOC_RANGED_PROBE_FN_DEBUG
#define PB_ASSOC_DBG_ASSERT(X) assert(X)
#define PB_ASSOC_DBG_VERIFY(X) assert(X)
#define PB_ASSOC_DBG_ONLY(X) X
#else // #ifdef PB_ASSOC_RANGED_PROBE_FN_DEBUG
#define PB_ASSOC_DBG_ASSERT(X)
#define PB_ASSOC_DBG_VERIFY(X) {if((X)==0);}
#define PB_ASSOC_DBG_ONLY(X) ;
#endif // #ifdef PB_ASSOC_RANGED_PROBE_FN_DEBUG

    template<typename Key,
	     class Hash_Fn,
	     class Allocator,
	     class Comb_Probe_Fn,
	     class Probe_Fn,
	     bool Store_Hash>
    class ranged_probe_fn;

#define PB_ASSOC_CLASS_T_DEC \
	template< \
		typename Key, \
		class Hash_Fn, \
		class Allocator, \
		class Comb_Probe_Fn, \
		class Probe_Fn>

#define PB_ASSOC_CLASS_C_DEC \
	ranged_probe_fn< \
		Key, \
		Hash_Fn, \
		Allocator, \
		Comb_Probe_Fn, \
		Probe_Fn, \
		false>

    /**
     * Specialization 1- The client supplies a probe function and a ranged
     *	probe function, and requests that hash values not be stored.
     **/
    template<typename Key,
	     class Hash_Fn,
	     class Allocator,
	     class Comb_Probe_Fn,
	     class Probe_Fn>
    class ranged_probe_fn<
      Key,
      Hash_Fn,
      Allocator,
      Comb_Probe_Fn,
      Probe_Fn,
      false> : public Hash_Fn,
	       public Comb_Probe_Fn,
	       public Probe_Fn
    {
    protected:
      typedef typename Allocator::size_type size_type;

      typedef Comb_Probe_Fn my_comb_probe_fn_base;

      typedef Hash_Fn my_hash_fn_base;

      typedef Probe_Fn my_probe_fn_base;

      typedef typename Allocator::template rebind< Key>::other key_allocator;

      typedef typename key_allocator::const_reference const_key_reference;

    protected:
      ranged_probe_fn(size_type size);

      ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn);

      ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn);

      ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn, const Probe_Fn& r_probe_fn);

      void
      swap(PB_ASSOC_CLASS_C_DEC& r_other);

      void
      notify_resized(size_type size);

      inline size_type
      operator()(const_key_reference r_key) const;

      inline size_type
      operator()(const_key_reference r_key, size_type hash, size_type i) const;
    };

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size)
    {
      Comb_Probe_Fn::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn) :
      Hash_Fn(r_hash_fn)
    {
      Comb_Probe_Fn::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn) :
      Hash_Fn(r_hash_fn),
      Comb_Probe_Fn(r_comb_probe_fn)
    {
      my_comb_probe_fn_base::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn, const Probe_Fn& r_probe_fn) :
      Hash_Fn(r_hash_fn),
      Comb_Probe_Fn(r_comb_probe_fn),
      Probe_Fn(r_probe_fn)
    {
      my_comb_probe_fn_base::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    void
    PB_ASSOC_CLASS_C_DEC::
    swap(PB_ASSOC_CLASS_C_DEC& r_other)
    {
      my_comb_probe_fn_base::swap(r_other);

      std::swap((Hash_Fn& )(*this), (Hash_Fn& )r_other);
    }

    PB_ASSOC_CLASS_T_DEC
    void
    PB_ASSOC_CLASS_C_DEC::
    notify_resized(size_type size)
    {
      my_comb_probe_fn_base::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    inline typename PB_ASSOC_CLASS_C_DEC::size_type
    PB_ASSOC_CLASS_C_DEC::
    operator()(const_key_reference r_key) const
    {
      return (my_comb_probe_fn_base::operator()(
						my_hash_fn_base::operator()(r_key)));
    }

    PB_ASSOC_CLASS_T_DEC
    inline typename PB_ASSOC_CLASS_C_DEC::size_type
    PB_ASSOC_CLASS_C_DEC::
    operator()(const_key_reference r_key, size_type hash, size_type i) const
    {
      return (my_comb_probe_fn_base::operator()(
						hash + my_probe_fn_base::operator()(r_key, i)));
    }

#undef PB_ASSOC_CLASS_T_DEC
#undef PB_ASSOC_CLASS_C_DEC

#define PB_ASSOC_CLASS_T_DEC \
	template< \
		typename Key, \
		class Hash_Fn, \
		class Allocator, \
		class Comb_Probe_Fn, \
		class Probe_Fn>

#define PB_ASSOC_CLASS_C_DEC \
	ranged_probe_fn< \
		Key, \
		Hash_Fn, \
		Allocator, \
		Comb_Probe_Fn, \
		Probe_Fn, \
		true>

    /**
     * Specialization 2- The client supplies a probe function and a ranged
     *	probe function, and requests that hash values be stored.
     **/
    template<typename Key,
	     class Hash_Fn,
	     class Allocator,
	     class Comb_Probe_Fn,
	     class Probe_Fn>
    class ranged_probe_fn<
      Key,
      Hash_Fn,
      Allocator,
      Comb_Probe_Fn,
      Probe_Fn,
      true> :
      public Hash_Fn,
      public Comb_Probe_Fn,
      public Probe_Fn
    {
    protected:
      typedef typename Allocator::size_type size_type;

      typedef std::pair<size_type, size_type> comp_hash;

      typedef Comb_Probe_Fn my_comb_probe_fn_base;

      typedef Hash_Fn my_hash_fn_base;

      typedef Probe_Fn my_probe_fn_base;

      typedef typename Allocator::template rebind<Key>::other key_allocator;

      typedef typename key_allocator::const_reference const_key_reference;

    protected:
      ranged_probe_fn(size_type size);

      ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn);

      ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn);

      ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn, const Probe_Fn& r_probe_fn);

      void
      swap(PB_ASSOC_CLASS_C_DEC& r_other);

      void
      notify_resized(size_type size);

      inline comp_hash
      operator()(const_key_reference r_key) const;

      inline size_type
      operator()(const_key_reference r_key, size_type hash, size_type i) const;

      inline size_type
      operator()(const_key_reference r_key, size_type hash) const;
    };

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size)
    {
      Comb_Probe_Fn::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn) :
      Hash_Fn(r_hash_fn)
    {
      Comb_Probe_Fn::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn) :
      Hash_Fn(r_hash_fn),
      Comb_Probe_Fn(r_comb_probe_fn)
    {
      my_comb_probe_fn_base::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Hash_Fn& r_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn, const Probe_Fn& r_probe_fn) :
      Hash_Fn(r_hash_fn),
      Comb_Probe_Fn(r_comb_probe_fn),
      Probe_Fn(r_probe_fn)
    {
      my_comb_probe_fn_base::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    void
    PB_ASSOC_CLASS_C_DEC::
    swap(PB_ASSOC_CLASS_C_DEC& r_other)
    {
      my_comb_probe_fn_base::swap(r_other);

      std::swap((Hash_Fn& )(*this), (Hash_Fn& )r_other);
    }

    PB_ASSOC_CLASS_T_DEC
    void
    PB_ASSOC_CLASS_C_DEC::
    notify_resized(size_type size)
    {
      my_comb_probe_fn_base::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    inline typename PB_ASSOC_CLASS_C_DEC::comp_hash
    PB_ASSOC_CLASS_C_DEC::
    operator()(const_key_reference r_key) const
    {
      const size_type hash = my_hash_fn_base::operator()(r_key);

      return (std::make_pair(my_comb_probe_fn_base::operator()(hash), hash));
    }

    PB_ASSOC_CLASS_T_DEC
    inline typename PB_ASSOC_CLASS_C_DEC::size_type
    PB_ASSOC_CLASS_C_DEC::
    operator()(const_key_reference r_key, size_type hash, size_type i) const
    {
      return (my_comb_probe_fn_base::operator()(
						hash + my_probe_fn_base::operator()(r_key, i)));
    }

    PB_ASSOC_CLASS_T_DEC
    inline typename PB_ASSOC_CLASS_C_DEC::size_type
    PB_ASSOC_CLASS_C_DEC::
    operator()
#ifdef PB_ASSOC_RANGED_PROBE_FN_DEBUG
      (const_key_reference r_key, size_type hash) const
#else // #ifdef PB_ASSOC_RANGED_PROBE_FN_DEBUG
      (const_key_reference /*r_key*/, size_type hash) const
#endif // #ifdef PB_ASSOC_RANGED_PROBE_FN_DEBUG
    {
      PB_ASSOC_DBG_ASSERT(hash == my_hash_fn_base::operator()(r_key));

      return (hash);
    }

#undef PB_ASSOC_CLASS_T_DEC
#undef PB_ASSOC_CLASS_C_DEC

#define PB_ASSOC_CLASS_T_DEC \
	template<typename Key, class Allocator, class Comb_Probe_Fn>

#define PB_ASSOC_CLASS_C_DEC \
	ranged_probe_fn< \
		Key, \
		null_hash_fn, \
		Allocator, \
		Comb_Probe_Fn, \
		null_probe_fn, \
		false>

    /**
     * Specialization 3 and 4- The client does not supply a hash function or
     *	probe function, and requests that hash values not be stored.
     **/
    template<typename Key, class Allocator, class Comb_Probe_Fn>
    class ranged_probe_fn<
      Key,
      null_hash_fn,
      Allocator,
      Comb_Probe_Fn,
      null_probe_fn,
      false> :
      public Comb_Probe_Fn,
      public null_hash_fn,
      public null_probe_fn
    {
    protected:
      typedef typename Allocator::size_type size_type;

      typedef Comb_Probe_Fn my_comb_probe_fn_base;

      typedef typename Allocator::template rebind<Key>::other key_allocator;

      typedef typename key_allocator::const_reference const_key_reference;

    protected:
      ranged_probe_fn(size_type size);

      ranged_probe_fn(size_type size, const Comb_Probe_Fn& r_comb_probe_fn);

      ranged_probe_fn(size_type size, const null_hash_fn& r_null_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn, const null_probe_fn& r_null_probe_fn);

      void
      swap(PB_ASSOC_CLASS_C_DEC& r_other);
    };

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size)
    {
      Comb_Probe_Fn::notify_resized(size);
    }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const Comb_Probe_Fn& r_comb_probe_fn) :
      Comb_Probe_Fn(r_comb_probe_fn)
    { }

    PB_ASSOC_CLASS_T_DEC
    PB_ASSOC_CLASS_C_DEC::
    ranged_probe_fn(size_type size, const null_hash_fn& r_null_hash_fn, const Comb_Probe_Fn& r_comb_probe_fn, const null_probe_fn& r_null_probe_fn) :
      Comb_Probe_Fn(r_comb_probe_fn)
    { }

    PB_ASSOC_CLASS_T_DEC
    void
    PB_ASSOC_CLASS_C_DEC::
    swap(PB_ASSOC_CLASS_C_DEC& r_other)
    {
      my_comb_probe_fn_base::swap(r_other);
    }

#undef PB_ASSOC_CLASS_T_DEC
#undef PB_ASSOC_CLASS_C_DEC

#undef PB_ASSOC_DBG_ASSERT
#undef PB_ASSOC_DBG_VERIFY
#undef PB_ASSOC_DBG_ONLY

  } // namespace detail

} // namespace pb_assoc

#endif // #ifndef RANGED_PROBE_FN_HPP