Interface Object2FloatFunction<K>
- All Superinterfaces:
Function<K,Float>,Function<K,Float>,ToDoubleFunction<K>
- All Known Subinterfaces:
Object2FloatMap<K>,Object2FloatSortedMap<K>
- All Known Implementing Classes:
AbstractObject2FloatFunction,AbstractObject2FloatMap,AbstractObject2FloatSortedMap,Object2FloatArrayMap,Object2FloatAVLTreeMap,Object2FloatFunctions.EmptyFunction,Object2FloatFunctions.PrimitiveFunction,Object2FloatFunctions.Singleton,Object2FloatFunctions.SynchronizedFunction,Object2FloatFunctions.UnmodifiableFunction,Object2FloatLinkedOpenCustomHashMap,Object2FloatLinkedOpenHashMap,Object2FloatMaps.EmptyMap,Object2FloatMaps.Singleton,Object2FloatMaps.SynchronizedMap,Object2FloatMaps.UnmodifiableMap,Object2FloatOpenCustomHashMap,Object2FloatOpenHashMap,Object2FloatRBTreeMap,Object2FloatSortedMaps.EmptySortedMap,Object2FloatSortedMaps.Singleton,Object2FloatSortedMaps.SynchronizedSortedMap,Object2FloatSortedMaps.UnmodifiableSortedMap
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Object2FloatFunction<K> extends Function<K,Float>, ToDoubleFunction<K>
Function; provides some additional methods that use
polymorphism to avoid (un)boxing.
Type-specific versions of get(), put() and remove()
cannot rely on null to denote absence of a key. Rather, they return a
default return value, which is set to
0/false at creation, but can be changed using the
defaultReturnValue() method.
For uniformity reasons, even functions returning objects implement the
default return value (of course, in this case the default return value is
initialized to null).
The default implementation of optional operations just throw an
UnsupportedOperationException, except for the type-specific
containsKey(), which return true. Generic versions of accessors delegate to
the corresponding type-specific counterparts following the interface rules.
Warning: to fall in line as much as possible with the
standard map interface, it is required that
standard versions of get(), put() and remove() for
maps with primitive-type keys or values return null to denote
missing keys rather than wrap the default return value in an object. In
case both keys and values are reference types, the default return value must
be returned instead, thus violating the standard
map interface when the default return value is not null.
- See Also:
Function
-
Method Summary
Modifier and Type Method Description default <T> Function<K,T>andThen(Function<? super Float,? extends T> after)Deprecated.Please use the corresponding type-specific method instead.default Object2ByteFunction<K>andThenByte(Float2ByteFunction after)default Object2CharFunction<K>andThenChar(Float2CharFunction after)default Object2DoubleFunction<K>andThenDouble(Float2DoubleFunction after)default Object2FloatFunction<K>andThenFloat(Float2FloatFunction after)default Object2IntFunction<K>andThenInt(Float2IntFunction after)default Object2LongFunction<K>andThenLong(Float2LongFunction after)default <T> Object2ObjectFunction<K,T>andThenObject(Float2ObjectFunction<? extends T> after)default <T> Object2ReferenceFunction<K,T>andThenReference(Float2ReferenceFunction<? extends T> after)default Object2ShortFunction<K>andThenShort(Float2ShortFunction after)default doubleapplyAsDouble(K operand)default Byte2FloatFunctioncomposeByte(Byte2ObjectFunction<K> before)default Char2FloatFunctioncomposeChar(Char2ObjectFunction<K> before)default Double2FloatFunctioncomposeDouble(Double2ObjectFunction<K> before)default Float2FloatFunctioncomposeFloat(Float2ObjectFunction<K> before)default Int2FloatFunctioncomposeInt(Int2ObjectFunction<K> before)default Long2FloatFunctioncomposeLong(Long2ObjectFunction<K> before)default <T> Object2FloatFunction<T>composeObject(Object2ObjectFunction<? super T,? extends K> before)default <T> Reference2FloatFunction<T>composeReference(Reference2ObjectFunction<? super T,? extends K> before)default Short2FloatFunctioncomposeShort(Short2ObjectFunction<K> before)default floatdefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(float rv)Sets the default return value (optional operation).default Floatget(Object key)Deprecated.Please use the corresponding type-specific method instead.floatgetFloat(Object key)Returns the value to which the given key is mapped.default floatgetOrDefault(Object key, float defaultValue)Returns the value associated by this function to the specified key, or give the specified value if not present.default FloatgetOrDefault(Object key, Float defaultValue)Deprecated.Please use the corresponding type-specific method instead.default floatput(K key, float value)Adds a pair to the map (optional operation).default Floatput(K key, Float value)Deprecated.Please use the corresponding type-specific method instead.default Floatremove(Object key)Deprecated.Please use the corresponding type-specific method instead.default floatremoveFloat(Object key)Removes the mapping with the given key (optional operation).Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, containsKey, size
-
Method Details
-
applyAsDouble
- Specified by:
applyAsDoublein interfaceToDoubleFunction<K>- Since:
- 8.0.0
-
put
Adds a pair to the map (optional operation).- Parameters:
key- the key.value- the value.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
Function.put(Object,Object)
-
getFloat
Returns the value to which the given key is mapped.- Parameters:
key- the key.- Returns:
- the corresponding value, or the default return value if no value was present for the given key.
- See Also:
Function.get(Object)
-
getOrDefault
Returns the value associated by this function to the specified key, or give the specified value if not present.- Parameters:
key- the key.defaultValue- the value to return if not present.- Returns:
- the corresponding value, or
defaultValueif no value was present for the given key. - Since:
- 8.5.0
- See Also:
Function.getOrDefault(Object, Object)
-
removeFloat
Removes the mapping with the given key (optional operation).- Parameters:
key- the key.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
Function.remove(Object)
-
put
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).- Specified by:
putin interfaceFunction<K,Float>- Parameters:
key- the key.value- the value.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.- Specified by:
getin interfaceFunction<K,Float>- Parameters:
key- the key.- Returns:
- the corresponding value, or
nullif no value was present for the given key. - See Also:
Map.get(Object)
-
getOrDefault
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key, or give the specified value if not present.- Specified by:
getOrDefaultin interfaceFunction<K,Float>- Parameters:
key- the key.defaultValue- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValueif no value was present for the given key. - See Also:
Map.getOrDefault(Object, Object)
-
remove
Deprecated.Please use the corresponding type-specific method instead.Removes this key and the associated value from this function if it is present (optional operation).- Specified by:
removein interfaceFunction<K,Float>- Parameters:
key- the key.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.remove(Object)
-
defaultReturnValue
default void defaultReturnValue(float 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/false/nullby default.- Parameters:
rv- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
default float defaultReturnValue()Gets the default return value.This default implementation just return the default null value of the type (
nullfor objects, 0 for scalars, false for Booleans).- Returns:
- the current default return value.
-
andThen
Deprecated.Please use the corresponding type-specific method instead. -
andThenByte
-
composeByte
-
andThenShort
-
composeShort
-
andThenInt
-
composeInt
-
andThenLong
-
composeLong
-
andThenChar
-
composeChar
-
andThenFloat
-
composeFloat
-
andThenDouble
-
composeDouble
-
andThenObject
-
composeObject
default <T> Object2FloatFunction<T> composeObject(Object2ObjectFunction<? super T,? extends K> before) -
andThenReference
default <T> Object2ReferenceFunction<K,T> andThenReference(Float2ReferenceFunction<? extends T> after) -
composeReference
default <T> Reference2FloatFunction<T> composeReference(Reference2ObjectFunction<? super T,? extends K> before)
-