Coin / src / misc / SbHash.h

  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
#ifndef COIN_SBHASH_H
#define COIN_SBHASH_H

/**************************************************************************\
 * Copyright (c) Kongsberg Oil & Gas Technologies AS
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/

// *************************************************************************
// This class (SbHash<Key, Type>) is internal and must not be exposed
// in the Coin API.

/**
   This function object is an extension of the STL concept "binary function".
   It is a goal to be as similar as possible to our STL counterpart.
*/

#ifndef COIN_INTERNAL
#error this is a private header file
#endif /* ! COIN_INTERNAL */

// *************************************************************************

#include <assert.h>
#include <stddef.h> // NULL
#include <string.h> // memset()

#include <Inventor/lists/SbList.h>
#include <Inventor/C/base/memalloc.h>

#include "tidbitsp.h"
#include "coindefs.h"
#include "SbBasicP.h"

// *************************************************************************

// We usually implement inline functions below the class definition,
// since we think that makes the file more readable. However, this is
// not done for this class, since Microsoft Visual C++ is not too
// happy about having functions declared as inline for a template
// class.

// *************************************************************************

// *************************************************************************

//Create an uint of an arbitrary length datatype
template <class T>
inline unsigned int toUint(T in) {
  if (sizeof(T)>sizeof(unsigned int)) {
    T retVal=in;
    for (size_t i = sizeof(T)/sizeof(unsigned int)-1; i>0; i--) {
      retVal^=in>>(i * 8 * sizeof(unsigned int));
    }
    return static_cast<unsigned int>(retVal);
  }
  else {
    return static_cast<unsigned int>(in);
  }
}

#if !defined(_MSC_VER) || (_MSC_VER >= 1300) // 'long long' not in vc6
#ifndef COIN_INTERNAL //Not available for internal use, as this is not
                    //available on all platforms.
inline unsigned int SbHashFunc(unsigned long long key) { return toUint<unsigned long long>(key); }
#endif //COIN_INTERNAL
#endif

/* Windows 64-bit uses the LLP64 type model, where int and long
 * are 32-bit and a pointer is 64-bit. Most Unices use the LP64
 * where int is 32-bit and long and pointer are 64-bit. */
/* FIXME: the following solution is a kludge. 20081001 tamer. */
#if defined(_WIN64)
inline unsigned int SbHashFunc(unsigned long long key) { return toUint<unsigned long long>(key); }
#else
//The identity hash function
inline unsigned int SbHashFunc(unsigned int key) { return key; }

//Some implementation of other basetypes
inline unsigned int SbHashFunc(int key) { return static_cast<unsigned int>(key); }

inline unsigned int SbHashFunc(unsigned long key) { return toUint<unsigned long>(key); }
#endif

//String has its own implementation
class SbString;
unsigned int SbHashFunc(const SbString & key);

/*
  Some implementations of pointers, all functions are per writing only reinterpret_casts to size_t
*/
//FIXME: Don't hold these definitions here, but where they are used - BFG 20080729
class SoBase;
class SoOutput;
class SoSensor;
unsigned int SbHashFunc(const SoBase * key);
unsigned int SbHashFunc(const SoOutput * key);
unsigned int SbHashFunc(const SoSensor * key);

template <class Key, class Type>
class SbHash {
 public:

  class SbHashEntry {
  public:

    void * operator new(size_t COIN_UNUSED_ARG(size), cc_memalloc * memhandler) {
      SbHashEntry * entry = static_cast<SbHashEntry *>(cc_memalloc_allocate(memhandler));
      entry->memhandler = memhandler;
      return static_cast<void *>(entry);
    }
    void operator delete(void * ptr, cc_memalloc * memhandler) {
      cc_memalloc_deallocate(memhandler, ptr);
    }
    void operator delete(void * ptr) {
      SbHashEntry * entry = static_cast<SbHashEntry *>( ptr);
      cc_memalloc_deallocate(entry->memhandler, ptr);
    }
  SbHashEntry(const Key & key, const Type & obj) : key(key), obj(obj) {}

    Key key;
    Type obj;
    SbHashEntry * next;
    cc_memalloc * memhandler;
  };

  class iterator {
  public:
    iterator(const iterator & iter) {
      this->master = iter.master;
      this->index  = iter.index;
      this->elem  = iter.elem;
    }
    SbHashEntry & operator*() {
      return *this->elem;
    }
    SbHashEntry * operator->() {
      return this->elem;
    }
    bool operator==(const iterator & rhs) const {
      return rhs.elem == this->elem;
    }
    bool operator!=(const iterator & rhs) const {
      return !((*this)==rhs);
    }
    iterator & operator++() {
      setNext();
      return *this;
    }
  private:
  iterator(const SbHash<Key, Type> * master_in) :
    master(master_in) {
      this->index=0;
      setNextUsedBucket();
    }
    iterator() {
      this->elem = NULL;
    }

    inline void setNextUsedBucket() {
      for (; this->index < this->master->size; ++this->index) {
        if (this->master->buckets[this->index]) {
          this->elem = this->master->buckets[this->index];
          return;
        }
      }
      this->elem = NULL;
    }

    inline void setNext(){
      if (this->elem->next) {
        this->elem = this->elem->next;
        return;
      }
      if (this->index<this->master->size)
        ++this->index;
      setNextUsedBucket();
    }

    SbHash<Key, Type> * master;
    unsigned int index;
    SbHashEntry * elem;
    friend class SbHash<Key, Type>;
  };

  class const_iterator {
  public:
    const_iterator(const iterator & iter) {
      this->master = iter.master;
      this->index  = iter.index;
      this->elem  = iter.elem;
    }
    const_iterator(const const_iterator & iter) {
      this->master = iter.master;
      this->index  = iter.index;
      this->elem  = iter.elem;
    }
    const SbHashEntry & operator*() {
      return *this->elem;
    }
    const SbHashEntry * operator->() {
      return this->elem;
    }
    bool operator==(const const_iterator & rhs) const {
      return rhs.elem == this->elem;
    }
    bool operator!=(const const_iterator & rhs) const {
      return !((*this)==rhs);
    }
    const_iterator & operator++() {
      setNext();
      return *this;
    }
  private:
  const_iterator(const SbHash<Key, Type> * master_in) :
    master(master_in) {
      this->index=0;
      setNextUsedBucket();
    }
    const_iterator() {
      this->elem = NULL;
    }

    inline void setNextUsedBucket() {
      for (; this->index < this->master->size; ++this->index) {
        if (this->master->buckets[this->index]) {
          this->elem = this->master->buckets[this->index];
          return;
        }
      }
      this->elem = NULL;
    }

    inline void setNext(){
      if (this->elem->next) {
        this->elem = this->elem->next;
        return;
      }
      if (this->index<this->master->size)
        ++this->index;
      setNextUsedBucket();
    }

    const SbHash<Key, Type> * master;
    unsigned int index;
    const SbHashEntry * elem;
    friend class SbHash<Key, Type>;
  };

  SbHash(unsigned int sizearg = 256, float loadfactorarg = 0.0f)
  {
    this->commonConstructor(sizearg, loadfactorarg);
  }

  SbHash(const SbHash & from)
  {
    this->commonConstructor(from.size, from.loadfactor);
    this->operator=(from);
  }

  SbHash & operator=(const SbHash & from)
  {
    this->clear();
    unsigned int i;
    SbHashEntry * elem;
    for (i = 0; i < from.size; ++i) {
      elem = from.buckets[i];
      while (elem) {
        this->put(elem->key, elem->obj);
        elem = elem->next;
      }
    }
    return *this;
  }

  ~SbHash()
  {
    this->clear();
    cc_memalloc_destruct(this->memhandler);
    delete [] this->buckets;
  }

  void clear(void)
  {
    unsigned int i;
    for (i = 0; i < this->size; i++) {
      while (this->buckets[i]) {
        SbHashEntry * entry = this->buckets[i];
        this->buckets[i] = entry->next;
        delete entry;
      }
    }
    memset(this->buckets, 0, this->size * sizeof(SbHashEntry *));
    this->elements = 0;
  }

  iterator begin() const {
    iterator retVal;

    retVal.master = this;
    retVal.index=0;

    return retVal;
  }

  iterator end() const {
    iterator retVal;

    retVal.master = this;
    retVal.index = this->size;

    return retVal;
  }

  const_iterator const_begin() const {
    return const_iterator (this);
  }

  const_iterator const_end() const {
    return const_iterator();
  }

  Type & operator[](const Key & key) {
    Type * obj;
    if (!getP(key,obj)) {
      Type dummy;
      SbBool ok;
      ok = put(key,dummy);
      assert(ok);
      ok = getP(key,obj);
      assert(ok);
    }
    return *obj;
  }
  
  size_t erase(const Key & key)
  {
    unsigned int i = this->getIndex(key);
    SbHashEntry * entry = this->buckets[i], * next, * prev = NULL;
    while (entry) {
      next = entry->next;
      if (entry->key == key) {
        this->elements--;
        if (prev == NULL) {
          this->buckets[i] = next;
        }
        else {
          prev->next = next;
        }
        delete entry;
        return 1;
      }
      prev = entry;
      entry = next;
    }
    return 0;
  }

  void makeKeyList(SbList<Key> & l) const
  {
    unsigned int i;
    SbHashEntry * elem;
    for (i = 0; i < this->size; ++i) {
      elem = this->buckets[i];
      while (elem) {
        l.append(elem->key);
        elem = elem->next;
      }
    }
  }

  unsigned int getNumElements(void) const { return this->elements; }

  const_iterator find(const Key & key) const
  {
    const_iterator iter(this);
    iter.index = this->getIndex(key);
    
    iter.elem = this->buckets[iter.index];
    while (iter.elem) {
      if (iter.elem->key == key) {
        return iter;
      }
      iter.elem = iter.elem->next;
    }
    return const_end();
  }


protected:
  unsigned int getIndex(const Key & key) const {
    unsigned int idx = SbHashFunc(key);
    return (idx % this->size);
  }

  void resize(unsigned int newsize) {
    /* we don't shrink the table */
    if (this->size >= newsize) return;

    unsigned int oldsize = this->size;
    SbHashEntry ** oldbuckets = this->buckets;

    this->size = newsize;
    this->elements = 0;
    this->threshold = static_cast<unsigned int> (newsize * this->loadfactor);
    this->buckets = new SbHashEntry * [newsize];
    memset(this->buckets, 0, this->size * sizeof(SbHashEntry *));

    /* Transfer all mappings */
    unsigned int i;
    for (i = 0; i < oldsize; i++) {
      SbHashEntry * entry = oldbuckets[i];
      while (entry) {
        this->put(entry->key, entry->obj);
        SbHashEntry * preventry = entry;
        entry = entry->next;
        delete preventry;
      }
    }
    delete [] oldbuckets;
  }

  //FIXME: Make this private when SbHash goes public: BFG 20090430
public:
  SbBool put(const Key & key, const Type & obj)
  {
    unsigned int i = this->getIndex(key);
    SbHashEntry * entry = this->buckets[i];
    while (entry) {
      if (entry->key == key) {
        /* Replace the old value */
        entry->obj = obj;
        return FALSE;
      }
      entry = entry->next;
    }

    /* Key not already in the hash table; insert a new
     * entry as the first element in the bucket
     */
    entry = new (this->memhandler) SbHashEntry(key, obj);
    entry->next = this->buckets[i];
    this->buckets[i] = entry;

    if (this->elements++ >= this->threshold) {
      this->resize(static_cast<unsigned int>( coin_geq_prime_number(this->size + 1)));
    }
    return TRUE;
  }

  SbBool get(const Key & key, Type & obj) const
  {
    SbHashEntry * entry;
    unsigned int i = this->getIndex(key);
    entry = this->buckets[i];
    while (entry) {
      if (entry->key == key) {
        obj = entry->obj;
        return TRUE;
      }
      entry = entry->next;
    }
    return FALSE;
  }

 private:
  SbBool getP(const Key & key, Type *& obj) const
  {
    SbHashEntry * entry;
    unsigned int i = this->getIndex(key);
    entry = this->buckets[i];
    while (entry) {
      if (entry->key == key) {
        obj = &entry->obj;
        return TRUE;
      }
      entry = entry->next;
    }
    return FALSE;
  }


  void commonConstructor(unsigned int sizearg, float loadfactorarg)
  {
    if (loadfactorarg <= 0.0f) { loadfactorarg = 0.75f; }
    unsigned int s = coin_geq_prime_number(sizearg);
    this->memhandler = cc_memalloc_construct(sizeof(SbHashEntry));
    this->size = s;
    this->elements = 0;
    this->threshold = static_cast<unsigned int> (s * loadfactorarg);
    this->loadfactor = loadfactorarg;
    this->buckets = new SbHashEntry * [this->size];
    memset(this->buckets, 0, this->size * sizeof(SbHashEntry *));
  }

  void getStats(int & buckets_used, int & buckets, int & elements, float & chain_length_avg, int & chain_length_max)
  {
    unsigned int i;
    buckets_used = 0, chain_length_max = 0;
    for (i = 0; i < this->size; i++) {
      if (this->buckets[i]) {
        unsigned int chain_l = 0;
        SbHashEntry * entry = this->buckets[i];
        buckets_used++;
        while (entry) {
          chain_l++;
          entry = entry->next;
        }
        if (chain_l > chain_length_max) { chain_length_max = chain_l; }
      }
    }
    buckets = this->size;
    elements = this->elements;
    chain_length_avg = static_cast<float>( this->elements / buckets_used);
  }

  float loadfactor;
  unsigned int size;
  unsigned int elements;
  unsigned int threshold;

  SbHashEntry ** buckets;
  cc_memalloc * memhandler;
};

#endif // !COIN_SBHASH_H
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.