Package it.unimi.dsi.fastutil.objects

Class Reference2DoubleMaps.UnmodifiableMap<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractReference2DoubleFunction<K>

it.unimi.dsi.fastutil.objects.Reference2DoubleFunctions.UnmodifiableFunction<K>

it.unimi.dsi.fastutil.objects.Reference2DoubleMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,Double>, Reference2DoubleFunction<K>, Reference2DoubleMap<K>, Serializable, Function<K,Double>, ToDoubleFunction<K>, Map<K,Double>

Direct Known Subclasses:

Reference2DoubleSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2DoubleMaps

public static class Reference2DoubleMaps.UnmodifiableMap<K>
extends Reference2DoubleFunctions.UnmodifiableFunction<K>
implements Reference2DoubleMap<K>, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Reference2DoubleMap

Reference2DoubleMap.Entry<K>, Reference2DoubleMap.FastEntrySet<K>

Method Summary

Modifier and Type	Method	Description
Double	compute(K key, BiFunction<? super K,? super Double,? extends Double> remappingFunction)
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 (or null if there is no current mapping).
double	computeDoubleIfAbsent(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.
double	computeDoubleIfAbsentPartial(K key, 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.
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.
Double	computeIfAbsent(K key, Function<? super K,? extends Double> mappingFunction)
Double	computeIfPresent(K key, BiFunction<? super K,? super Double,? extends Double> remappingFunction)
boolean	containsValue(double v)	Returns true if this map maps one or more keys to the specified value.
boolean	containsValue(Object ov)	Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Map.Entry<K,Double>>	entrySet()	Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super Double> action)
double	getOrDefault(Object key, double defaultValue)	Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
Double	getOrDefault(Object key, Double defaultValue)	Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
ReferenceSet<K>	keySet()
Double	merge(K key, Double value, BiFunction<? super Double,? super Double,? extends Double> remappingFunction)	Deprecated. Please use the corresponding type-specific method instead.
double	mergeDouble(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 given value.
void	putAll(Map<? extends K,? extends Double> m)
double	putIfAbsent(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.
Double	putIfAbsent(K key, Double value)	Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Reference2DoubleMap.Entry<K>>	reference2DoubleEntrySet()	Returns a type-specific set view of the mappings contained in this map.
boolean	remove(Object key, double value)	Removes the entry for the specified key only if it is currently mapped to the specified value.
boolean	remove(Object key, Object value)	Deprecated. Please use the corresponding type-specific method instead.
double	replace(K key, double value)	Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(K key, double oldValue, double newValue)	Replaces the entry for the specified key only if currently mapped to the specified value.
Double	replace(K key, Double value)	Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, Double oldValue, Double newValue)	Deprecated. Please use the corresponding type-specific method instead.
void	replaceAll(BiFunction<? super K,? super Double,? extends Double> function)
DoubleCollection	values()

Methods inherited from class it.unimi.dsi.fastutil.objects.Reference2DoubleFunctions.UnmodifiableFunction

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getDouble, put, put, remove, removeDouble, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2DoubleFunction

andThen, andThen, andThen, andThen, andThen, andThen, andThen, andThen, andThen, applyAsDouble, compose, compose, compose, compose, compose, compose, compose, compose, compose, getDouble, put, removeDouble

Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2DoubleMap

clear, containsKey, defaultReturnValue, defaultReturnValue, get, put, remove, size

Method Details

containsValue

public boolean containsValue(double v)

Description copied from interface: Reference2DoubleMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Reference2DoubleMap<K>

See Also:

Map.containsValue(Object)

containsValue

@Deprecated
public boolean containsValue(Object ov)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

containsValue in interface Map<K,Double>

Specified by:

containsValue in interface Reference2DoubleMap<K>

putAll

public void putAll(Map<? extends K,? extends Double> m)

Specified by:

putAll in interface Map<K,Double>

reference2DoubleEntrySet

public ObjectSet<Reference2DoubleMap.Entry<K>> reference2DoubleEntrySet()

Description copied from interface: Reference2DoubleMap

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 an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

reference2DoubleEntrySet in interface Reference2DoubleMap<K>

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Map.entrySet()

entrySet

@Deprecated
public ObjectSet<Map.Entry<K,Double>> entrySet()

Deprecated.

Please use the corresponding type-specific method instead.

Returns a set view of the mappings contained in this map.

Note that this specification strengthens the one given in Map.entrySet().

Specified by:

entrySet in interface Map<K,Double>

Specified by:

entrySet in interface Reference2DoubleMap<K>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2DoubleMap

Note that this specification strengthens the one given in Map.keySet().

Specified by:

keySet in interface Map<K,Double>

Specified by:

keySet in interface Reference2DoubleMap<K>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public DoubleCollection values()

Description copied from interface: Reference2DoubleMap

Note that this specification strengthens the one given in Map.values().

Specified by:

values in interface Map<K,Double>

Specified by:

values in interface Reference2DoubleMap<K>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Double>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Double>

Overrides:

hashCode in class Reference2DoubleFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Double>

Overrides:

equals in class Reference2DoubleFunctions.UnmodifiableFunction<K>

getOrDefault

public double getOrDefault(Object key,
double defaultValue)

Description copied from interface: Reference2DoubleMap

Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.

Specified by:

getOrDefault in interface Reference2DoubleMap<K>

Parameters:

key - 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:

Map.getOrDefault(Object, Object)

forEach

public void forEach(BiConsumer<? super K,? super Double> action)

Specified by:

forEach in interface Map<K,Double>

replaceAll

public void replaceAll(BiFunction<? super K,? super Double,? extends Double> function)

Specified by:

replaceAll in interface Map<K,Double>

putIfAbsent

public double putIfAbsent(K key,
double value)

Description copied from interface: Reference2DoubleMap

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 interface Reference2DoubleMap<K>

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.

See Also:

Map.putIfAbsent(Object, Object)

remove

public boolean remove(Object key,
double value)

Description copied from interface: Reference2DoubleMap

Removes the entry for the specified key only if it is currently mapped to the specified value.

Specified by:

remove in interface Reference2DoubleMap<K>

Parameters:

key - key with which the specified value is associated.

value - value expected to be associated with the specified key.

Returns:

true if the value was removed.

See Also:

Map.remove(Object, Object)

replace

public double replace(K key,
double value)

Description copied from interface: Reference2DoubleMap

Replaces the entry for the specified key only if it is currently mapped to some value.

Specified by:

replace in interface Reference2DoubleMap<K>

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.

See Also:

Map.replace(Object, Object)

replace

public boolean replace(K key,
double oldValue,
double newValue)

Description copied from interface: Reference2DoubleMap

Replaces the entry for the specified key only if currently mapped to the specified value.

Specified by:

replace in interface Reference2DoubleMap<K>

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.

See Also:

Map.replace(Object, Object, Object)

computeDoubleIfAbsent

public double computeDoubleIfAbsent(K key,
ToDoubleFunction<? super K> mappingFunction)

Description copied from interface: Reference2DoubleMap

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 return null. If such a behavior is needed, please use the corresponding nullable version.

Specified by:

computeDoubleIfAbsent in interface Reference2DoubleMap<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:

Map.computeIfAbsent(Object, java.util.function.Function)

computeDoubleIfAbsentPartial

public double computeDoubleIfAbsentPartial(K key,
Reference2DoubleFunction<? super K> mappingFunction)

Description copied from interface: Reference2DoubleMap

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's Function. Since Function has a containsKey() method, it is possible to avoid adding a key by having containsKey() return false for that key.

Specified by:

computeDoubleIfAbsentPartial in interface Reference2DoubleMap<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:

Map.computeIfAbsent(Object, java.util.function.Function)

computeDoubleIfPresent

public double computeDoubleIfPresent(K key,
BiFunction<? super K,? super Double,? extends Double> remappingFunction)

Description copied from interface: Reference2DoubleMap

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:

computeDoubleIfPresent in interface Reference2DoubleMap<K>

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.

See Also:

Map.computeIfPresent(Object, java.util.function.BiFunction)

computeDouble

public double computeDouble(K key,
BiFunction<? super K,? super Double,? extends Double> remappingFunction)

Description copied from interface: Reference2DoubleMap

Attempts to compute a mapping for the specified key and its current mapped value (or 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.

Specified by:

computeDouble in interface Reference2DoubleMap<K>

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.

See Also:

Map.compute(Object, java.util.function.BiFunction)

mergeDouble

public double mergeDouble(K key,
double value,
BiFunction<? super Double,? super Double,? extends Double> remappingFunction)

Description copied from interface: Reference2DoubleMap

If the specified key is not already associated with a value, associates it with the given value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.

Specified by:

mergeDouble in interface Reference2DoubleMap<K>

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.

See Also:

Map.merge(Object, Object, java.util.function.BiFunction)

getOrDefault

@Deprecated
public Double getOrDefault(Object key,
Double defaultValue)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

getOrDefault in interface Map<K,Double>

Specified by:

getOrDefault in interface Reference2DoubleMap<K>

remove

@Deprecated
public boolean remove(Object key,
Object value)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

remove in interface Map<K,Double>

Specified by:

remove in interface Reference2DoubleMap<K>

replace

@Deprecated
public Double replace(K key,
Double value)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

replace in interface Map<K,Double>

Specified by:

replace in interface Reference2DoubleMap<K>

replace

@Deprecated
public boolean replace(K key,
Double oldValue,
Double newValue)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

replace in interface Map<K,Double>

Specified by:

replace in interface Reference2DoubleMap<K>

putIfAbsent

@Deprecated
public Double putIfAbsent(K key,
Double value)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

putIfAbsent in interface Map<K,Double>

Specified by:

putIfAbsent in interface Reference2DoubleMap<K>

computeIfAbsent

public Double computeIfAbsent(K key,
Function<? super K,? extends Double> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K,Double>

computeIfPresent

public Double computeIfPresent(K key,
BiFunction<? super K,? super Double,? extends Double> remappingFunction)

Specified by:

computeIfPresent in interface Map<K,Double>

compute

public Double compute(K key,
BiFunction<? super K,? super Double,? extends Double> remappingFunction)

Specified by:

compute in interface Map<K,Double>

merge

@Deprecated
public 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 Map method.

Specified by:

merge in interface Map<K,Double>

Specified by:

merge in interface Reference2DoubleMap<K>