Class Short2DoubleOpenCustomHashMap
- All Implemented Interfaces:
Function<Short,
,Double> Hash
,Short2DoubleFunction
,Short2DoubleMap
,Serializable
,Cloneable
,Function<Short,
,Double> IntToDoubleFunction
,Map<Short,
Double>
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 Short2DoubleMap.entrySet()
method implement the suitable
type-specific Pair
interface; only values are mutable.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleMap
AbstractShort2DoubleMap.BasicEntry, AbstractShort2DoubleMap.BasicEntrySet
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
Hash.Strategy<K>
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2DoubleMap
Short2DoubleMap.Entry, Short2DoubleMap.FastEntrySet
-
Field Summary
Fields inherited from interface it.unimi.dsi.fastutil.Hash
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
-
Constructor Summary
ConstructorDescriptionShort2DoubleOpenCustomHashMap
(int expected, float f, ShortHash.Strategy strategy) Creates a new hash map.Short2DoubleOpenCustomHashMap
(int expected, ShortHash.Strategy strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor.Short2DoubleOpenCustomHashMap
(short[] k, double[] v, float f, ShortHash.Strategy strategy) Creates a new hash map using the elements of two parallel arrays.Short2DoubleOpenCustomHashMap
(short[] k, double[] v, ShortHash.Strategy strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.Short2DoubleOpenCustomHashMap
(Short2DoubleMap m, float f, ShortHash.Strategy strategy) Creates a new hash map copying a given type-specific one.Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZE
entries andHash.DEFAULT_LOAD_FACTOR
as load factor.Short2DoubleOpenCustomHashMap
(Map<? extends Short, ? extends Double> m, float f, ShortHash.Strategy strategy) Creates a new hash map copying a given one.Short2DoubleOpenCustomHashMap
(Map<? extends Short, ? extends Double> m, ShortHash.Strategy strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given one. -
Method Summary
Modifier and TypeMethodDescriptiondouble
addTo
(short k, double incr) Adds an increment to value currently associated with a key.void
clear()
Removes all of the mappings from this map (optional operation).clone()
Returns a deep copy of this map.double
compute
(short k, BiFunction<? super Short, ? super Double, ? extends Double> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).double
computeIfAbsent
(short key, Short2DoubleFunction 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.double
computeIfAbsent
(short k, IntToDoubleFunction 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.double
computeIfAbsentNullable
(short k, IntFunction<? extends Double> 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 it isnull
.double
computeIfPresent
(short k, BiFunction<? super Short, ? super Double, ? extends Double> 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
(short k) Returns true if this function contains a mapping for the specified key.boolean
containsValue
(double v) Returnstrue
if this map maps one or more keys to the specified value.void
ensureCapacity
(int capacity) Ensures that this map can hold a certain number of keys without rehashing.double
get
(short k) Returns the value to which the given key is mapped.double
getOrDefault
(short k, double defaultValue) Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.int
hashCode()
Returns a hash code for this map.boolean
isEmpty()
keySet()
Returns a type-specific-set view of the keys of this map.double
merge
(short k, double v, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue
.double
put
(short k, double v) Adds a pair to the map (optional operation).void
double
putIfAbsent
(short k, double 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.double
remove
(short k) Removes the mapping with the given key (optional operation).boolean
remove
(short k, double v) Removes the entry for the specified key only if it is currently mapped to the specified value.double
replace
(short k, double v) Replaces the entry for the specified key only if it is currently mapped to some value.boolean
replace
(short k, double oldValue, double v) Replaces the entry for the specified key only if currently mapped to the specified value.Returns a type-specific set view of the mappings contained in this map.int
size()
Returns the number of key/value mappings in this map.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.values()
Returns a type-specific-set view of the values of this map.Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleMap
equals, mergeDouble, toString
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleFunction
defaultReturnValue, defaultReturnValue
Methods inherited from interface java.util.Map
replaceAll
Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2DoubleFunction
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsDouble, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort
Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2DoubleMap
compute, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, entrySet, forEach, get, getOrDefault, merge, mergeDouble, put, putIfAbsent, remove, remove, replace, replace
-
Constructor Details
-
Short2DoubleOpenCustomHashMap
Creates a new hash map.The actual table size will be the least power of two greater than
expected
/f
.- Parameters:
expected
- the expected number of elements in the hash map.f
- the load factor.strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
expected
- the expected number of elements in the hash map.strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZE
entries andHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
public Short2DoubleOpenCustomHashMap(Map<? extends Short, ? extends Double> m, float f, ShortHash.Strategy strategy) Creates a new hash map copying a given one.- Parameters:
m
- aMap
to be copied into the new hash map.f
- the load factor.strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
public Short2DoubleOpenCustomHashMap(Map<? extends Short, ? extends Double> m, ShortHash.Strategy strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.- Parameters:
m
- aMap
to be copied into the new hash map.strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
Creates a new hash map copying a given type-specific one.- Parameters:
m
- a type-specific map to be copied into the new hash map.f
- the load factor.strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.- Parameters:
m
- a type-specific map to be copied into the new hash map.strategy
- the strategy.
-
Short2DoubleOpenCustomHashMap
Creates a new hash map using the elements of two parallel arrays.- Parameters:
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.- Throws:
IllegalArgumentException
- ifk
andv
have different lengths.
-
Short2DoubleOpenCustomHashMap
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.- Parameters:
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.strategy
- the strategy.- Throws:
IllegalArgumentException
- ifk
andv
have different lengths.
-
-
Method Details
-
strategy
Returns the hashing strategy.- Returns:
- the hashing strategy of this custom hash map.
-
ensureCapacity
public void ensureCapacity(int capacity) Ensures that this map can hold a certain number of keys without rehashing.- Parameters:
capacity
- a number of keys; there will be no rehashing unless the map size exceeds this number.
-
putAll
Description copied from class:AbstractShort2DoubleMap
-
put
public double put(short k, double v) Description copied from interface:Short2DoubleFunction
Adds a pair to the map (optional operation).- Specified by:
put
in interfaceShort2DoubleFunction
- Parameters:
k
- the key.v
- the value.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
-
addTo
public double addTo(short k, double incr) Adds an increment to value currently associated with a key.Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.
- Parameters:
k
- the key.incr
- the increment.- Returns:
- the old value, or the default return value if no value was present for the given key.
-
remove
public double remove(short k) Description copied from interface:Short2DoubleFunction
Removes the mapping with the given key (optional operation).- Specified by:
remove
in interfaceShort2DoubleFunction
- Parameters:
k
- the key.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
-
get
public double get(short k) Description copied from interface:Short2DoubleFunction
Returns the value to which the given key is mapped.- Specified by:
get
in interfaceShort2DoubleFunction
- Parameters:
k
- the key.- Returns:
- the corresponding value, or the default return value if no value was present for the given key.
- See Also:
-
containsKey
public boolean containsKey(short k) Description copied from class:AbstractShort2DoubleMap
Returns true if this function contains a mapping for the specified key.- Specified by:
containsKey
in interfaceShort2DoubleFunction
- Specified by:
containsKey
in interfaceShort2DoubleMap
- Overrides:
containsKey
in classAbstractShort2DoubleMap
- Parameters:
k
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
-
containsValue
public boolean containsValue(double v) Description copied from class:AbstractShort2DoubleMap
Returnstrue
if this map maps one or more keys to the specified value.- Specified by:
containsValue
in interfaceShort2DoubleMap
- Overrides:
containsValue
in classAbstractShort2DoubleMap
- See Also:
-
getOrDefault
public double getOrDefault(short k, double defaultValue) Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.- Specified by:
getOrDefault
in interfaceShort2DoubleFunction
- Specified by:
getOrDefault
in interfaceShort2DoubleMap
- Parameters:
k
- the key.defaultValue
- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValue
if this map contains no mapping for the key. - See Also:
-
putIfAbsent
public double putIfAbsent(short k, double 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.- Specified by:
putIfAbsent
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is to be associated.v
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or the default return value if there was no mapping for the key.
- See Also:
-
remove
public boolean remove(short k, double v) Removes the entry for the specified key only if it is currently mapped to the specified value.- Specified by:
remove
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is associated.v
- value expected to be associated with the specified key.- Returns:
true
if the value was removed.- See Also:
-
replace
public boolean replace(short k, double oldValue, double v) Replaces the entry for the specified key only if currently mapped to the specified value.- Specified by:
replace
in interfaceShort2DoubleMap
- Parameters:
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.- Returns:
true
if the value was replaced.- See Also:
-
replace
public double replace(short k, double v) Replaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replace
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is associated.v
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or the default return value if there was no mapping for the key.
- See Also:
-
computeIfAbsent
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.Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the
mappingFunction
cannot returnnull
. If such a behavior is needed, please use the corresponding nullable version.- Specified by:
computeIfAbsent
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key.
- See Also:
-
computeIfAbsent
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.This version of computeIfAbsent() uses a type-specific version of
fastutil
'sFunction
. SinceFunction
has acontainsKey()
method, it is possible to avoid adding a key by havingcontainsKey()
returnfalse
for that key.- Specified by:
computeIfAbsent
in interfaceShort2DoubleMap
- Parameters:
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key.
- See Also:
-
computeIfAbsentNullable
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 it isnull
.Note that this version of computeIfAbsent() should be used only if you plan to return
null
in the mapping function.- Specified by:
computeIfAbsentNullable
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key, or the
default return value if the computed value is
null
. - See Also:
-
computeIfPresent
public double computeIfPresent(short k, BiFunction<? super Short, ? super Double, ? extends Double> remappingFunction) If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.- Specified by:
computeIfPresent
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.- Returns:
- the new value associated with the specified key, or the default return value if none.
- See Also:
-
compute
public double compute(short k, BiFunction<? super Short, ? super Double, ? extends Double> 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). If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.- Specified by:
compute
in interfaceShort2DoubleMap
- Parameters:
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.- Returns:
- the new value associated with the specified key, or the default return value if none.
- See Also:
-
merge
public double merge(short k, double v, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result isnull
.- Specified by:
merge
in interfaceShort2DoubleMap
- Parameters:
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.- Returns:
- the new value associated with the specified key, or the default return value if no value is associated with the key.
- See Also:
-
clear
public void clear()Description copied from interface:Short2DoubleMap
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. -
size
public int size()Description copied from interface:Short2DoubleMap
Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
. -
isEmpty
public boolean isEmpty() -
short2DoubleEntrySet
Description copied from interface:Short2DoubleMap
Returns a type-specific set view of the mappings contained in this map.This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen
Map.entrySet()
so that it returns anObjectSet
of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Specified by:
short2DoubleEntrySet
in interfaceShort2DoubleMap
- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
-
keySet
Description copied from class:AbstractShort2DoubleMap
Returns a type-specific-set view of the keys of this map.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.- Specified by:
keySet
in interfaceMap<Short,
Double> - Specified by:
keySet
in interfaceShort2DoubleMap
- Overrides:
keySet
in classAbstractShort2DoubleMap
- Returns:
- a set view of the keys of this map; it may be safely cast to a type-specific interface.
- See Also:
-
values
Description copied from class:AbstractShort2DoubleMap
Returns a type-specific-set view of the values of this map.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.- Specified by:
values
in interfaceMap<Short,
Double> - Specified by:
values
in interfaceShort2DoubleMap
- Overrides:
values
in classAbstractShort2DoubleMap
- Returns:
- a set view of the values of this map; it may be safely cast to a type-specific interface.
- See Also:
-
trim
public boolean trim()Rehashes the map, making the table as small as possible.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.
- Returns:
- true if there was enough memory to trim the map.
- See Also:
-
trim
public boolean trim(int n) Rehashes this map if the table is too large.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.
- Parameters:
n
- the threshold for the trimming.- Returns:
- true if there was enough memory to trim the map.
- See Also:
-
clone
Returns a deep copy of this map.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.
- Returns:
- a deep copy of this map.
-
hashCode
public int hashCode()Returns a hash code for this map. This method overrides the generic method provided by the superclass. Sinceequals()
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.
-