Package com.carrotsearch.hppc
Class IntObjectHashMap<VType>
- java.lang.Object
-
- com.carrotsearch.hppc.IntObjectHashMap<VType>
-
- All Implemented Interfaces:
IntObjectAssociativeContainer<VType>
,IntObjectMap<VType>
,Preallocable
,java.lang.Cloneable
,java.lang.Iterable<IntObjectCursor<VType>>
- Direct Known Subclasses:
IntObjectScatterMap
@Generated(date="2024-05-16T12:00:00+0000", value="KTypeVTypeHashMap.java") public class IntObjectHashMap<VType> extends java.lang.Object implements IntObjectMap<VType>, Preallocable, java.lang.Cloneable
A hash map ofint
toObject
, implemented using open addressing with linear probing for collision resolution.Note: read about important differences between hash and scatter sets.
- See Also:
IntObjectScatterMap
, HPPC interfaces diagram
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
IntObjectHashMap.EntryIterator
An iterator implementation foriterator()
.class
IntObjectHashMap.KeysContainer
A view of the keys inside this hash map.private class
IntObjectHashMap.KeysIterator
An iterator over the set of assigned keys.private class
IntObjectHashMap.ValuesContainer
A view over the set of values of this map.private class
IntObjectHashMap.ValuesIterator
An iterator over the set of assigned values.
-
Field Summary
Fields Modifier and Type Field Description protected int
assigned
The number of stored keys (assigned key slots), excluding the special "empty" key, if any (usesize()
instead).protected boolean
hasEmptyKey
Special treatment for the "empty slot" key marker.protected int
keyMixer
We perturb hash values with a container-unique seed to avoid problems with nearly-sorted-by-hash values on iterations.int[]
keys
The array holding keys.protected double
loadFactor
The load factor forkeys
.protected int
mask
Mask for slot scans inkeys
.protected HashOrderMixingStrategy
orderMixer
Per-instance hash order mixing strategy.protected int
resizeAt
java.lang.Object[]
values
The array holding values.
-
Constructor Summary
Constructors Constructor Description IntObjectHashMap()
New instance with sane defaults.IntObjectHashMap(int expectedElements)
New instance with sane defaults.IntObjectHashMap(int expectedElements, double loadFactor)
New instance with sane defaults.IntObjectHashMap(int expectedElements, double loadFactor, HashOrderMixingStrategy orderMixer)
New instance with the provided defaults.IntObjectHashMap(IntObjectAssociativeContainer<? extends VType> container)
Create a hash map from all key-value pairs of another container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
allocateBuffers(int arraySize)
Allocate new internal buffers.protected void
allocateThenInsertThenRehash(int slot, int pendingKey, VType pendingValue)
This method is invoked when there is a new key/ value pair to be inserted into the buffers but there is not enough empty slots to do so.void
clear()
Clear all keys and values in the container.IntObjectHashMap<VType>
clone()
boolean
containsKey(int key)
Returnstrue
if this container has an association to a value for the given key.void
ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.protected boolean
equalElements(IntObjectHashMap<?> other)
Return true if all keys of some other container exist in this container.boolean
equals(java.lang.Object obj)
Compares the specified object with this set for equality.<T extends IntObjectProcedure<? super VType>>
TforEach(T procedure)
Applies a given procedure to all keys-value pairs in this container.static <VType> IntObjectHashMap<VType>
from(int[] keys, VType[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.VType
get(int key)
VType
getOrDefault(int key, VType defaultValue)
int
hashCode()
protected int
hashKey(int key)
Returns a hash code for the given key.boolean
indexExists(int index)
VType
indexGet(int index)
Returns the value associated with an existing key.void
indexInsert(int index, int key, VType value)
Inserts a key-value pair for a key that is not present in the map.int
indexOf(int key)
Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic).VType
indexReplace(int index, VType newValue)
Replaces the value associated with an existing key and returns any previous value stored for that key.boolean
isEmpty()
java.util.Iterator<IntObjectCursor<VType>>
iterator()
Returns a cursor over the entries (key-value pairs) in this map.IntObjectHashMap.KeysContainer
keys()
Returns a specialized view of the keys of this associated container.VType
put(int key, VType value)
Place a given key and value in the container.int
putAll(IntObjectAssociativeContainer<? extends VType> container)
Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.int
putAll(java.lang.Iterable<? extends IntObjectCursor<? extends VType>> iterable)
Puts all key/value pairs from a given iterable into this map.boolean
putIfAbsent(int key, VType value)
Trove-inspired API method.protected void
rehash(int[] fromKeys, VType[] fromValues)
Rehash from old buffers to new buffers.void
release()
Removes all elements from the collection and additionally releases any internal buffers.VType
remove(int key)
Remove all values at the given key.int
removeAll(IntContainer other)
Removes all keys (and associated values) present in a given container.int
removeAll(IntObjectPredicate<? super VType> predicate)
Removes all keys (and associated values) for which the predicate returnstrue
.int
removeAll(IntPredicate predicate)
Removes all keys (and associated values) for which the predicate returnstrue
.protected void
shiftConflictingKeys(int gapSlot)
Shift all the slot-conflicting keys and values allocated to (and including)slot
.int
size()
java.lang.String
toString()
Convert the contents of this map to a human-friendly string.ObjectCollection<VType>
values()
Returns a container view of all values present in this container.protected double
verifyLoadFactor(double loadFactor)
Validate load factor range and return it.java.lang.String
visualizeKeyDistribution(int characters)
Visually depict the distribution of keys.
-
-
-
Field Detail
-
keys
public int[] keys
The array holding keys.
-
values
public java.lang.Object[] values
The array holding values.
-
keyMixer
protected int keyMixer
We perturb hash values with a container-unique seed to avoid problems with nearly-sorted-by-hash values on iterations.- See Also:
hashKey(int)
, "http://issues.carrot2.org/browse/HPPC-80", "http://issues.carrot2.org/browse/HPPC-103"
-
assigned
protected int assigned
The number of stored keys (assigned key slots), excluding the special "empty" key, if any (usesize()
instead).- See Also:
size()
-
mask
protected int mask
Mask for slot scans inkeys
.
-
resizeAt
protected int resizeAt
-
hasEmptyKey
protected boolean hasEmptyKey
Special treatment for the "empty slot" key marker.
-
loadFactor
protected double loadFactor
The load factor forkeys
.
-
orderMixer
protected HashOrderMixingStrategy orderMixer
Per-instance hash order mixing strategy.- See Also:
keyMixer
-
-
Constructor Detail
-
IntObjectHashMap
public IntObjectHashMap()
New instance with sane defaults.
-
IntObjectHashMap
public IntObjectHashMap(int expectedElements)
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
IntObjectHashMap
public IntObjectHashMap(int expectedElements, double loadFactor)
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).loadFactor
- The load factor for internal buffers. Insane load factors (zero, full capacity) are rejected byverifyLoadFactor(double)
.
-
IntObjectHashMap
public IntObjectHashMap(int expectedElements, double loadFactor, HashOrderMixingStrategy orderMixer)
New instance with the provided defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause a rehash (inclusive).loadFactor
- The load factor for internal buffers. Insane load factors (zero, full capacity) are rejected byverifyLoadFactor(double)
.orderMixer
- Hash key order mixing strategy. SeeHashOrderMixing
for predefined implementations. Use constant mixers only if you understand the potential consequences.
-
IntObjectHashMap
public IntObjectHashMap(IntObjectAssociativeContainer<? extends VType> container)
Create a hash map from all key-value pairs of another container.
-
-
Method Detail
-
put
public VType put(int key, VType value)
Place a given key and value in the container.- Specified by:
put
in interfaceIntObjectMap<VType>
- Returns:
- The value previously stored under the given key in the map is returned.
-
putAll
public int putAll(IntObjectAssociativeContainer<? 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 interfaceIntObjectMap<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 IntObjectCursor<? extends VType>> iterable)
Puts all key/value pairs from a given iterable into this map.- Specified by:
putAll
in interfaceIntObjectMap<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(int 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 ifkey
does not exist.- Returns:
true
ifkey
did not exist andvalue
was placed in the map.
-
remove
public VType remove(int 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 interfaceIntObjectMap<VType>
-
removeAll
public int removeAll(IntContainer other)
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 interfaceIntObjectAssociativeContainer<VType>
- Returns:
- Returns the number of elements actually removed as a result of this call.
-
removeAll
public int removeAll(IntObjectPredicate<? super VType> predicate)
Removes all keys (and associated values) for which the predicate returnstrue
.- Specified by:
removeAll
in interfaceIntObjectAssociativeContainer<VType>
- Returns:
- Returns the number of elements actually removed as a result of this call.
-
removeAll
public int removeAll(IntPredicate predicate)
Removes all keys (and associated values) for which the predicate returnstrue
.- Specified by:
removeAll
in interfaceIntObjectAssociativeContainer<VType>
- Returns:
- Returns the number of elements actually removed as a result of this call.
-
get
public VType get(int key)
- Specified by:
get
in interfaceIntObjectMap<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).
-
getOrDefault
public VType getOrDefault(int key, VType defaultValue)
- Specified by:
getOrDefault
in interfaceIntObjectMap<VType>
- Returns:
- Returns the value associated with the given key or the provided default value if the key is not associated with any value.
-
containsKey
public boolean containsKey(int key)
Returnstrue
if this container has an association to a value for the given key.- Specified by:
containsKey
in interfaceIntObjectAssociativeContainer<VType>
-
indexOf
public int indexOf(int key)
Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic). The semantics of "indexes" are not strictly defined. Indexes may (and typically won't be) contiguous. The index is valid only between map modifications (it will not be affected by read-only operations like iteration or value retrievals).- Specified by:
indexOf
in interfaceIntObjectMap<VType>
- Parameters:
key
- The key to locate in the map.- Returns:
- A non-negative value of the logical "index" of the key in the map or a negative value if the key did not exist.
- See Also:
IntObjectMap.indexExists(int)
,IntObjectMap.indexGet(int)
,IntObjectMap.indexInsert(int, int, VType)
,IntObjectMap.indexReplace(int, VType)
-
indexExists
public boolean indexExists(int index)
- Specified by:
indexExists
in interfaceIntObjectMap<VType>
- Parameters:
index
- The index of a given key, as returned fromIntObjectMap.indexOf(int)
.- Returns:
- Returns
true
if the index corresponds to an existing key or false otherwise. This is equivalent to checking whether the index is a positive value (existing keys) or a negative value (non-existing keys). - See Also:
IntObjectMap.indexOf(int)
-
indexGet
public VType indexGet(int index)
Returns the value associated with an existing key.- Specified by:
indexGet
in interfaceIntObjectMap<VType>
- Parameters:
index
- The index of an existing key.- Returns:
- Returns the value currently associated with the key.
- See Also:
IntObjectMap.indexOf(int)
-
indexReplace
public VType indexReplace(int index, VType newValue)
Replaces the value associated with an existing key and returns any previous value stored for that key.- Specified by:
indexReplace
in interfaceIntObjectMap<VType>
- Parameters:
index
- The index of an existing key.- Returns:
- Returns the previous value associated with the key.
- See Also:
IntObjectMap.indexOf(int)
-
indexInsert
public void indexInsert(int index, int key, VType value)
Inserts a key-value pair for a key that is not present in the map. This method may help in avoiding double recalculation of the key's hash.- Specified by:
indexInsert
in interfaceIntObjectMap<VType>
- Parameters:
index
- The index of a previously non-existing key, as returned fromIntObjectMap.indexOf(int)
.- See Also:
IntObjectMap.indexOf(int)
-
clear
public void clear()
Clear all keys and values in the container.- Specified by:
clear
in interfaceIntObjectMap<VType>
- See Also:
IntObjectMap.release()
-
release
public void release()
Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simpleIntObjectMap.clear()
should be a better alternative since it'll avoid reallocation.- Specified by:
release
in interfaceIntObjectMap<VType>
- See Also:
IntObjectMap.clear()
-
size
public int size()
- Specified by:
size
in interfaceIntObjectAssociativeContainer<VType>
- Returns:
- Returns the current size (number of assigned keys) in the container.
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceIntObjectAssociativeContainer<VType>
- Returns:
- Return
true
if this hash map contains no assigned keys.
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfaceIntObjectMap<VType>
- Overrides:
hashCode
in classjava.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 aIntObjectMap
and both objects contains exactly the same key-value pairs.- Specified by:
equals
in interfaceIntObjectMap<VType>
- Overrides:
equals
in classjava.lang.Object
-
equalElements
protected boolean equalElements(IntObjectHashMap<?> other)
Return true if all keys of some other container exist in this container. Values are compared usingObject.equals(Object)
method.
-
ensureCapacity
public void ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of keys (entries) without resizing its buffers.- Specified by:
ensureCapacity
in interfacePreallocable
- Parameters:
expectedElements
- The total number of keys, inclusive.
-
iterator
public java.util.Iterator<IntObjectCursor<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 toIterator.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 interfaceIntObjectAssociativeContainer<VType>
- Specified by:
iterator
in interfacejava.lang.Iterable<VType>
-
forEach
public <T extends IntObjectProcedure<? super VType>> T forEach(T procedure)
Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass ofIntObjectProcedure
. 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 interfaceIntObjectAssociativeContainer<VType>
-
forEach
public <T extends IntObjectPredicate<? super VType>> T forEach(T predicate)
Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass ofIntObjectPredicate
. 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. The iteration is continued as long as the predicate returnstrue
.- Specified by:
forEach
in interfaceIntObjectAssociativeContainer<VType>
-
keys
public IntObjectHashMap.KeysContainer keys()
Returns a specialized view of the keys of this associated container. The view additionally implementsObjectLookupContainer
.- Specified by:
keys
in interfaceIntObjectAssociativeContainer<VType>
-
values
public ObjectCollection<VType> values()
Description copied from interface:IntObjectAssociativeContainer
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 interfaceIntObjectAssociativeContainer<VType>
- Returns:
- Returns a container with all values stored in this map.
-
clone
public IntObjectHashMap<VType> clone()
- Overrides:
clone
in classjava.lang.Object
-
toString
public java.lang.String toString()
Convert the contents of this map to a human-friendly string.- Overrides:
toString
in classjava.lang.Object
-
visualizeKeyDistribution
public java.lang.String visualizeKeyDistribution(int characters)
Description copied from interface:IntObjectMap
Visually depict the distribution of keys.- Specified by:
visualizeKeyDistribution
in interfaceIntObjectMap<VType>
- Parameters:
characters
- The number of characters to "squeeze" the entire buffer into.- Returns:
- Returns a sequence of characters where '.' depicts an empty fragment of the internal buffer and 'X' depicts full or nearly full capacity within the buffer's range and anything between 1 and 9 is between.
-
from
public static <VType> IntObjectHashMap<VType> from(int[] keys, VType[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.
-
hashKey
protected int hashKey(int key)
Returns a hash code for the given key.The default implementation mixes the hash of the key with
keyMixer
to differentiate hash order of keys between hash containers. Helps alleviate problems resulting from linear conflict resolution in open addressing.The output from this function should evenly distribute keys across the entire integer range.
-
verifyLoadFactor
protected double verifyLoadFactor(double loadFactor)
Validate load factor range and return it. Override and suppress if you need insane load factors.
-
rehash
protected void rehash(int[] fromKeys, VType[] fromValues)
Rehash from old buffers to new buffers.
-
allocateBuffers
protected void allocateBuffers(int arraySize)
Allocate new internal buffers. This method attempts to allocate and assign internal buffers atomically (either allocations succeed or not).
-
allocateThenInsertThenRehash
protected void allocateThenInsertThenRehash(int slot, int pendingKey, VType pendingValue)
This method is invoked when there is a new key/ value pair to be inserted into the buffers but there is not enough empty slots to do so. New buffers are allocated. If this succeeds, we know we can proceed with rehashing so we assign the pending element to the previous buffer (possibly violating the invariant of having at least one empty slot) and rehash all keys, substituting new buffers at the end.
-
shiftConflictingKeys
protected void shiftConflictingKeys(int gapSlot)
Shift all the slot-conflicting keys and values allocated to (and including)slot
.
-
-