public class Int2ReferenceOpenCustomHashMap<V> extends AbstractInt2ReferenceMap<V> implements java.io.Serializable, java.lang.Cloneable, Hash
Instances of this class use a hash table to represent a map. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.
Note that clear()
does not modify the hash table size.
Rather, a family of trimming
methods lets you control the size of the table; this is particularly useful
if you reuse instances of this class.
Entries returned by the type-specific Int2ReferenceMap.entrySet()
method implement
the suitable type-specific Pair
interface;
only values are mutable.
Hash
,
HashCommon
,
Serialized FormAbstractInt2ReferenceMap.BasicEntry<V>, AbstractInt2ReferenceMap.BasicEntrySet<V>
Hash.Strategy<K>
Int2ReferenceMap.Entry<V>, Int2ReferenceMap.FastEntrySet<V>
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Int2ReferenceOpenCustomHashMap(int[] k,
V[] v,
float f,
IntHash.Strategy strategy)
Creates a new hash map using the elements of two parallel arrays.
|
Int2ReferenceOpenCustomHashMap(int[] k,
V[] v,
IntHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Int2ReferenceOpenCustomHashMap(Int2ReferenceMap<V> m,
float f,
IntHash.Strategy strategy)
Creates a new hash map copying a given type-specific one.
|
Int2ReferenceOpenCustomHashMap(Int2ReferenceMap<V> m,
IntHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Int2ReferenceOpenCustomHashMap(int expected,
float f,
IntHash.Strategy strategy)
Creates a new hash map.
|
Int2ReferenceOpenCustomHashMap(IntHash.Strategy strategy)
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Int2ReferenceOpenCustomHashMap(int expected,
IntHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Int2ReferenceOpenCustomHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m,
float f,
IntHash.Strategy strategy)
Creates a new hash map copying a given one.
|
Int2ReferenceOpenCustomHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m,
IntHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all of the mappings from this map (optional operation).
|
Int2ReferenceOpenCustomHashMap<V> |
clone()
Returns a deep copy of this map.
|
V |
compute(int k,
java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (or
null if there is no current mapping). |
V |
computeIfAbsent(int key,
Int2ReferenceFunction<? extends V> mappingFunction)
If the specified key is not already associated with a value, attempts to compute its value
using the given mapping function and enters it into this map, unless the key is not present
in the given mapping function.
|
V |
computeIfAbsent(int k,
java.util.function.IntFunction<? extends V> mappingFunction)
If the specified key is not already associated with a value, attempts to compute its value
using the given mapping function and enters it into this map.
|
V |
computeIfPresent(int k,
java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
|
boolean |
containsKey(int k)
Returns true if this function contains a mapping for the specified key.
|
boolean |
containsValue(java.lang.Object v) |
V |
get(int k)
Returns the value to which the given key is mapped.
|
V |
getOrDefault(int k,
V defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this
map contains no mapping for the key. |
int |
hashCode()
Returns a hash code for this map.
|
Int2ReferenceMap.FastEntrySet<V> |
int2ReferenceEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
boolean |
isEmpty() |
IntSet |
keySet()
Returns a type-specific-set view of the keys of this map.
|
V |
merge(int k,
V v,
java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
If the specified key is not already associated with a value, associates it with the given
value . |
V |
put(int k,
V v)
Adds a pair to the map (optional operation).
|
void |
putAll(java.util.Map<? extends java.lang.Integer,? extends V> m) |
V |
putIfAbsent(int k,
V v)
If the specified key is not already associated with a value, associates it with the given
value and returns the default return value, else returns
the current value.
|
V |
remove(int k)
Removes the mapping with the given key (optional operation).
|
boolean |
remove(int k,
java.lang.Object v)
Removes the entry for the specified key only if it is currently mapped to the specified value.
|
V |
replace(int k,
V v)
Replaces the entry for the specified key only if it is currently mapped to some value.
|
boolean |
replace(int k,
V oldValue,
V v)
Replaces the entry for the specified key only if currently mapped to the specified value.
|
int |
size()
Returns the number of key/value mappings in this map.
|
IntHash.Strategy |
strategy()
Returns the hashing strategy.
|
boolean |
trim()
Rehashes the map, making the table as small as possible.
|
boolean |
trim(int n)
Rehashes this map if the table is too large.
|
ReferenceCollection<V> |
values()
Returns a type-specific-set view of the values of this map.
|
equals, toString
defaultReturnValue, defaultReturnValue
computeIfAbsentPartial, containsKey, defaultReturnValue, defaultReturnValue, entrySet, forEach, get, getOrDefault, put, remove
andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort
public Int2ReferenceOpenCustomHashMap(int expected, float f, IntHash.Strategy strategy)
The actual table size will be the least power of two greater than expected
/f
.
expected
- the expected number of elements in the hash map.f
- the load factor.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(int expected, IntHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(IntHash.Strategy strategy)
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m, float f, IntHash.Strategy strategy)
m
- a Map
to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m, IntHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(Int2ReferenceMap<V> m, float f, IntHash.Strategy strategy)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(Int2ReferenceMap<V> m, IntHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.m
- a type-specific map to be copied into the new hash map.strategy
- the strategy.public Int2ReferenceOpenCustomHashMap(int[] k, V[] v, float f, IntHash.Strategy strategy)
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.f
- the load factor.strategy
- the strategy.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public Int2ReferenceOpenCustomHashMap(int[] k, V[] v, IntHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.strategy
- the strategy.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public IntHash.Strategy strategy()
public void putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
AbstractInt2ReferenceMap
putAll
in interface java.util.Map<java.lang.Integer,V>
putAll
in class AbstractInt2ReferenceMap<V>
public V put(int k, V v)
Int2ReferenceFunction
put
in interface Int2ReferenceFunction<V>
k
- the key.v
- the value.Function.put(Object,Object)
public V remove(int k)
Int2ReferenceFunction
remove
in interface Int2ReferenceFunction<V>
k
- the key.Function.remove(Object)
public V get(int k)
Int2ReferenceFunction
get
in interface Int2ReferenceFunction<V>
k
- the key.Function.get(Object)
public boolean containsKey(int k)
AbstractInt2ReferenceMap
containsKey
in interface Int2ReferenceFunction<V>
containsKey
in interface Int2ReferenceMap<V>
containsKey
in class AbstractInt2ReferenceMap<V>
k
- the key.key
.Map.containsKey(Object)
public boolean containsValue(java.lang.Object v)
AbstractInt2ReferenceMap
containsValue
in interface java.util.Map<java.lang.Integer,V>
containsValue
in class AbstractInt2ReferenceMap<V>
public V getOrDefault(int k, V defaultValue)
defaultValue
if this
map contains no mapping for the key.getOrDefault
in interface Int2ReferenceFunction<V>
getOrDefault
in interface Int2ReferenceMap<V>
k
- the key.defaultValue
- the default mapping of the key.defaultValue
if this map contains no mapping for the key.Map.getOrDefault(Object, Object)
public V putIfAbsent(int k, V v)
putIfAbsent
in interface Int2ReferenceMap<V>
k
- key with which the specified value is to be associated.v
- value to be associated with the specified key.Map.putIfAbsent(Object, Object)
public boolean remove(int k, java.lang.Object v)
remove
in interface Int2ReferenceMap<V>
k
- key with which the specified value is associated.v
- value expected to be associated with the specified key.true
if the value was removed.Map.remove(Object, Object)
public boolean replace(int k, V oldValue, V v)
replace
in interface Int2ReferenceMap<V>
k
- key with which the specified value is associated.oldValue
- value expected to be associated with the specified key.v
- value to be associated with the specified key.true
if the value was replaced.Map.replace(Object, Object, Object)
public V replace(int k, V v)
replace
in interface Int2ReferenceMap<V>
k
- key with which the specified value is associated.v
- value to be associated with the specified key.Map.replace(Object, Object)
public V computeIfAbsent(int k, java.util.function.IntFunction<? extends V> mappingFunction)
Note that contrarily to the default computeIfAbsent(),
it is not possible to not add a value for a given key, since the mappingFunction
cannot
return null
. If such a behavior is needed, please use the corresponding nullable version.
computeIfAbsent
in interface Int2ReferenceMap<V>
k
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)
public V computeIfAbsent(int key, Int2ReferenceFunction<? extends V> mappingFunction)
This version of computeIfAbsent()
uses a type-specific version of fastutil
's Function
.
Since Function
has a containsKey()
method, it is possible to avoid adding a key by having containsKey()
return false
for that key.
computeIfAbsent
in interface Int2ReferenceMap<V>
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)
public V computeIfPresent(int k, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
computeIfPresent
in interface Int2ReferenceMap<V>
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.Map.computeIfPresent(Object, java.util.function.BiFunction)
public V compute(int k, java.util.function.BiFunction<? super java.lang.Integer,? super V,? extends V> remappingFunction)
null
if there is no current mapping).
If the function returns null
, the mapping is removed (or remains absent if initially absent).
If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
compute
in interface Int2ReferenceMap<V>
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.Map.compute(Object, java.util.function.BiFunction)
public V merge(int k, V v, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
value
.
Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null
.merge
in interface Int2ReferenceMap<V>
k
- key with which the resulting value is to be associated.v
- the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.remappingFunction
- the function to recompute a value if present.Map.merge(Object, Object, java.util.function.BiFunction)
public void clear()
Int2ReferenceMap
clear
in interface Int2ReferenceMap<V>
clear
in interface java.util.Map<java.lang.Integer,V>
Map.clear()
public int size()
Int2ReferenceMap
Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE
.size
in interface Int2ReferenceMap<V>
size
in interface java.util.Map<java.lang.Integer,V>
Size64
public boolean isEmpty()
isEmpty
in interface java.util.Map<java.lang.Integer,V>
isEmpty
in class AbstractInt2ReferenceMap<V>
public Int2ReferenceMap.FastEntrySet<V> int2ReferenceEntrySet()
Int2ReferenceMap
This method is necessary because there is no inheritance along
type parameters: it is thus impossible to strengthen Map.entrySet()
so that it returns an ObjectSet
of type-specific entries (the latter makes it possible to
access keys and values with type-specific methods).
int2ReferenceEntrySet
in interface Int2ReferenceMap<V>
Map.entrySet()
public IntSet keySet()
AbstractInt2ReferenceMap
The view is backed by the set returned by Map.entrySet()
. Note that
no attempt is made at caching the result of this method, as this would
require adding some attributes that lightweight implementations would
not need. Subclasses may easily override this policy by calling
this method and caching the result, but implementors are encouraged to
write more efficient ad-hoc implementations.
keySet
in interface Int2ReferenceMap<V>
keySet
in interface java.util.Map<java.lang.Integer,V>
keySet
in class AbstractInt2ReferenceMap<V>
Map.keySet()
public ReferenceCollection<V> values()
AbstractInt2ReferenceMap
The view is backed by the set returned by Map.entrySet()
. Note that
no attempt is made at caching the result of this method, as this would
require adding some attributes that lightweight implementations would
not need. Subclasses may easily override this policy by calling
this method and caching the result, but implementors are encouraged to
write more efficient ad-hoc implementations.
values
in interface Int2ReferenceMap<V>
values
in interface java.util.Map<java.lang.Integer,V>
values
in class AbstractInt2ReferenceMap<V>
Map.values()
public boolean trim()
This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.
If the table size is already the minimum possible, this method does nothing.
trim(int)
public boolean trim(int n)
Let N be the smallest table size that can hold
max(n,
entries, still satisfying the load factor. If the current
table size is smaller than or equal to N, this method does
nothing. Otherwise, it rehashes this map in a table of size
N.
size()
)
This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.
n
- the threshold for the trimming.trim()
public Int2ReferenceOpenCustomHashMap<V> clone()
This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.
clone
in class java.lang.Object
public int hashCode()
equals()
is not overriden, it is important
that the value returned by this method is the same value as
the one returned by the overriden method.hashCode
in interface java.util.Map<java.lang.Integer,V>
hashCode
in class AbstractInt2ReferenceMap<V>