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
|
/*=========================================================================
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.kitware.com/VolViewCopyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkHashMap - a dynamic map data structure
// .SECTION Description
// vtkHashMap is a an array implementation of the map data structure
//
// Map data structure is a one dimensional sequence of pairs
// of key and data. On the higher level, it implements mapping
// from key values to data elements. It can be implemented using
// array of pairs, hash table, or different trees.
// .SECTION See also
// vtkAbstractMap
#include "vtkAbstractMap.h"
#include "vtkWindows.h" // used for windows.h
#ifndef __vtkHashMap_h
#define __vtkHashMap_h
template<class DataType> class vtkVector;
template<class KeyType, class DataType> class vtkHashMapIterator;
template<class KeyType, class DataType>
class vtkHashMap : public vtkAbstractMap<KeyType,DataType>
{
friend class vtkHashMapIterator<KeyType,DataType>;
virtual const char* GetClassNameInternal() const {return "vtkHashMap";}
public:
typedef vtkAbstractMap<KeyType,DataType> Superclass;
typedef vtkHashMapIterator<KeyType,DataType> IteratorType;
// Cannot use this macro because of the comma in the type name.
// The CPP splits that in two and we ae in trouble.
//vtkContainerTypeMacro((vtkHashMap<KeyType,DataType>), vtkContainer);
void PrintSelf(ostream& os, vtkIndent indent);
static vtkHashMap<KeyType,DataType>* New();
// Description:
// Return an iterator to the list. This iterator is allocated using
// New, so the developer is responsible for deleating it.
vtkHashMapIterator<KeyType,DataType>* NewIterator();
// Description:
// Sets the item with the given key to the given data. It
// overwrites the old value if it exists, or inserts a new value
// otherwise. It returns VTK_OK if successfull.
int SetItem(const KeyType& key, const DataType& data);
// Description:
// Removes the item with the given key from the map. It returns
// VTK_OK if successfull.
int RemoveItem(const KeyType& key);
// Description:
// Remove all items from the map.
void RemoveAllItems();
// Description:
// Get the data asociated with the given key.
// It returns VTK_OK if successfull.
int GetItem(const KeyType& key, DataType& data);
// Description:
// Return the number of items currently held in this container.
vtkIdType GetNumberOfItems() const;
// Description:
// Set/Get the maximum allowed load factor. If the ratio of number
// of items to number of buckets exceeds this value, the number of
// buckets will be increased. A value of zero indicates that no
// re-hashing is to occur.
void SetMaximumLoadFactor(float factor);
float GetMaximumLoadFactor() const;
// Description:
// Set/Get the number of buckets currently used in the hash table.
// Setting the number of buckets will automatically set the
// MaximumLoadFactor to 0 to prevent resizing.
void SetNumberOfBuckets(vtkIdType n);
vtkIdType GetNumberOfBuckets() const;
protected:
vtkHashMap();
virtual ~vtkHashMap();
typedef vtkAbstractMapItem<KeyType,DataType> ItemType;
typedef vtkVector<ItemType> BucketType;
// Check if the load factor is okay. Increase number of buckets and
// re-hash if necessary.
void CheckLoadFactor();
// Change the number of buckets to the given number and re-hash the
// items.
void RehashItems(vtkIdType newNumberOfBuckets);
// Description:
// Hash a key to give an index in the range [0,nbuckets-1].
vtkIdType HashKey(const KeyType& key, vtkIdType nbuckets);
float MaximumLoadFactor;
vtkIdType NumberOfItems;
vtkIdType NumberOfBuckets;
BucketType** Buckets;
private:
vtkHashMap(const vtkHashMap<KeyType,DataType>&); // Not implemented
void operator=(const vtkHashMap<KeyType,DataType>&); // Not implemented
};
static inline unsigned long vtkHashMapHashMethod(int x)
{ return static_cast<unsigned long>(x); }
static inline unsigned long vtkHashMapHashMethod(const char* s)
{
unsigned long h = 0;
for(;*s;++s)
{
h = 5*h + *s;
}
return h;
}
static inline unsigned long vtkHashMapHashMethod(vtkObjectBase* o)
{
#if defined ( _MSC_VER )
return PtrToUlong(o);
#else
return reinterpret_cast<unsigned long>(o);
#endif
}
#ifdef VTK_NO_EXPLICIT_TEMPLATE_INSTANTIATION
#include "vtkHashMap.txx"
#endif
#endif
|