Interface Reference2DoubleMap<K>
- All Superinterfaces:
it.unimi.dsi.fastutil.Function<K,,Double> Function<K,,Double> Map<K,,Double> it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<K>,ToDoubleFunction<K>
- All Known Subinterfaces:
Reference2DoubleSortedMap<K>
- All Known Implementing Classes:
AbstractReference2DoubleMap,AbstractReference2DoubleSortedMap,Reference2DoubleArrayMap,Reference2DoubleLinkedOpenHashMap,Reference2DoubleMaps.EmptyMap,Reference2DoubleMaps.Singleton,Reference2DoubleMaps.SynchronizedMap,Reference2DoubleMaps.UnmodifiableMap,Reference2DoubleOpenCustomHashMap,Reference2DoubleOpenHashMap,Reference2DoubleSortedMaps.EmptySortedMap,Reference2DoubleSortedMaps.Singleton,Reference2DoubleSortedMaps.SynchronizedSortedMap,Reference2DoubleSortedMaps.UnmodifiableSortedMap
Map; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.
Besides extending the corresponding type-specific function, this interface strengthens Map.entrySet(),
keySet() and values(). Moreover, a number of methods, such as size(), defaultReturnValue(), etc., are un-defaulted
as their function default do not make sense for a map.
Maps returning entry sets of type Reference2DoubleMap.FastEntrySet support also fast iteration.
This interface specifies reference equality semantics (members will be compared equal with
== instead of equals) for its keys or values (or both), which may result in breaks in contract
if attempted to be used with non reference-equality semantics based Maps. For example, a
aReferenceToIntMap.equals(aObjectToIntMap) may return different a different result then
aObjectToIntMap.equals(aReferenceToIntMap), in violation of equals's
contract requiring it being symmetric.
A submap or subset may or may not have an independent default return value (which however must be initialized to the default return value of the originator).
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceA type-specificMap.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.static interfaceAn entry set providing fast iteration. -
Method Summary
Modifier and TypeMethodDescriptiondefault voidclear()Removes all of the mappings from this map (optional operation).default doublecomputeDouble(K key, BiFunction<? super K, ? super Double, ? extends Double> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornullif there is no current mapping).default doublecomputeDoubleIfAbsent(K key, ToDoubleFunction<? super K> mappingFunction) Deprecated.default doublecomputeDoubleIfAbsentPartial(K key, it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<? super K> mappingFunction) Deprecated.Please usecomputeIfAbsent()instead.default doublecomputeDoubleIfPresent(K key, BiFunction<? super K, ? 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.default doublecomputeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<? 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.default doublecomputeIfAbsent(K key, ToDoubleFunction<? 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.booleancontainsKey(Object key) Returns true if this function contains a mapping for the specified key.booleancontainsValue(double value) Returnstrueif this map maps one or more keys to the specified value.default booleancontainsValue(Object value) Deprecated.Please use the corresponding type-specific method instead.doubleGets the default return value.voiddefaultReturnValue(double rv) Sets the default return value (optional operation).static <K> Reference2DoubleMap.Entry<K> entry(K key, double value) Returns an unmodifiable, type-specific entry.entrySet()Deprecated.Please use the corresponding type-specific method instead.default voidPerforms the given action for each entry in this map until all entries have been processed or the action throws an exception.default voidforEach(BiConsumer<? super K, ? super Double> action) Deprecated.Please use the corresponding type-specific method instead.default DoubleDeprecated.Please use the corresponding type-specific method instead.default doublegetOrDefault(Object key, double defaultValue) Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.default DoublegetOrDefault(Object key, Double defaultValue) Deprecated.Please use the corresponding type-specific method instead.it.unimi.dsi.fastutil.objects.ReferenceSet<K> keySet()default doublemerge(K key, double value, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.default Doublemerge(K key, Double value, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.default doublemergeDouble(K key, double value, it.unimi.dsi.fastutil.doubles.DoubleBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.default doublemergeDouble(K key, double value, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) Deprecated.Please usemerge()instead.default doublemergeDouble(K key, double value, DoubleBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.static <K> Reference2DoubleMap<K> ofEntries(Reference2DoubleMap.Entry<K>... entries) Returns an unmodifiable, type-specific map with the specified entries.default DoubleDeprecated.Please use the corresponding type-specific method instead.default doubleputIfAbsent(K key, double value) 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.default DoubleputIfAbsent(K key, Double value) Deprecated.Please use the corresponding type-specific method instead.it.unimi.dsi.fastutil.objects.ObjectSet<Reference2DoubleMap.Entry<K>> Returns a type-specific set view of the mappings contained in this map.default DoubleDeprecated.Please use the corresponding type-specific method instead.default booleanRemoves the entry for the specified key only if it is currently mapped to the specified value.default booleanDeprecated.Please use the corresponding type-specific method instead.default doubleReplaces the entry for the specified key only if it is currently mapped to some value.default booleanReplaces the entry for the specified key only if currently mapped to the specified value.default DoubleDeprecated.Please use the corresponding type-specific method instead.default booleanDeprecated.Please use the corresponding type-specific method instead.intsize()Returns the number of key/value mappings in this map.it.unimi.dsi.fastutil.doubles.DoubleCollectionvalues()Methods inherited from interface it.unimi.dsi.fastutil.Function
applyMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, putAll, replaceAllMethods inherited from interface it.unimi.dsi.fastutil.objects.Reference2DoubleFunction
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsDouble, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, getDouble, put, removeDouble
-
Method Details
-
size
int size()Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUEelements, returnsInteger.MAX_VALUE. -
clear
default void clear()Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. -
defaultReturnValue
void defaultReturnValue(double rv) Sets the default return value (optional operation). This value must be returned by type-specific versions ofget(),put()andremove()to denote that the map does not contain the specified key. It must be 0/falseby default.- Specified by:
defaultReturnValuein interfaceit.unimi.dsi.fastutil.objects.Reference2DoubleFunction<K>- Parameters:
rv- the new default return value.- See Also:
-
defaultReturnValue
double defaultReturnValue()Gets the default return value.- Specified by:
defaultReturnValuein interfaceit.unimi.dsi.fastutil.objects.Reference2DoubleFunction<K>- Returns:
- the current default return value.
-
reference2DoubleEntrySet
it.unimi.dsi.fastutil.objects.ObjectSet<Reference2DoubleMap.Entry<K>> reference2DoubleEntrySet()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 anObjectSetof type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
-
entrySet
Deprecated.Please use the corresponding type-specific method instead.Returns a set view of the mappings contained in this map. -
put
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
-
get
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
-
remove
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
-
keySet
it.unimi.dsi.fastutil.objects.ReferenceSet<K> keySet() -
values
it.unimi.dsi.fastutil.doubles.DoubleCollection values() -
containsKey
Returns true if this function contains a mapping for the specified key. -
containsValue
boolean containsValue(double value) Returnstrueif this map maps one or more keys to the specified value.- See Also:
-
containsValue
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsValuein interfaceMap<K,Double>
-
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.- See Also:
-
forEach
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
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.Reference2DoubleFunction<K>- Parameters:
key- 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. - Since:
- 8.0.0
- See Also:
-
getOrDefault
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
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.- Parameters:
key- key with which the specified value is to be associated.value- 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.
- Since:
- 8.0.0
- See Also:
-
remove
Removes the entry for the specified key only if it is currently mapped to the specified value.- Parameters:
key- key with which the specified value is associated.value- value expected to be associated with the specified key.- Returns:
trueif the value was removed.- Since:
- 8.0.0
- See Also:
-
replace
Replaces the entry for the specified key only if currently mapped to the specified value.- 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:
trueif the value was replaced.- Since:
- 8.0.0
- See Also:
-
replace
Replaces the entry for the specified key only if it is currently mapped to some value.- 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 the default return value if there was no mapping for the key.
- Since:
- 8.0.0
- 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.- 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.
- Since:
- 8.0.0
- See Also:
-
computeDoubleIfAbsent
@Deprecated default double computeDoubleIfAbsent(K key, ToDoubleFunction<? super K> mappingFunction) Deprecated.Please usecomputeIfAbsent()instead. -
computeIfAbsent
default double computeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<? 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.- 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.
- Since:
- 8.0.0
- See Also:
-
computeDoubleIfAbsentPartial
@Deprecated default double computeDoubleIfAbsentPartial(K key, it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<? super K> mappingFunction) Deprecated.Please usecomputeIfAbsent()instead. -
computeDoubleIfPresent
default double computeDoubleIfPresent(K key, BiFunction<? super K, ? 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.- Parameters:
key- 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.
- Since:
- 8.0.0
- See Also:
-
computeDouble
default double computeDouble(K key, BiFunction<? super K, ? super Double, ? extends Double> 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.- Parameters:
key- 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.
- Since:
- 8.0.0
- See Also:
-
merge
default double merge(K key, double value, 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.- Parameters:
key- key with which the resulting value is to be associated.value- 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.
- Since:
- 8.0.0
- See Also:
-
mergeDouble
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.- Parameters:
key- key with which the resulting value is to be associated.value- 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.
- Since:
- 8.5.0
- See Also:
-
mergeDouble
default double mergeDouble(K key, double value, it.unimi.dsi.fastutil.doubles.DoubleBinaryOperator 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.- Parameters:
key- key with which the resulting value is to be associated.value- 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.- Since:
- 8.5.1
- See Also:
-
mergeDouble
@Deprecated default double mergeDouble(K key, double value, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) Deprecated.Please usemerge()instead. -
putIfAbsent
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
putIfAbsentin interfaceMap<K,Double>
-
remove
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
replace
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
replace
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
merge
@Deprecated default Double merge(K key, Double value, BiFunction<? super Double, ? super Double, ? extends Double> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
ofEntries
Returns an unmodifiable, type-specific map with the specified entries. SeeMap.ofEntries(Map.Entry[]) -
entry
Returns an unmodifiable, type-specific entry. SeeMap.entry(Object, Object)
-
computeIfAbsent()instead.