Package org.agrona.collections
Class Int2ObjectHashMap<V>
- java.lang.Object
-
- org.agrona.collections.Int2ObjectHashMap<V>
-
- Type Parameters:
V
- type of values stored in theMap
- All Implemented Interfaces:
java.util.Map<java.lang.Integer,V>
- Direct Known Subclasses:
Int2NullableObjectHashMap
public class Int2ObjectHashMap<V> extends java.lang.Object implements java.util.Map<java.lang.Integer,V>
Map
implementation specialised for int keys using open addressing and linear probing for cache efficient access.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
Int2ObjectHashMap.AbstractIterator<T>
Base iterator implementation that contains basic logic of traversing the element in the backing array.class
Int2ObjectHashMap.EntryIterator
Iterator over entries which supports access to unboxed keys viaInt2ObjectHashMap.EntryIterator.getIntKey()
.class
Int2ObjectHashMap.EntrySet
Set of entries which supports access via an optionally cached iterator to avoid allocation.class
Int2ObjectHashMap.KeyIterator
Iterator over keys which supports access to unboxed keys viaInt2ObjectHashMap.KeyIterator.nextInt()
.class
Int2ObjectHashMap.KeySet
Set of keys which supports optionally cached iterators to avoid allocation.class
Int2ObjectHashMap.ValueCollection
Collection of values which supports optionally cached iterators to avoid allocation.class
Int2ObjectHashMap.ValueIterator
Iterator over values.
-
Field Summary
Fields Modifier and Type Field Description private Int2ObjectHashMap.EntrySet
entrySet
private int[]
keys
private Int2ObjectHashMap.KeySet
keySet
private float
loadFactor
(package private) static int
MIN_CAPACITY
private int
resizeThreshold
private boolean
shouldAvoidAllocation
private int
size
private Int2ObjectHashMap.ValueCollection
valueCollection
private java.lang.Object[]
values
-
Constructor Summary
Constructors Constructor Description Int2ObjectHashMap()
Constructs map withMIN_CAPACITY
,Hashing.DEFAULT_LOAD_FACTOR
and enables caching of iterators.Int2ObjectHashMap(int initialCapacity, float loadFactor)
Constructs map with given initial capacity and load factory and enables caching of iterators.Int2ObjectHashMap(int initialCapacity, float loadFactor, boolean shouldAvoidAllocation)
Construct a new map allowing a configuration for initial capacity and load factor.Int2ObjectHashMap(Int2ObjectHashMap<V> mapToCopy)
Copy construct a new map from an existing one.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
capacity()
Get the total capacity for the map to which the load factor will be a fraction of.void
clear()
void
compact()
Compact theMap
backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.private void
compactChain(int deleteIndex)
V
compute(int key, IntObjectToObjectFunction<? super V,? extends V> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).V
compute(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
V
computeIfAbsent(int key, java.util.function.IntFunction<? extends V> mappingFunction)
Get a value for a given key, or if it does not exist then default the value via aIntFunction
and put it in the map.V
computeIfAbsent(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,? extends V> mappingFunction)
V
computeIfPresent(int key, IntObjectToObjectFunction<? super V,? extends V> remappingFunction)
If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.V
computeIfPresent(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
boolean
containsKey(int key)
Overloaded version ofMap.containsKey(Object)
that takes a primitive int key.boolean
containsKey(java.lang.Object key)
boolean
containsValue(java.lang.Object value)
Int2ObjectHashMap.EntrySet
entrySet()
boolean
equals(java.lang.Object o)
void
forEach(java.util.function.BiConsumer<? super java.lang.Integer,? super V> action)
void
forEachInt(IntObjConsumer<V> consumer)
Primitive specialised implementation ofMap.forEach(BiConsumer)
.V
get(int key)
Overloaded version ofMap.get(Object)
that takes a primitive int key.V
get(java.lang.Object key)
protected V
getMapped(int key)
Get mapped value without boxing the key.V
getOrDefault(int key, V defaultValue)
Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.int
hashCode()
private void
increaseCapacity()
void
intForEach(IntObjConsumer<V> consumer)
Deprecated.UseforEachInt(IntObjConsumer)
instead.boolean
isEmpty()
Int2ObjectHashMap.KeySet
keySet()
float
loadFactor()
Get the load factor beyond which the map will increase size.protected java.lang.Object
mapNullValue(java.lang.Object value)
Interceptor for masking null values.V
merge(int key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
Primitive specialised version ofMap.merge(Object, Object, BiFunction)
.V
merge(java.lang.Integer key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
V
put(int key, V value)
Overloaded version ofMap.put(Object, Object)
that takes a primitive int key.V
put(java.lang.Integer key, V value)
void
putAll(java.util.Map<? extends java.lang.Integer,? extends V> map)
void
putAll(Int2ObjectHashMap<? extends V> map)
Put all values from the given map into this one without allocation.V
putIfAbsent(int key, V value)
Primitive specialised version ofMap.putIfAbsent(Object, Object)
.private void
rehash(int newCapacity)
V
remove(int key)
Overloaded version ofMap.remove(Object)
that takes a primitive int key.boolean
remove(int key, V value)
Primitive specialised version ofMap.remove(Object, Object)
.V
remove(java.lang.Object key)
boolean
remove(java.lang.Object key, java.lang.Object value)
V
replace(int key, V value)
Primitive specialised version ofMap.replace(Object, Object)
.boolean
replace(int key, V oldValue, V newValue)
Primitive specialised version ofMap.replace(Object, Object, Object)
.void
replaceAll(java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> function)
void
replaceAllInt(IntObjectToObjectFunction<? super V,? extends V> function)
Primitive specialised version ofMap.replaceAll(BiFunction)
.int
resizeThreshold()
Get the actual threshold which when reached the map will resize.int
size()
java.lang.String
toString()
protected V
unmapNullValue(java.lang.Object value)
Interceptor for unmasking null values.Int2ObjectHashMap.ValueCollection
values()
-
-
-
Field Detail
-
MIN_CAPACITY
static final int MIN_CAPACITY
- See Also:
- Constant Field Values
-
loadFactor
private final float loadFactor
-
resizeThreshold
private int resizeThreshold
-
size
private int size
-
shouldAvoidAllocation
private final boolean shouldAvoidAllocation
-
keys
private int[] keys
-
values
private java.lang.Object[] values
-
valueCollection
private Int2ObjectHashMap.ValueCollection valueCollection
-
keySet
private Int2ObjectHashMap.KeySet keySet
-
entrySet
private Int2ObjectHashMap.EntrySet entrySet
-
-
Constructor Detail
-
Int2ObjectHashMap
public Int2ObjectHashMap()
Constructs map withMIN_CAPACITY
,Hashing.DEFAULT_LOAD_FACTOR
and enables caching of iterators.
-
Int2ObjectHashMap
public Int2ObjectHashMap(int initialCapacity, float loadFactor)
Constructs map with given initial capacity and load factory and enables caching of iterators.- Parameters:
initialCapacity
- for the backing array.loadFactor
- limit for resizing on puts.
-
Int2ObjectHashMap
public Int2ObjectHashMap(int initialCapacity, float loadFactor, boolean shouldAvoidAllocation)
Construct a new map allowing a configuration for initial capacity and load factor.- Parameters:
initialCapacity
- for the backing array.loadFactor
- limit for resizing on puts.shouldAvoidAllocation
- should allocation be avoided by caching iterators and map entries.
-
Int2ObjectHashMap
public Int2ObjectHashMap(Int2ObjectHashMap<V> mapToCopy)
Copy construct a new map from an existing one.- Parameters:
mapToCopy
- for construction.
-
-
Method Detail
-
loadFactor
public float loadFactor()
Get the load factor beyond which the map will increase size.- Returns:
- load factor for when the map should increase size.
-
capacity
public int capacity()
Get the total capacity for the map to which the load factor will be a fraction of.- Returns:
- the total capacity for the map.
-
resizeThreshold
public int resizeThreshold()
Get the actual threshold which when reached the map will resize. This is a function of the current capacity and load factor.- Returns:
- the threshold when the map will resize.
-
size
public int size()
- Specified by:
size
in interfacejava.util.Map<java.lang.Integer,V>
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfacejava.util.Map<java.lang.Integer,V>
-
forEach
public void forEach(java.util.function.BiConsumer<? super java.lang.Integer,? super V> action)
- Specified by:
forEach
in interfacejava.util.Map<java.lang.Integer,V>
-
intForEach
@Deprecated public void intForEach(IntObjConsumer<V> consumer)
Deprecated.UseforEachInt(IntObjConsumer)
instead.UseforEachInt(IntObjConsumer)
instead.- Parameters:
consumer
- a callback called for each key/value pair in the map.- See Also:
forEachInt(IntObjConsumer)
-
forEachInt
public void forEachInt(IntObjConsumer<V> consumer)
Primitive specialised implementation ofMap.forEach(BiConsumer)
.NB: Renamed from forEach to avoid overloading on parameter types of lambda expression, which doesn't play well with type inference in lambda expressions.
- Parameters:
consumer
- a callback called for each key/value pair in the map.
-
containsKey
public boolean containsKey(java.lang.Object key)
- Specified by:
containsKey
in interfacejava.util.Map<java.lang.Integer,V>
-
containsKey
public boolean containsKey(int key)
Overloaded version ofMap.containsKey(Object)
that takes a primitive int key.- Parameters:
key
- for indexing theMap
.- Returns:
- true if the key is found otherwise false.
-
containsValue
public boolean containsValue(java.lang.Object value)
- Specified by:
containsValue
in interfacejava.util.Map<java.lang.Integer,V>
-
get
public V get(java.lang.Object key)
- Specified by:
get
in interfacejava.util.Map<java.lang.Integer,V>
-
get
public V get(int key)
Overloaded version ofMap.get(Object)
that takes a primitive int key.- Parameters:
key
- for indexing theMap
.- Returns:
- the value if found otherwise null.
-
getOrDefault
public V getOrDefault(int key, V defaultValue)
Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.- Parameters:
key
- whose associated value is to be returned.defaultValue
- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or
defaultValue
if this map contains no mapping for the key.
-
getMapped
protected V getMapped(int key)
Get mapped value without boxing the key.- Parameters:
key
- to get value by.- Returns:
- mapped value or
null
.
-
computeIfAbsent
public V computeIfAbsent(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,? extends V> mappingFunction)
- Specified by:
computeIfAbsent
in interfacejava.util.Map<java.lang.Integer,V>
-
computeIfAbsent
public V computeIfAbsent(int key, java.util.function.IntFunction<? extends V> mappingFunction)
Get a value for a given key, or if it does not exist then default the value via aIntFunction
and put it in the map.Primitive specialized version of
Map.computeIfAbsent(Object, Function)
.- Parameters:
key
- to search on.mappingFunction
- to provide a value if the get returns null.- Returns:
- the value if found otherwise the default.
-
computeIfPresent
public V computeIfPresent(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
- Specified by:
computeIfPresent
in interfacejava.util.Map<java.lang.Integer,V>
-
computeIfPresent
public V computeIfPresent(int key, IntObjectToObjectFunction<? super V,? extends V> remappingFunction)
If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.If the function returns
null
, the mapping is removed.Primitive specialized version of
Map.computeIfPresent(Object, BiFunction)
.- Parameters:
key
- to search on.remappingFunction
- to provide a value if the get returns missingValue.- Returns:
- the new value associated with the specified key, or
null
if none.
-
compute
public V compute(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
- Specified by:
compute
in interfacejava.util.Map<java.lang.Integer,V>
-
compute
public V compute(int key, IntObjectToObjectFunction<? super V,? extends V> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).If the function returns
null
, the mapping is removed (or remains absent if initially absent).Primitive specialized version of
Map.compute(Object, BiFunction)
.- Parameters:
key
- to search on.remappingFunction
- to provide a value if the get returns missingValue.- Returns:
- the new value associated with the specified key, or
null
if none.
-
merge
public V merge(java.lang.Integer key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
- Specified by:
merge
in interfacejava.util.Map<java.lang.Integer,V>
-
merge
public V merge(int key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
Primitive specialised version ofMap.merge(Object, Object, BiFunction)
.- Parameters:
key
- with which the resulting value is to be associated.value
- the non-null value to be merged with the existing value associated with the key or, if no existing value or a null value is associated with the key, to be associated with the key.remappingFunction
- the function to recompute a value if present.- Returns:
- the new value associated with the specified key, or null if no value is associated with the key.
-
put
public V put(java.lang.Integer key, V value)
- Specified by:
put
in interfacejava.util.Map<java.lang.Integer,V>
-
put
public V put(int key, V value)
Overloaded version ofMap.put(Object, Object)
that takes a primitive int key.- Parameters:
key
- for indexing theMap
.value
- to be inserted in theMap
.- Returns:
- the previous value if found otherwise null.
-
remove
public V remove(java.lang.Object key)
- Specified by:
remove
in interfacejava.util.Map<java.lang.Integer,V>
-
remove
public V remove(int key)
Overloaded version ofMap.remove(Object)
that takes a primitive int key.- Parameters:
key
- for indexing theMap
.- Returns:
- the value if found otherwise null.
-
remove
public boolean remove(java.lang.Object key, java.lang.Object value)
- Specified by:
remove
in interfacejava.util.Map<java.lang.Integer,V>
-
remove
public boolean remove(int key, V value)
Primitive specialised version ofMap.remove(Object, Object)
.- Parameters:
key
- with which the specified value is associated.value
- expected to be associated with the specified key.- Returns:
true
if the value was removed.
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Map<java.lang.Integer,V>
-
compact
public void compact()
Compact theMap
backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
-
putAll
public void putAll(java.util.Map<? extends java.lang.Integer,? extends V> map)
- Specified by:
putAll
in interfacejava.util.Map<java.lang.Integer,V>
-
putAll
public void putAll(Int2ObjectHashMap<? extends V> map)
Put all values from the given map into this one without allocation.- Parameters:
map
- whose value are to be added.
-
putIfAbsent
public V putIfAbsent(int key, V value)
Primitive specialised version ofMap.putIfAbsent(Object, Object)
.- Parameters:
key
- with which the specified value is to be associated.value
- to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or
null
if there was no mapping for the key.
-
keySet
public Int2ObjectHashMap.KeySet keySet()
- Specified by:
keySet
in interfacejava.util.Map<java.lang.Integer,V>
-
values
public Int2ObjectHashMap.ValueCollection values()
- Specified by:
values
in interfacejava.util.Map<java.lang.Integer,V>
-
entrySet
public Int2ObjectHashMap.EntrySet entrySet()
- Specified by:
entrySet
in interfacejava.util.Map<java.lang.Integer,V>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Specified by:
equals
in interfacejava.util.Map<java.lang.Integer,V>
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacejava.util.Map<java.lang.Integer,V>
- Overrides:
hashCode
in classjava.lang.Object
-
mapNullValue
protected java.lang.Object mapNullValue(java.lang.Object value)
Interceptor for masking null values.- Parameters:
value
- value to mask.- Returns:
- masked value.
-
unmapNullValue
protected V unmapNullValue(java.lang.Object value)
Interceptor for unmasking null values.- Parameters:
value
- value to unmask.- Returns:
- unmasked value.
-
replace
public V replace(int key, V value)
Primitive specialised version ofMap.replace(Object, Object)
.- Parameters:
key
- key with which the specified value is associated.value
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or
null
if there was no mapping for the key.
-
replace
public boolean replace(int key, V oldValue, V newValue)
Primitive specialised version ofMap.replace(Object, Object, Object)
.- Parameters:
key
- key with which the specified value is associated.oldValue
- value expected to be associated with the specified key.newValue
- value to be associated with the specified key.- Returns:
true
if the value was replaced.
-
replaceAll
public void replaceAll(java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> function)
- Specified by:
replaceAll
in interfacejava.util.Map<java.lang.Integer,V>
-
replaceAllInt
public void replaceAllInt(IntObjectToObjectFunction<? super V,? extends V> function)
Primitive specialised version ofMap.replaceAll(BiFunction)
.NB: Renamed from replaceAll to avoid overloading on parameter types of lambda expression, which doesn't play well with type inference in lambda expressions.
- Parameters:
function
- the function to apply to each entry.
-
increaseCapacity
private void increaseCapacity()
-
rehash
private void rehash(int newCapacity)
-
compactChain
private void compactChain(int deleteIndex)
-
-