|
JUCE
|
Holds a set of mappings between some key/value pairs. More...
Classes | |
| class | Iterator |
| Iterates over the items in a HashMap. More... | |
Public Types | |
| typedef TypeOfCriticalSectionToUse::ScopedLockType | ScopedLockType |
| Returns the type of scoped lock to use for locking this array. More... | |
Public Member Functions | |
| HashMap (int numberOfSlots=defaultHashTableSize, HashFunctionType hashFunction=HashFunctionType()) | |
| Creates an empty hash-map. More... | |
| ~HashMap () | |
| Destructor. More... | |
| void | clear () |
| Removes all values from the map. More... | |
| int | size () const noexcept |
| Returns the current number of items in the map. More... | |
| ValueType | operator[] (KeyTypeParameter keyToLookFor) const |
| Returns the value corresponding to a given key. More... | |
| bool | contains (KeyTypeParameter keyToLookFor) const |
| Returns true if the map contains an item with the specied key. More... | |
| bool | containsValue (ValueTypeParameter valueToLookFor) const |
| Returns true if the hash contains at least one occurrence of a given value. More... | |
| void | set (KeyTypeParameter newKey, ValueTypeParameter newValue) |
| Adds or replaces an element in the hash-map. More... | |
| void | remove (KeyTypeParameter keyToRemove) |
| Removes an item with the given key. More... | |
| void | removeValue (ValueTypeParameter valueToRemove) |
| Removes all items with the given value. More... | |
| void | remapTable (int newNumberOfSlots) |
| Remaps the hash-map to use a different number of slots for its hash function. More... | |
| int | getNumSlots () const noexcept |
| Returns the number of slots which are available for hashing. More... | |
| template<class OtherHashMapType > | |
| void | swapWith (OtherHashMapType &otherHashMap) noexcept |
| Efficiently swaps the contents of two hash-maps. More... | |
| const TypeOfCriticalSectionToUse & | getLock () const noexcept |
| Returns the CriticalSection that locks this structure. More... | |
Holds a set of mappings between some key/value pairs.
The types of the key and value objects are set as template parameters. You can also specify a class to supply a hash function that converts a key value into an hashed integer. This class must have the form:
Like the Array class, the key and value types are expected to be copy-by-value types, so if you define them to be pointer types, this class won't delete the objects that they point to.
If you don't supply a class for the HashFunctionType template parameter, the default one provides some simple mappings for strings and ints.
| HashFunctionType | The class of hash function, which must be copy-constructible. |
| typedef TypeOfCriticalSectionToUse::ScopedLockType HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::ScopedLockType |
Returns the type of scoped lock to use for locking this array.
|
explicit |
Creates an empty hash-map.
| numberOfSlots | Specifies the number of hash entries the map will use. This will be the "upperLimit" parameter that is passed to your generateHash() function. The number of hash slots will grow automatically if necessary, or it can be remapped manually using remapTable(). |
| hashFunction | An instance of HashFunctionType, which will be copied and stored to use with the HashMap. This parameter can be omitted if HashFunctionType has a default constructor. |
| HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::~HashMap | ( | ) |
Destructor.
| void HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::clear | ( | ) |
Removes all values from the map.
Note that this will clear the content, but won't affect the number of slots (see remapTable and getNumSlots).
|
noexcept |
Returns the current number of items in the map.
| ValueType HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::operator[] | ( | KeyTypeParameter | keyToLookFor | ) | const |
Returns the value corresponding to a given key.
If the map doesn't contain the key, a default instance of the value type is returned.
| keyToLookFor | the key of the item being requested |
| bool HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::contains | ( | KeyTypeParameter | keyToLookFor | ) | const |
Returns true if the map contains an item with the specied key.
| bool HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::containsValue | ( | ValueTypeParameter | valueToLookFor | ) | const |
Returns true if the hash contains at least one occurrence of a given value.
| void HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::set | ( | KeyTypeParameter | newKey, |
| ValueTypeParameter | newValue | ||
| ) |
Adds or replaces an element in the hash-map.
If there's already an item with the given key, this will replace its value. Otherwise, a new item will be added to the map.
Referenced by HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::remapTable().
| void HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::remove | ( | KeyTypeParameter | keyToRemove | ) |
Removes an item with the given key.
| void HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::removeValue | ( | ValueTypeParameter | valueToRemove | ) |
Removes all items with the given value.
| void HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::remapTable | ( | int | newNumberOfSlots | ) |
Remaps the hash-map to use a different number of slots for its hash function.
Each slot corresponds to a single hash-code, and each one can contain multiple items.
References HashMap< KeyType, ValueType, HashFunctionType, TypeOfCriticalSectionToUse >::set().
|
noexcept |
Returns the number of slots which are available for hashing.
Each slot corresponds to a single hash-code, and each one can contain multiple items.
|
noexcept |
Efficiently swaps the contents of two hash-maps.
|
noexcept |
Returns the CriticalSection that locks this structure.
To lock, you can call getLock().enter() and getLock().exit(), or preferably use an object of ScopedLockType as an RAII lock for it.
