Class Reference2ShortOpenCustomHashMap<K>
- All Implemented Interfaces:
it.unimi.dsi.fastutil.Function<K,,Short> it.unimi.dsi.fastutil.Hash,it.unimi.dsi.fastutil.objects.Reference2ShortFunction<K>,Reference2ShortMap<K>,Serializable,Cloneable,Function<K,,Short> ToIntFunction<K>,Map<K,Short>
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 Reference2ShortMap.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.objects.AbstractReference2ShortMap
AbstractReference2ShortMap.BasicEntry<K>, AbstractReference2ShortMap.BasicEntrySet<K>Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
it.unimi.dsi.fastutil.Hash.Strategy<K>Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Reference2ShortMap
Reference2ShortMap.Entry<K>, Reference2ShortMap.FastEntrySet<K> -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanWhether this map contains the key zero.protected Reference2ShortMap.FastEntrySet<K> Cached set of entries.protected final floatThe acceptable load factor.protected K[]The array of keys.protected it.unimi.dsi.fastutil.objects.ReferenceSet<K> Cached set of keys.protected intThe mask for wrapping a position counter.protected intThreshold after which we rehash.protected final intWe never resize below this threshold, which is the construction-time {#n}.protected intThe current table size.protected intNumber of entries in the set (including the key zero, if present).protected it.unimi.dsi.fastutil.Hash.Strategy<? super K> The hash strategy of this custom map.protected short[]The array of values.protected it.unimi.dsi.fastutil.shorts.ShortCollectionCached collection of values.Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2ShortFunction
defRetValueFields 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
ConstructorsConstructorDescriptionReference2ShortOpenCustomHashMap(int expected, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map.Reference2ShortOpenCustomHashMap(int expected, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas load factor.Reference2ShortOpenCustomHashMap(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZEentries andHash.DEFAULT_LOAD_FACTORas load factor.Reference2ShortOpenCustomHashMap(Reference2ShortMap<K> m, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map copying a given type-specific one.Reference2ShortOpenCustomHashMap(Reference2ShortMap<K> m, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas load factor copying a given type-specific one.Reference2ShortOpenCustomHashMap(Map<? extends K, ? extends Short> m, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map copying a given one.Reference2ShortOpenCustomHashMap(Map<? extends K, ? extends Short> m, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas load factor copying a given one.Reference2ShortOpenCustomHashMap(K[] k, short[] v, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map using the elements of two parallel arrays.Reference2ShortOpenCustomHashMap(K[] k, short[] v, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas load factor using the elements of two parallel arrays. -
Method Summary
Modifier and TypeMethodDescriptionshortAdds an increment to value currently associated with a key.voidclear()Removes all of the mappings from this map (optional operation).clone()Returns a deep copy of this map.shortcomputeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Reference2ShortFunction<? super K> 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.shortcomputeIfAbsent(K k, ToIntFunction<? super K> 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.shortcomputeShort(K k, BiFunction<? super K, ? super Short, ? extends Short> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornullif there is no current mapping).shortcomputeShortIfPresent(K k, BiFunction<? super K, ? super Short, ? extends Short> remappingFunction) If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.booleanReturns true if this function contains a mapping for the specified key.booleancontainsValue(short v) Returnstrueif this map maps one or more keys to the specified value.voidensureCapacity(int capacity) Ensures that this map can hold a certain number of keys without rehashing.voidPerforms the given action for each entry in this map until all entries have been processed or the action throws an exception.shortgetOrDefault(Object k, short defaultValue) Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.shortinthashCode()Returns a hash code for this map.booleanisEmpty()it.unimi.dsi.fastutil.objects.ReferenceSet<K> keySet()Returns a type-specific-set view of the keys of this map.shortIf the specified key is not already associated with a value, associates it with the givenvalue.shortmergeShort(K k, short v, it.unimi.dsi.fastutil.shorts.ShortBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.shortvoidshortputIfAbsent(K k, short 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.Returns a type-specific set view of the mappings contained in this map.protected voidrehash(int newN) Rehashes the map.booleanRemoves the entry for the specified key only if it is currently mapped to the specified value.shortshortReplaces the entry for the specified key only if it is currently mapped to some value.booleanReplaces the entry for the specified key only if currently mapped to the specified value.protected final voidshiftKeys(int pos) Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.intsize()Returns the number of key/value mappings in this map.it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy()Returns the hashing strategy.booleantrim()Rehashes the map, making the table as small as possible.booleantrim(int n) Rehashes this map if the table is too large.it.unimi.dsi.fastutil.shorts.ShortCollectionvalues()Returns a type-specific-set view of the values of this map.Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2ShortMap
equals, toStringMethods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2ShortFunction
defaultReturnValue, defaultReturnValueMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface it.unimi.dsi.fastutil.Function
applyMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, replaceAllMethods inherited from interface it.unimi.dsi.fastutil.objects.Reference2ShortFunction
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShortMethods inherited from interface it.unimi.dsi.fastutil.objects.Reference2ShortMap
computeShortIfAbsent, computeShortIfAbsentPartial, containsValue, defaultReturnValue, defaultReturnValue, entrySet, forEach, get, getOrDefault, merge, mergeShort, mergeShort, put, putIfAbsent, remove, remove, replace, replace
-
Field Details
-
key
The array of keys. -
value
protected transient short[] valueThe array of values. -
mask
protected transient int maskThe mask for wrapping a position counter. -
containsNullKey
protected transient boolean containsNullKeyWhether this map contains the key zero. -
strategy
The hash strategy of this custom map. -
n
protected transient int nThe current table size. -
maxFill
protected transient int maxFillThreshold after which we rehash. It must be the table size timesf. -
minN
protected final transient int minNWe never resize below this threshold, which is the construction-time {#n}. -
size
protected int sizeNumber of entries in the set (including the key zero, if present). -
f
protected final float fThe acceptable load factor. -
entries
Cached set of entries. -
keys
Cached set of keys. -
values
protected transient it.unimi.dsi.fastutil.shorts.ShortCollection valuesCached collection of values.
-
-
Constructor Details
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(int expected, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) 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.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(int expected, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
expected- the expected number of elements in the hash map.strategy- the strategy.
-
Reference2ShortOpenCustomHashMap
Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZEentries andHash.DEFAULT_LOAD_FACTORas load factor.- Parameters:
strategy- the strategy.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(Map<? extends K, ? extends Short> m, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map copying a given one.- Parameters:
m- aMapto be copied into the new hash map.f- the load factor.strategy- the strategy.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(Map<? extends K, ? extends Short> m, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas load factor copying a given one.- Parameters:
m- aMapto be copied into the new hash map.strategy- the strategy.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(Reference2ShortMap<K> m, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) 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.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(Reference2ShortMap<K> m, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas 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.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(K[] k, short[] v, float f, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) 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- ifkandvhave different lengths.
-
Reference2ShortOpenCustomHashMap
public Reference2ShortOpenCustomHashMap(K[] k, short[] v, it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy) Creates a new hash map withHash.DEFAULT_LOAD_FACTORas 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- ifkandvhave 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:AbstractReference2ShortMap -
put
- Specified by:
putin interfaceit.unimi.dsi.fastutil.objects.Reference2ShortFunction<K>
-
addTo
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.
-
shiftKeys
protected final void shiftKeys(int pos) Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.- Parameters:
pos- a starting position.
-
removeShort
- Specified by:
removeShortin interfaceit.unimi.dsi.fastutil.objects.Reference2ShortFunction<K>
-
getShort
- Specified by:
getShortin interfaceit.unimi.dsi.fastutil.objects.Reference2ShortFunction<K>
-
containsKey
Description copied from class:AbstractReference2ShortMapReturns true if this function contains a mapping for the specified key.- Specified by:
containsKeyin interfaceit.unimi.dsi.fastutil.Function<K,Short> - Specified by:
containsKeyin interfaceMap<K,Short> - Specified by:
containsKeyin interfaceReference2ShortMap<K>- Overrides:
containsKeyin classAbstractReference2ShortMap<K>- Parameters:
k- the key.- Returns:
- true if this function associates a value to
key. - See Also:
-
containsValue
public boolean containsValue(short v) Description copied from class:AbstractReference2ShortMapReturnstrueif this map maps one or more keys to the specified value.- Specified by:
containsValuein interfaceReference2ShortMap<K>- Overrides:
containsValuein classAbstractReference2ShortMap<K>- See Also:
-
getOrDefault
Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.- Specified by:
getOrDefaultin interfaceit.unimi.dsi.fastutil.objects.Reference2ShortFunction<K>- Specified by:
getOrDefaultin interfaceReference2ShortMap<K>- Parameters:
k- the key.defaultValue- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValueif this map contains no mapping for the key. - See Also:
-
putIfAbsent
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:
putIfAbsentin interfaceReference2ShortMap<K>- 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
Removes the entry for the specified key only if it is currently mapped to the specified value.- Specified by:
removein interfaceReference2ShortMap<K>- Parameters:
k- key with which the specified value is associated.v- value expected to be associated with the specified key.- Returns:
trueif the value was removed.- See Also:
-
replace
Replaces the entry for the specified key only if currently mapped to the specified value.- Specified by:
replacein interfaceReference2ShortMap<K>- 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:
trueif the value was replaced.- See Also:
-
replace
Replaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replacein interfaceReference2ShortMap<K>- 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
mappingFunctioncannot returnnull. If such a behavior is needed, please use the corresponding nullable version.- Specified by:
computeIfAbsentin interfaceReference2ShortMap<K>- 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
public short computeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Reference2ShortFunction<? super K> 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.This version of computeIfAbsent() uses a type-specific version of
fastutil'sFunction. SinceFunctionhas acontainsKey()method, it is possible to avoid adding a key by havingcontainsKey()returnfalsefor that key.- Specified by:
computeIfAbsentin interfaceReference2ShortMap<K>- 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:
-
computeShortIfPresent
public short computeShortIfPresent(K k, BiFunction<? super K, ? super Short, ? extends Short> 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:
computeShortIfPresentin interfaceReference2ShortMap<K>- 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:
-
computeShort
public short computeShort(K k, BiFunction<? super K, ? super Short, ? extends Short> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornullif 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:
computeShortin interfaceReference2ShortMap<K>- 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:
-
mergeShort
public short mergeShort(K k, short v, it.unimi.dsi.fastutil.shorts.ShortBinaryOperator 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.- Specified by:
mergeShortin interfaceReference2ShortMap<K>- 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.
- See Also:
-
merge
public short merge(K k, short v, BiFunction<? super Short, ? super Short, ? extends Short> 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:
mergein interfaceReference2ShortMap<K>- 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:Reference2ShortMapRemoves 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:Reference2ShortMapReturns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUEelements, returnsInteger.MAX_VALUE. -
isEmpty
public boolean isEmpty() -
forEach
Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.This default implementation just delegates to
forEachon the type-specific entry set, taking care of usingfastForEachif available.- Specified by:
forEachin interfaceReference2ShortMap<K>- See Also:
-
reference2ShortEntrySet
Description copied from interface:Reference2ShortMapReturns 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 anObjectSetof type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Specified by:
reference2ShortEntrySetin interfaceReference2ShortMap<K>- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
-
keySet
Description copied from class:AbstractReference2ShortMapReturns 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:
keySetin interfaceMap<K,Short> - Specified by:
keySetin interfaceReference2ShortMap<K>- Overrides:
keySetin classAbstractReference2ShortMap<K>- Returns:
- a set view of the keys of this map; it may be safely cast to a type-specific interface.
- See Also:
-
values
public it.unimi.dsi.fastutil.shorts.ShortCollection values()Description copied from class:AbstractReference2ShortMapReturns 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:
valuesin interfaceMap<K,Short> - Specified by:
valuesin interfaceReference2ShortMap<K>- Overrides:
valuesin classAbstractReference2ShortMap<K>- 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:
-
rehash
protected void rehash(int newN) Rehashes the map.This method implements the basic rehashing strategy, and may be overridden by subclasses implementing different rehashing strategies (e.g., disk-based rehashing). However, you should not override this method unless you understand the internal workings of this class.
- Parameters:
newN- the new size
-
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.
-
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.
-