Package com.carrotsearch.hppc
Class ByteLongHashMap
java.lang.Object
com.carrotsearch.hppc.ByteLongHashMap
- All Implemented Interfaces:
ByteLongAssociativeContainer
,ByteLongMap
,Preallocable
,Cloneable
,Iterable<ByteLongCursor>
- Direct Known Subclasses:
ByteLongScatterMap
@Generated(date="2024-05-16T08:18:11+0000",
value="KTypeVTypeHashMap.java")
public class ByteLongHashMap
extends Object
implements ByteLongMap, Preallocable, Cloneable
A hash map of
byte
to long
, implemented using open
addressing with linear probing for collision resolution.
Note: read about important differences between hash and scatter sets.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate final class
An iterator implementation foriterator()
.final class
A view of the keys inside this hash map.private final class
An iterator over the set of assigned keys.private final class
A view over the set of values of this map.private final class
An iterator over the set of assigned values. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
The number of stored keys (assigned key slots), excluding the special "empty" key, if any (usesize()
instead).protected boolean
Special treatment for the "empty slot" key marker.protected int
We perturb hash values with a container-unique seed to avoid problems with nearly-sorted-by-hash values on iterations.byte[]
The array holding keys.protected double
The load factor forkeys
.protected int
Mask for slot scans inkeys
.protected HashOrderMixingStrategy
Per-instance hash order mixing strategy.protected int
long[]
The array holding values. -
Constructor Summary
ConstructorsConstructorDescriptionNew instance with sane defaults.ByteLongHashMap
(int expectedElements) New instance with sane defaults.ByteLongHashMap
(int expectedElements, double loadFactor) New instance with sane defaults.ByteLongHashMap
(int expectedElements, double loadFactor, HashOrderMixingStrategy orderMixer) New instance with the provided defaults.ByteLongHashMap
(ByteLongAssociativeContainer container) Create a hash map from all key-value pairs of another container. -
Method Summary
Modifier and TypeMethodDescriptionlong
addTo
(byte key, long incrementValue) AddsincrementValue
to any existing value for the givenkey
or insertsincrementValue
ifkey
did not previously exist.protected void
allocateBuffers
(int arraySize) Allocate new internal buffers.protected void
allocateThenInsertThenRehash
(int slot, byte pendingKey, long 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.clone()
boolean
containsKey
(byte 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
(ByteLongHashMap other) Return true if all keys of some other container exist in this container.boolean
Compares the specified object with this set for equality.<T extends ByteLongProcedure>
TforEach
(T procedure) Applies a given procedure to all keys-value pairs in this container.static ByteLongHashMap
from
(byte[] keys, long[] values) Creates a hash map from two index-aligned arrays of key-value pairs.long
get
(byte key) long
getOrDefault
(byte key, long defaultValue) int
hashCode()
protected int
hashKey
(byte key) Returns a hash code for the given key.boolean
indexExists
(int index) long
indexGet
(int index) Returns the value associated with an existing key.void
indexInsert
(int index, byte key, long value) Inserts a key-value pair for a key that is not present in the map.int
indexOf
(byte 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).long
indexReplace
(int index, long newValue) Replaces the value associated with an existing key and returns any previous value stored for that key.boolean
isEmpty()
iterator()
Returns a cursor over the entries (key-value pairs) in this map.keys()
Returns a specialized view of the keys of this associated container.long
put
(byte key, long value) Place a given key and value in the container.int
putAll
(ByteLongAssociativeContainer container) Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.int
putAll
(Iterable<? extends ByteLongCursor> iterable) Puts all key/value pairs from a given iterable into this map.boolean
putIfAbsent
(byte key, long value) Trove-inspired API method.long
putOrAdd
(byte key, long putValue, long incrementValue) Ifkey
exists,putValue
is inserted into the map, otherwise any existing value is incremented byadditionValue
.protected void
rehash
(byte[] fromKeys, long[] fromValues) Rehash from old buffers to new buffers.void
release()
Removes all elements from the collection and additionally releases any internal buffers.long
remove
(byte key) Remove all values at the given key.int
removeAll
(ByteContainer other) Removes all keys (and associated values) present in a given container.int
removeAll
(ByteLongPredicate predicate) Removes all keys (and associated values) for which the predicate returnstrue
.int
removeAll
(BytePredicate 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()
toString()
Convert the contents of this map to a human-friendly string.values()
Returns a container view of all values present in this container.protected double
verifyLoadFactor
(double loadFactor) Validate load factor range and return it.visualizeKeyDistribution
(int characters) Visually depict the distribution of keys.Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
keys
public byte[] keysThe array holding keys. -
values
public long[] valuesThe array holding values. -
keyMixer
protected int keyMixerWe perturb hash values with a container-unique seed to avoid problems with nearly-sorted-by-hash values on iterations.- See Also:
-
assigned
protected int assignedThe number of stored keys (assigned key slots), excluding the special "empty" key, if any (usesize()
instead).- See Also:
-
mask
protected int maskMask for slot scans inkeys
. -
resizeAt
protected int resizeAt -
hasEmptyKey
protected boolean hasEmptyKeySpecial treatment for the "empty slot" key marker. -
loadFactor
protected double loadFactorThe load factor forkeys
. -
orderMixer
Per-instance hash order mixing strategy.- See Also:
-
-
Constructor Details
-
ByteLongHashMap
public ByteLongHashMap()New instance with sane defaults. -
ByteLongHashMap
public ByteLongHashMap(int expectedElements) New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
ByteLongHashMap
public ByteLongHashMap(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)
.
-
ByteLongHashMap
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.
-
ByteLongHashMap
Create a hash map from all key-value pairs of another container.
-
-
Method Details
-
put
public long put(byte key, long value) Place a given key and value in the container.- Specified by:
put
in interfaceByteLongMap
- Returns:
- The value previously stored under the given key in the map is returned.
-
putAll
Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.- Specified by:
putAll
in interfaceByteLongMap
- 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
Puts all key/value pairs from a given iterable into this map.- Specified by:
putAll
in interfaceByteLongMap
- 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(byte key, long 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.
-
putOrAdd
public long putOrAdd(byte key, long putValue, long incrementValue) Ifkey
exists,putValue
is inserted into the map, otherwise any existing value is incremented byadditionValue
.- Specified by:
putOrAdd
in interfaceByteLongMap
- Parameters:
key
- The key of the value to adjust.putValue
- The value to put ifkey
does not exist.incrementValue
- The value to add to the existing value ifkey
exists.- Returns:
- Returns the current value associated with
key
(after changes).
-
addTo
public long addTo(byte key, long incrementValue) AddsincrementValue
to any existing value for the givenkey
or insertsincrementValue
ifkey
did not previously exist.- Specified by:
addTo
in interfaceByteLongMap
- Parameters:
key
- The key of the value to adjust.incrementValue
- The value to put or add to the existing value ifkey
exists.- Returns:
- Returns the current value associated with
key
(after changes).
-
remove
public long remove(byte 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 interfaceByteLongMap
-
removeAll
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 interfaceByteLongAssociativeContainer
- Returns:
- Returns the number of elements actually removed as a result of this call.
-
removeAll
Removes all keys (and associated values) for which the predicate returnstrue
.- Specified by:
removeAll
in interfaceByteLongAssociativeContainer
- Returns:
- Returns the number of elements actually removed as a result of this call.
-
removeAll
Removes all keys (and associated values) for which the predicate returnstrue
.- Specified by:
removeAll
in interfaceByteLongAssociativeContainer
- Returns:
- Returns the number of elements actually removed as a result of this call.
-
get
public long get(byte key) - Specified by:
get
in interfaceByteLongMap
- 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 long getOrDefault(byte key, long defaultValue) - Specified by:
getOrDefault
in interfaceByteLongMap
- 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(byte key) Returnstrue
if this container has an association to a value for the given key.- Specified by:
containsKey
in interfaceByteLongAssociativeContainer
-
indexOf
public int indexOf(byte 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 interfaceByteLongMap
- 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:
-
indexExists
public boolean indexExists(int index) - Specified by:
indexExists
in interfaceByteLongMap
- Parameters:
index
- The index of a given key, as returned fromByteLongMap.indexOf(byte)
.- 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:
-
indexGet
public long indexGet(int index) Returns the value associated with an existing key.- Specified by:
indexGet
in interfaceByteLongMap
- Parameters:
index
- The index of an existing key.- Returns:
- Returns the value currently associated with the key.
- See Also:
-
indexReplace
public long indexReplace(int index, long newValue) Replaces the value associated with an existing key and returns any previous value stored for that key.- Specified by:
indexReplace
in interfaceByteLongMap
- Parameters:
index
- The index of an existing key.- Returns:
- Returns the previous value associated with the key.
- See Also:
-
indexInsert
public void indexInsert(int index, byte key, long 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 interfaceByteLongMap
- Parameters:
index
- The index of a previously non-existing key, as returned fromByteLongMap.indexOf(byte)
.- See Also:
-
clear
public void clear()Clear all keys and values in the container.- Specified by:
clear
in interfaceByteLongMap
- See Also:
-
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 simpleByteLongMap.clear()
should be a better alternative since it'll avoid reallocation.- Specified by:
release
in interfaceByteLongMap
- See Also:
-
size
public int size()- Specified by:
size
in interfaceByteLongAssociativeContainer
- Returns:
- Returns the current size (number of assigned keys) in the container.
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceByteLongAssociativeContainer
- Returns:
- Return
true
if this hash map contains no assigned keys.
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfaceByteLongMap
- Overrides:
hashCode
in classObject
- 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
Compares the specified object with this set for equality. Returns true if and only if the specified object is also aByteLongMap
and both objects contains exactly the same key-value pairs.- Specified by:
equals
in interfaceByteLongMap
- Overrides:
equals
in classObject
-
equalElements
Return true if all keys of some other container exist in this container. -
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
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 interfaceByteLongAssociativeContainer
- Specified by:
iterator
in interfaceIterable<ByteLongCursor>
-
forEach
Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass ofByteLongProcedure
. 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 interfaceByteLongAssociativeContainer
-
forEach
Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass ofByteLongPredicate
. 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 interfaceByteLongAssociativeContainer
-
keys
Returns a specialized view of the keys of this associated container. The view additionally implementsObjectLookupContainer
.- Specified by:
keys
in interfaceByteLongAssociativeContainer
-
values
Description copied from interface:ByteLongAssociativeContainer
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 interfaceByteLongAssociativeContainer
- Returns:
- Returns a container with all values stored in this map.
-
clone
-
toString
Convert the contents of this map to a human-friendly string. -
visualizeKeyDistribution
Description copied from interface:ByteLongMap
Visually depict the distribution of keys.- Specified by:
visualizeKeyDistribution
in interfaceByteLongMap
- 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
Creates a hash map from two index-aligned arrays of key-value pairs. -
hashKey
protected int hashKey(byte 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(byte[] fromKeys, long[] 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, byte pendingKey, long 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
.
-