KTypeVTypeOpenHashMap (HPPC v0.5.2 API Documentation (JavaDoc))

java.lang.Object
- com.carrotsearch.hppc.KTypeVTypeOpenHashMap<KType,VType>

All Implemented Interfaces:: KTypeVTypeAssociativeContainer<KType,VType>, KTypeVTypeMap<KType,VType>, java.lang.Cloneable, java.lang.Iterable<KTypeVTypeCursor<KType,VType>>

public class KTypeVTypeOpenHashMap<KType,VType>
extends java.lang.Object
implements KTypeVTypeMap<KType,VType>, java.lang.Cloneable

A hash map of KType to VType, implemented using open addressing with linear probing for collision resolution.

The internal buffers of this implementation (keys, values, allocated) are always allocated to the nearest size that is a power of two. When the capacity exceeds the given load factor, the buffer size is doubled.

#if ($TemplateOptions.AllGeneric)

A brief comparison of the API against the Java Collections framework:

Java Collections HashMap and HPPC `ObjectObjectOpenHashMap`, related methods.
java.util.HashMap	`ObjectObjectOpenHashMap`
V put(K)	V put(K)
V get(K)	V get(K)
V remove(K)	V remove(K)
size, clear, isEmpty	size, clear, isEmpty
containsKey(K)	containsKey(K), lget()
containsValue(K)	(no efficient equivalent)
keySet, entrySet	iterator over map entries, keySet, pseudo-closures

#else

See ObjectObjectOpenHashMap class for API similarities and differences against Java Collections. #end #if ($TemplateOptions.KTypeGeneric)

This implementation supports null keys.

#end #if ($TemplateOptions.VTypeGeneric)

This implementation supports null values.

#end

Important node. The implementation uses power-of-two tables and linear probing, which may cause poor performance (many collisions) if hash values are not properly distributed. This implementation uses rehashing using MurmurHash3.

Author:: This code is inspired by the collaboration and implementation in the fastutil project.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class KTypeVTypeOpenHashMap.KeysContainer
A view of the keys inside this hash map.

Nested Classes
Modifier and Type	Class and Description
`class`	`KTypeVTypeOpenHashMap.KeysContainer` A view of the keys inside this hash map.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean[]`	`allocated` Information if an entry (slot) in the `values` table is allocated or empty.
`int`	`assigned` Cached number of assigned slots in `allocated`.
`static int`	`DEFAULT_CAPACITY` Default capacity.
`static float`	`DEFAULT_LOAD_FACTOR` Default load factor.
`KType[]`	`keys` Hash-indexed array holding all keys.
`protected int`	`lastSlot` The most recent slot accessed in `containsKey(KType)` (required for `lget()`).
`float`	`loadFactor` The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).
`static int`	`MIN_CAPACITY` Minimum capacity for the map.
`protected int`	`perturbation` We perturb hashed values with the array size to avoid problems with nearly-sorted-by-hash values on iterations.
`protected int`	`resizeAt` Resize buffers when `allocated` hits this value.
`VType[]`	`values` Hash-indexed array holding all values associated to the keys stored in `keys`.

Constructor Summary

Constructors
Constructor and Description
`KTypeVTypeOpenHashMap()` Creates a hash map with the default capacity of 16, load factor of 0.75f.
`KTypeVTypeOpenHashMap(int initialCapacity)` Creates a hash map with the given initial capacity, default load factor of 0.75f.
`KTypeVTypeOpenHashMap(int initialCapacity, float loadFactor)` Creates a hash map with the given initial capacity, load factor.
`KTypeVTypeOpenHashMap(KTypeVTypeAssociativeContainer<KType,VType> container)` Create a hash map from all key-value pairs of another container.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear all keys and values in the container.
`KTypeVTypeOpenHashMap<KType,VType>`	`clone()`
`protected int`	`computePerturbationValue(int capacity)` Compute the key perturbation value applied before hashing.
`boolean`	`containsKey(KType key)` Returns `true` if this container has an association to a value for the given key.
`boolean`	`equals(java.lang.Object obj)` Compares the specified object with this set for equality.
`<T extends KTypeVTypeProcedure<? super KType,? super VType>> T`	`forEach(T procedure)` Applies a given procedure to all keys-value pairs in this container.
`static <KType,VType> KTypeVTypeOpenHashMap<KType,VType>`	`from(KType[] keys, VType[] values)` Creates a hash map from two index-aligned arrays of key-value pairs.
`static <KType,VType> KTypeVTypeOpenHashMap<KType,VType>`	`from(KTypeVTypeAssociativeContainer<KType,VType> container)` Create a hash map from another associative container.
`VType`	`get(KType key)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Iterator<KTypeVTypeCursor<KType,VType>>`	`iterator()` Returns a cursor over the entries (key-value pairs) in this map.
`KTypeVTypeOpenHashMap.KeysContainer`	`keys()` Returns a specialized view of the keys of this associated container.
`VType`	`lget()` Returns the last value saved in a call to `containsKey(KType)`.
`KType`	`lkey()` Returns the last key stored in this has map for the corresponding most recent call to `containsKey(KType)`.
`VType`	`lset(VType key)` Sets the value corresponding to the key saved in the last call to `containsKey(KType)`, if and only if the key exists in the map already.
`int`	`lslot()`
`static <KType,VType> KTypeVTypeOpenHashMap<KType,VType>`	`newInstance()` Create a new hash map without providing the full generic signature (constructor shortcut).
`static <KType,VType> KTypeVTypeOpenHashMap<KType,VType>`	`newInstance(int initialCapacity, float loadFactor)` Create a new hash map without providing the full generic signature (constructor shortcut).
`static <KType,VType> KTypeVTypeOpenHashMap<KType,VType>`	`newInstanceWithoutPerturbations()` Returns a new object with no key perturbations (see `computePerturbationValue(int)`).
`VType`	`put(KType key, VType value)` Place a given key and value in the container.
`int`	`putAll(java.lang.Iterable<? extends KTypeVTypeCursor<? extends KType,? extends VType>> iterable)` Puts all key/value pairs from a given iterable into this map.
`int`	`putAll(KTypeVTypeAssociativeContainer<? extends KType,? extends VType> container)` Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
`boolean`	`putIfAbsent(KType key, VType value)` Trove-inspired API method.
`VType`	`remove(KType key)` Remove all values at the given key.
`int`	`removeAll(KTypeContainer<? extends KType> container)` Removes all keys (and associated values) present in a given container.
`int`	`removeAll(KTypePredicate<? super KType> predicate)` Removes all keys (and associated values) for which the predicate returns `true`.
`protected void`	`shiftConflictingKeys(int slotCurr)` Shift all the slot-conflicting keys allocated to (and including) `slot`.
`int`	`size()`
`java.lang.String`	`toString()` Convert the contents of this map to a human-friendly string.
`KTypeContainer<VType>`	`values()` Returns a container view of all values present in this container.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_CAPACITY
```
public static final int MIN_CAPACITY
```
    Minimum capacity for the map.
    
    See Also:
    Constant Field Values
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    Default capacity.
    
    See Also:
    Constant Field Values
  - DEFAULT_LOAD_FACTOR
```
public static final float DEFAULT_LOAD_FACTOR
```
    Default load factor.
    
    See Also:
    Constant Field Values
  - keys
```
public KType[] keys
```
    Hash-indexed array holding all keys.
    
    See Also:
    values
  - values
```
public VType[] values
```
    Hash-indexed array holding all values associated to the keys stored in keys.
    
    See Also:
    keys
  - allocated
```
public boolean[] allocated
```
    Information if an entry (slot) in the values table is allocated or empty.
    
    See Also:
    assigned
  - assigned
```
public int assigned
```
    Cached number of assigned slots in allocated.
  - loadFactor
```
public final float loadFactor
```
    The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).
  - resizeAt
```
protected int resizeAt
```
    Resize buffers when allocated hits this value.
  - lastSlot
```
protected int lastSlot
```
    The most recent slot accessed in containsKey(KType) (required for lget()).
    
    See Also:
    containsKey(KType), lget()
  - perturbation
```
protected int perturbation
```
    We perturb hashed values with the array size to avoid problems with nearly-sorted-by-hash values on iterations.
    
    See Also:
    "http://issues.carrot2.org/browse/HPPC-80"
- Constructor Detail
  - KTypeVTypeOpenHashMap
```
public KTypeVTypeOpenHashMap()
```
    Creates a hash map with the default capacity of 16, load factor of 0.75f.
    See class notes about hash distribution importance.
  - KTypeVTypeOpenHashMap
```
public KTypeVTypeOpenHashMap(int initialCapacity)
```
    Creates a hash map with the given initial capacity, default load factor of 0.75f.
    See class notes about hash distribution importance.
    
    Parameters:
    initialCapacity - Initial capacity (greater than zero and automatically rounded to the next power of two).
  - KTypeVTypeOpenHashMap
```
public KTypeVTypeOpenHashMap(int initialCapacity,
                     float loadFactor)
```
    Creates a hash map with the given initial capacity, load factor.
    See class notes about hash distribution importance.
    
    Parameters:
    initialCapacity - Initial capacity (greater than zero and automatically rounded to the next power of two).
    loadFactor - The load factor (greater than zero and smaller than 1).
  - KTypeVTypeOpenHashMap
```
public KTypeVTypeOpenHashMap(KTypeVTypeAssociativeContainer<KType,VType> container)
```
    Create a hash map from all key-value pairs of another container.
- Method Detail
  - put
```
public VType put(KType key,
        VType value)
```
    Place a given key and value in the container.
    
    Specified by:
    
    put in interface KTypeVTypeMap<KType,VType>
    
    Returns:
    The value previously stored under the given key in the map is returned.
  - putAll
```
public int putAll(KTypeVTypeAssociativeContainer<? extends KType,? extends VType> container)
```
    Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
    
    Specified by:
    
    putAll in interface KTypeVTypeMap<KType,VType>
    
    Returns:
    Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.
  - putAll
```
public int putAll(java.lang.Iterable<? extends KTypeVTypeCursor<? extends KType,? extends VType>> iterable)
```
    Puts all key/value pairs from a given iterable into this map.
    
    Specified by:
    
    putAll in interface KTypeVTypeMap<KType,VType>
    
    Returns:
    Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.
  - putIfAbsent
```
public boolean putIfAbsent(KType key,
                  VType value)
```
    Trove-inspired API method. An equivalent of the following code:
```
 if (!map.containsKey(key)) map.put(value);
 
```
    Parameters:
    key - The key of the value to check.
    value - The value to put if key does not exist.
    
    Returns:
    true if key did not exist and value was placed in the map.
  - computePerturbationValue
```
protected int computePerturbationValue(int capacity)
```
    Compute the key perturbation value applied before hashing. The returned value should be non-zero and ideally different for each capacity. This matters because keys are nearly-ordered by their hashed values so when adding one container's values to the other, the number of collisions can skyrocket into the worst case possible.
    If it is known that hash containers will not be added to each other (will be used for counting only, for example) then some speed can be gained by not perturbing keys before hashing and returning a value of zero for all possible capacities. The speed gain is a result of faster rehash operation (keys are mostly in order).
  - remove
```
public VType remove(KType key)
```
    Remove all values at the given key. The default value for the key type is returned if the value does not exist in the map.
    
    Specified by:
    
    remove in interface KTypeVTypeMap<KType,VType>
  - shiftConflictingKeys
```
protected void shiftConflictingKeys(int slotCurr)
```
    Shift all the slot-conflicting keys allocated to (and including) slot.
  - removeAll
```
public int removeAll(KTypeContainer<? extends KType> container)
```
    Removes all keys (and associated values) present in a given container. An alias to:
```
 keys().removeAll(container)
 
```
    but with no additional overhead.
    Specified by:
    
    removeAll in interface KTypeVTypeAssociativeContainer<KType,VType>
    
    Returns:
    Returns the number of elements actually removed as a result of this call.
  - removeAll
```
public int removeAll(KTypePredicate<? super KType> predicate)
```
    Removes all keys (and associated values) for which the predicate returns true. An alias to:
```
 keys().removeAll(container)
 
```
    but with no additional overhead.
    Specified by:
    
    removeAll in interface KTypeVTypeAssociativeContainer<KType,VType>
    
    Returns:
    Returns the number of elements actually removed as a result of this call.
  - get
```
public VType get(KType key)
```
    Use the following snippet of code to check for key existence first and then retrieve the value if it exists.
```
 if (map.containsKey(key))
   value = map.lget(); 
 
```
    Specified by:
    
    get in interface KTypeVTypeMap<KType,VType>
    
    Returns:
    Returns the value associated with the given key or the default value for the key type, if the key is not associated with any value. Important note: For primitive type values, the value returned for a non-existing key may not be the default value of the primitive type (it may be any value previously assigned to that slot).
  - lkey
```
public KType lkey()
```
    Returns the last key stored in this has map for the corresponding most recent call to containsKey(KType).
    Use the following snippet of code to check for key existence first and then retrieve the key value if it exists.
```
 if (map.containsKey(key))
   value = map.lkey(); 
 
```
    This is equivalent to calling:
```
 if (map.containsKey(key))
   key = map.keys[map.lslot()];
 
```
  - lget
```
public VType lget()
```
    Returns the last value saved in a call to containsKey(KType).
    
    See Also:
    containsKey(KType)
  - lset
```
public VType lset(VType key)
```
    Sets the value corresponding to the key saved in the last call to containsKey(KType), if and only if the key exists in the map already.
    
    Returns:
    Returns the previous value stored under the given key.
    See Also:
    containsKey(KType)
  - lslot
```
public int lslot()
```
    Returns:
    Returns the slot of the last key looked up in a call to containsKey(KType) if it returned true.
    See Also:
    containsKey(KType)
  - containsKey
```
public boolean containsKey(KType key)
```
    Returns true if this container has an association to a value for the given key.
    Saves the associated value for fast access using lget() or lset(VType).
```
 if (map.containsKey(key))
   value = map.lget();
 
```
    or, to modify the value at the given key without looking up its slot twice:
```
 if (map.containsKey(key))
   map.lset(map.lget() + 1);
 
```
    #if ($TemplateOptions.KTypeGeneric) or, to retrieve the key-equivalent object from the map:
```
 if (map.containsKey(key))
   map.lkey();
 
```
    #end
    Specified by:
    
    containsKey in interface KTypeVTypeAssociativeContainer<KType,VType>
  - clear
```
public void clear()
```
    Clear all keys and values in the container.
    Does not release internal buffers.
    
    Specified by:
    
    clear in interface KTypeVTypeAssociativeContainer<KType,VType>
  - size
```
public int size()
```
    Specified by:
    
    size in interface KTypeVTypeAssociativeContainer<KType,VType>
    
    Returns:
    Returns the current size (number of assigned keys) in the container.
  - isEmpty
```
public boolean isEmpty()
```
    Note that an empty container may still contain many deleted keys (that occupy buffer space). Adding even a single element to such a container may cause rehashing.
    
    Specified by:
    
    isEmpty in interface KTypeVTypeAssociativeContainer<KType,VType>
    
    Returns:
    Return true if this hash map contains no assigned keys.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface KTypeVTypeMap<KType,VType>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A hash code of elements stored in the map. The hash code is defined as a sum of hash codes of keys and values stored within the set). Because sum is commutative, this ensures that different order of elements in a set does not affect the hash code.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares the specified object with this set for equality. Returns true if and only if the specified object is also a KTypeVTypeMap and both objects contains exactly the same key-value pairs.
    
    Specified by:
    
    equals in interface KTypeVTypeMap<KType,VType>
    
    Overrides:
    
    equals in class java.lang.Object
  - iterator
```
public java.util.Iterator<KTypeVTypeCursor<KType,VType>> iterator()
```
    Returns a cursor over the entries (key-value pairs) in this map. The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next(). To read the current key and value use the cursor's public fields. An example is shown below.
```
 for (IntShortCursor c : intShortMap)
 {
     System.out.println("index=" + c.index 
       + " key=" + c.key
       + " value=" + c.value);
 }
 
```
    The index field inside the cursor gives the internal index inside the container's implementation. The interpretation of this index depends on to the container.
    Specified by:
    
    iterator in interface KTypeVTypeAssociativeContainer<KType,VType>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<KTypeVTypeCursor<KType,VType>>
  - forEach
```
public <T extends KTypeVTypeProcedure<? super KType,? super VType>> T forEach(T procedure)
```
    Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of KTypeVTypeProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example.
    
    Specified by:
    
    forEach in interface KTypeVTypeAssociativeContainer<KType,VType>
  - keys
```
public KTypeVTypeOpenHashMap.KeysContainer keys()
```
    Returns a specialized view of the keys of this associated container. The view additionally implements ObjectLookupContainer.
    
    Specified by:
    
    keys in interface KTypeVTypeAssociativeContainer<KType,VType>
  - values
```
public KTypeContainer<VType> values()
```
    Description copied from interface: KTypeVTypeAssociativeContainer
    
    Returns a container view of all values present in this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
    
    Specified by:
    
    values in interface KTypeVTypeAssociativeContainer<KType,VType>
    
    Returns:
    Returns a container with all values stored in this map.
  - clone
```
public KTypeVTypeOpenHashMap<KType,VType> clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this map to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object
  - from
```
public static <KType,VType> KTypeVTypeOpenHashMap<KType,VType> from(KType[] keys,
                                                    VType[] values)
```
    Creates a hash map from two index-aligned arrays of key-value pairs.
  - from
```
public static <KType,VType> KTypeVTypeOpenHashMap<KType,VType> from(KTypeVTypeAssociativeContainer<KType,VType> container)
```
    Create a hash map from another associative container.
  - newInstance
```
public static <KType,VType> KTypeVTypeOpenHashMap<KType,VType> newInstance()
```
    Create a new hash map without providing the full generic signature (constructor shortcut).
  - newInstanceWithoutPerturbations
```
public static <KType,VType> KTypeVTypeOpenHashMap<KType,VType> newInstanceWithoutPerturbations()
```
    Returns a new object with no key perturbations (see computePerturbationValue(int)). Only use when sure the container will not be used for direct copying of keys to another hash container.
  - newInstance
```
public static <KType,VType> KTypeVTypeOpenHashMap<KType,VType> newInstance(int initialCapacity,
                                                           float loadFactor)
```
    Create a new hash map without providing the full generic signature (constructor shortcut).

Class KTypeVTypeOpenHashMap<KType,VType>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_CAPACITY

DEFAULT_CAPACITY

DEFAULT_LOAD_FACTOR

keys

values

allocated

assigned

loadFactor

resizeAt

lastSlot

perturbation

Constructor Detail

KTypeVTypeOpenHashMap

KTypeVTypeOpenHashMap

KTypeVTypeOpenHashMap

KTypeVTypeOpenHashMap

Method Detail

put

putAll

putAll

putIfAbsent

computePerturbationValue

remove

shiftConflictingKeys

removeAll

removeAll

get

lkey

lget

lset

lslot

containsKey

clear

size

isEmpty

hashCode

equals

iterator

forEach

keys

values

clone

toString

from

from

newInstance

newInstanceWithoutPerturbations

newInstance