Package it.unimi.dsi.fastutil.objects

Class Reference2FloatMaps.UnmodifiableMap<K>

java.lang.Object

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

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

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

All Implemented Interfaces:

Function<K,Float>, Reference2FloatFunction<K>, Reference2FloatMap<K>, Serializable, Function<K,Float>, ToDoubleFunction<K>, Map<K,Float>

Direct Known Subclasses:

Reference2FloatSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2FloatMaps

public static class Reference2FloatMaps.UnmodifiableMap<K>
extends Reference2FloatFunctions.UnmodifiableFunction<K>
implements Reference2FloatMap<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.Reference2FloatMap

Reference2FloatMap.Entry<K>, Reference2FloatMap.FastEntrySet<K>

Method Summary

Modifier and Type	Method	Description
Float	compute(K key, BiFunction<? super K,? super Float,? extends Float> remappingFunction)
float	computeFloat(K key, BiFunction<? super K,? super Float,? extends Float> remappingFunction)	Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
float	computeFloatIfAbsent(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.
float	computeFloatIfAbsentPartial(K key, Reference2FloatFunction<? 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.
float	computeFloatIfPresent(K key, BiFunction<? super K,? super Float,? extends Float> remappingFunction)	If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
Float	computeIfAbsent(K key, Function<? super K,? extends Float> mappingFunction)
Float	computeIfPresent(K key, BiFunction<? super K,? super Float,? extends Float> remappingFunction)
boolean	containsValue(float 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,Float>>	entrySet()	Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super Float> action)
float	getOrDefault(Object key, float defaultValue)	Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
Float	getOrDefault(Object key, Float defaultValue)	Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
ReferenceSet<K>	keySet()
Float	merge(K key, Float value, BiFunction<? super Float,? super Float,? extends Float> remappingFunction)	Deprecated. Please use the corresponding type-specific method instead.
float	mergeFloat(K key, float value, BiFunction<? super Float,? super Float,? extends Float> remappingFunction)	If the specified key is not already associated with a value, associates it with the given value.
void	putAll(Map<? extends K,? extends Float> m)
float	putIfAbsent(K key, float 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.
Float	putIfAbsent(K key, Float value)	Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Reference2FloatMap.Entry<K>>	reference2FloatEntrySet()	Returns a type-specific set view of the mappings contained in this map.
boolean	remove(Object key, float 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.
float	replace(K key, float value)	Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(K key, float oldValue, float newValue)	Replaces the entry for the specified key only if currently mapped to the specified value.
Float	replace(K key, Float value)	Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, Float oldValue, Float newValue)	Deprecated. Please use the corresponding type-specific method instead.
void	replaceAll(BiFunction<? super K,? super Float,? extends Float> function)
FloatCollection	values()

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

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getFloat, put, put, remove, removeFloat, 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.Reference2FloatFunction

applyAsDouble, getFloat, put, removeFloat

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

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

Method Detail

containsValue

public boolean containsValue(float v)

Description copied from interface: Reference2FloatMap

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

Specified by:

containsValue in interface Reference2FloatMap<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,Float>

Specified by:

containsValue in interface Reference2FloatMap<K>

putAll

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

Specified by:

putAll in interface Map<K,Float>

reference2FloatEntrySet

public ObjectSet<Reference2FloatMap.Entry<K>> reference2FloatEntrySet()

Description copied from interface: Reference2FloatMap

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:

reference2FloatEntrySet in interface Reference2FloatMap<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,Float>> 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,Float>

Specified by:

entrySet in interface Reference2FloatMap<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: Reference2FloatMap

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

Specified by:

keySet in interface Map<K,Float>

Specified by:

keySet in interface Reference2FloatMap<K>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public FloatCollection values()

Description copied from interface: Reference2FloatMap

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

Specified by:

values in interface Map<K,Float>

Specified by:

values in interface Reference2FloatMap<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,Float>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Float>

Overrides:

hashCode in class Reference2FloatFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Float>

Overrides:

equals in class Reference2FloatFunctions.UnmodifiableFunction<K>

getOrDefault

public float getOrDefault(Object key,
                          float defaultValue)

Description copied from interface: Reference2FloatMap

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 Reference2FloatMap<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 Float> action)

Specified by:

forEach in interface Map<K,Float>

replaceAll

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

Specified by:

replaceAll in interface Map<K,Float>

putIfAbsent

public float putIfAbsent(K key,
                         float value)

Description copied from interface: Reference2FloatMap

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 Reference2FloatMap<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,
                      float value)

Description copied from interface: Reference2FloatMap

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

Specified by:

remove in interface Reference2FloatMap<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 float replace(K key,
                     float value)

Description copied from interface: Reference2FloatMap

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

Specified by:

replace in interface Reference2FloatMap<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,
                       float oldValue,
                       float newValue)

Description copied from interface: Reference2FloatMap

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

Specified by:

replace in interface Reference2FloatMap<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)

computeFloatIfAbsent

public float computeFloatIfAbsent(K key,
                                  ToDoubleFunction<? super K> mappingFunction)

Description copied from interface: Reference2FloatMap

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:

computeFloatIfAbsent in interface Reference2FloatMap<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)

computeFloatIfAbsentPartial

public float computeFloatIfAbsentPartial(K key,
                                         Reference2FloatFunction<? super K> mappingFunction)

Description copied from interface: Reference2FloatMap

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:

computeFloatIfAbsentPartial in interface Reference2FloatMap<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)

computeFloatIfPresent

public float computeFloatIfPresent(K key,
                                   BiFunction<? super K,? super Float,? extends Float> remappingFunction)

Description copied from interface: Reference2FloatMap

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:

computeFloatIfPresent in interface Reference2FloatMap<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)

computeFloat

public float computeFloat(K key,
                          BiFunction<? super K,? super Float,? extends Float> remappingFunction)

Description copied from interface: Reference2FloatMap

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:

computeFloat in interface Reference2FloatMap<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)

mergeFloat

public float mergeFloat(K key,
                        float value,
                        BiFunction<? super Float,? super Float,? extends Float> remappingFunction)

Description copied from interface: Reference2FloatMap

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:

mergeFloat in interface Reference2FloatMap<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 Float getOrDefault(Object key,
                          Float 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,Float>

Specified by:

getOrDefault in interface Reference2FloatMap<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,Float>

Specified by:

remove in interface Reference2FloatMap<K>

replace

@Deprecated
public Float replace(K key,
                     Float 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,Float>

Specified by:

replace in interface Reference2FloatMap<K>

replace

@Deprecated
public boolean replace(K key,
                       Float oldValue,
                       Float 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,Float>

Specified by:

replace in interface Reference2FloatMap<K>

putIfAbsent

@Deprecated
public Float putIfAbsent(K key,
                         Float 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,Float>

Specified by:

putIfAbsent in interface Reference2FloatMap<K>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<K,Float>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<K,Float>

compute

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

Specified by:

compute in interface Map<K,Float>

merge

@Deprecated
public Float merge(K key,
                   Float value,
                   BiFunction<? super Float,? super Float,? extends Float> 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,Float>

Specified by:

merge in interface Reference2FloatMap<K>