Interface Float2DoubleFunction
-
- All Known Subinterfaces:
Float2DoubleMap,Float2DoubleSortedMap
- All Known Implementing Classes:
AbstractFloat2DoubleFunction,AbstractFloat2DoubleMap,AbstractFloat2DoubleSortedMap,Float2DoubleArrayMap,Float2DoubleAVLTreeMap,Float2DoubleFunctions.EmptyFunction,Float2DoubleFunctions.PrimitiveFunction,Float2DoubleFunctions.Singleton,Float2DoubleFunctions.SynchronizedFunction,Float2DoubleFunctions.UnmodifiableFunction,Float2DoubleLinkedOpenHashMap,Float2DoubleMaps.EmptyMap,Float2DoubleMaps.Singleton,Float2DoubleMaps.SynchronizedMap,Float2DoubleMaps.UnmodifiableMap,Float2DoubleOpenCustomHashMap,Float2DoubleOpenHashMap,Float2DoubleRBTreeMap,Float2DoubleSortedMaps.EmptySortedMap,Float2DoubleSortedMaps.Singleton,Float2DoubleSortedMaps.SynchronizedSortedMap,Float2DoubleSortedMaps.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 Float2DoubleFunction extends Function<Float,Double>, DoubleUnaryOperator
A type-specificFunction; provides some additional methods that use polymorphism to avoid (un)boxing.Type-specific versions of
get(),put()andremove()cannot rely onnullto 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 thedefaultReturnValue()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-specificcontainsKey(), 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()andremove()for maps with primitive-type keys or values returnnullto 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 notnull.- See Also:
Function
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Float2ByteFunctionandThenByte(Double2ByteFunction after)default Float2CharFunctionandThenChar(Double2CharFunction after)default Float2DoubleFunctionandThenDouble(Double2DoubleFunction after)default Float2FloatFunctionandThenFloat(Double2FloatFunction after)default Float2IntFunctionandThenInt(Double2IntFunction after)default Float2LongFunctionandThenLong(Double2LongFunction after)default <T> Float2ObjectFunction<T>andThenObject(Double2ObjectFunction<T> after)default <T> Float2ReferenceFunction<T>andThenReference(Double2ReferenceFunction<T> after)default Float2ShortFunctionandThenShort(Double2ShortFunction after)default doubleapplyAsDouble(double operand)Deprecated.Please use primitive types which don't have to be widened as keys.default Byte2DoubleFunctioncomposeByte(Byte2FloatFunction before)default Char2DoubleFunctioncomposeChar(Char2FloatFunction before)default Double2DoubleFunctioncomposeDouble(Double2FloatFunction before)default Float2DoubleFunctioncomposeFloat(Float2FloatFunction before)default Int2DoubleFunctioncomposeInt(Int2FloatFunction before)default Long2DoubleFunctioncomposeLong(Long2FloatFunction before)default <T> Object2DoubleFunction<T>composeObject(Object2FloatFunction<T> before)default <T> Reference2DoubleFunction<T>composeReference(Reference2FloatFunction<T> before)default Short2DoubleFunctioncomposeShort(Short2FloatFunction before)default booleancontainsKey(float key)Returns true if this function contains a mapping for the specified key.default booleancontainsKey(Object key)Deprecated.Please use the corresponding type-specific method instead.default doubledefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(double rv)Sets the default return value (optional operation).doubleget(float key)Returns the value to which the given key is mapped.default Doubleget(Object key)Deprecated.Please use the corresponding type-specific method instead.default doubleput(float key, double value)Adds a pair to the map (optional operation).default Doubleput(Float key, Double value)Deprecated.Please use the corresponding type-specific method instead.default doubleremove(float key)Removes the mapping with the given key (optional operation).default Doubleremove(Object key)Deprecated.Please use the corresponding type-specific method instead.-
Methods inherited from interface java.util.function.DoubleUnaryOperator
andThen, compose
-
-
-
-
Method Detail
-
applyAsDouble
@Deprecated default double applyAsDouble(double operand)
Deprecated.Please use primitive types which don't have to be widened as keys.In this default implementation, the key gets narrowed down to the actual key type, throwing an exception if the given key can't be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. Its use is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g.,
Int2IntFunctioninstead ofShort2IntFunction).- Specified by:
applyAsDoublein interfaceDoubleUnaryOperator- Throws:
IllegalArgumentException- If the given operand is not an element of the key domain.- Since:
- 8.0.0
-
put
default double put(float key, double value)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)
-
get
double get(float key)
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)
-
remove
default double remove(float key)
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 default Double put(Float key, Double value)
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<Float,Double>- 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 default Double get(Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.- Specified by:
getin interfaceFunction<Float,Double>- Parameters:
key- the key.- Returns:
- the corresponding value, or
nullif no value was present for the given key. - See Also:
Map.get(Object)
-
remove
@Deprecated default Double remove(Object key)
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<Float,Double>- Parameters:
key- the key.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.remove(Object)
-
containsKey
default boolean containsKey(float key)
Returns true if this function contains a mapping for the specified key.Note that for some kind of functions (e.g., hashes) this method will always return true. In particular, this default implementation always returns true.
- Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
Function.containsKey(Object)
-
containsKey
@Deprecated default boolean containsKey(Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns true if this function contains a mapping for the specified key.Note that for some kind of functions (e.g., hashes) this method will always return true. This default implementation, in particular, always return true.
- Specified by:
containsKeyin interfaceFunction<Float,Double>- Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default 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/false/nullby default.- Parameters:
rv- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
default double 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.
-
andThenByte
default Float2ByteFunction andThenByte(Double2ByteFunction after)
-
composeByte
default Byte2DoubleFunction composeByte(Byte2FloatFunction before)
-
andThenShort
default Float2ShortFunction andThenShort(Double2ShortFunction after)
-
composeShort
default Short2DoubleFunction composeShort(Short2FloatFunction before)
-
andThenInt
default Float2IntFunction andThenInt(Double2IntFunction after)
-
composeInt
default Int2DoubleFunction composeInt(Int2FloatFunction before)
-
andThenLong
default Float2LongFunction andThenLong(Double2LongFunction after)
-
composeLong
default Long2DoubleFunction composeLong(Long2FloatFunction before)
-
andThenChar
default Float2CharFunction andThenChar(Double2CharFunction after)
-
composeChar
default Char2DoubleFunction composeChar(Char2FloatFunction before)
-
andThenFloat
default Float2FloatFunction andThenFloat(Double2FloatFunction after)
-
composeFloat
default Float2DoubleFunction composeFloat(Float2FloatFunction before)
-
andThenDouble
default Float2DoubleFunction andThenDouble(Double2DoubleFunction after)
-
composeDouble
default Double2DoubleFunction composeDouble(Double2FloatFunction before)
-
andThenObject
default <T> Float2ObjectFunction<T> andThenObject(Double2ObjectFunction<T> after)
-
composeObject
default <T> Object2DoubleFunction<T> composeObject(Object2FloatFunction<T> before)
-
andThenReference
default <T> Float2ReferenceFunction<T> andThenReference(Double2ReferenceFunction<T> after)
-
composeReference
default <T> Reference2DoubleFunction<T> composeReference(Reference2FloatFunction<T> before)
-
-