Interface Double2DoubleFunction
- All Superinterfaces:
java.util.function.DoubleUnaryOperator
,Function<java.lang.Double,java.lang.Double>
,java.util.function.Function<java.lang.Double,java.lang.Double>
- All Known Subinterfaces:
Double2DoubleMap
,Double2DoubleSortedMap
- All Known Implementing Classes:
AbstractDouble2DoubleFunction
,AbstractDouble2DoubleMap
,AbstractDouble2DoubleSortedMap
,Double2DoubleArrayMap
,Double2DoubleAVLTreeMap
,Double2DoubleFunctions.EmptyFunction
,Double2DoubleFunctions.PrimitiveFunction
,Double2DoubleFunctions.Singleton
,Double2DoubleFunctions.SynchronizedFunction
,Double2DoubleFunctions.UnmodifiableFunction
,Double2DoubleLinkedOpenHashMap
,Double2DoubleMaps.EmptyMap
,Double2DoubleMaps.Singleton
,Double2DoubleMaps.SynchronizedMap
,Double2DoubleMaps.UnmodifiableMap
,Double2DoubleOpenCustomHashMap
,Double2DoubleOpenHashMap
,Double2DoubleRBTreeMap
,Double2DoubleSortedMaps.EmptySortedMap
,Double2DoubleSortedMaps.Singleton
,Double2DoubleSortedMaps.SynchronizedSortedMap
,Double2DoubleSortedMaps.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 Double2DoubleFunction extends Function<java.lang.Double,java.lang.Double>, java.util.function.DoubleUnaryOperator
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> java.util.function.Function<java.lang.Double,T>
andThen(java.util.function.Function<? super java.lang.Double,? extends T> after)
Deprecated.Please use the corresponding type-specific method instead.default Double2ByteFunction
andThenByte(Double2ByteFunction after)
default Double2CharFunction
andThenChar(Double2CharFunction after)
default Double2DoubleFunction
andThenDouble(Double2DoubleFunction after)
default Double2FloatFunction
andThenFloat(Double2FloatFunction after)
default Double2IntFunction
andThenInt(Double2IntFunction after)
default Double2LongFunction
andThenLong(Double2LongFunction after)
default <T> Double2ObjectFunction<T>
andThenObject(Double2ObjectFunction<? extends T> after)
default <T> Double2ReferenceFunction<T>
andThenReference(Double2ReferenceFunction<? extends T> after)
default Double2ShortFunction
andThenShort(Double2ShortFunction after)
default double
applyAsDouble(double operand)
default <T> java.util.function.Function<T,java.lang.Double>
compose(java.util.function.Function<? super T,? extends java.lang.Double> before)
Deprecated.Please use the corresponding type-specific method instead.default Byte2DoubleFunction
composeByte(Byte2DoubleFunction before)
default Char2DoubleFunction
composeChar(Char2DoubleFunction before)
default Double2DoubleFunction
composeDouble(Double2DoubleFunction before)
default Float2DoubleFunction
composeFloat(Float2DoubleFunction before)
default Int2DoubleFunction
composeInt(Int2DoubleFunction before)
default Long2DoubleFunction
composeLong(Long2DoubleFunction before)
default <T> Object2DoubleFunction<T>
composeObject(Object2DoubleFunction<? super T> before)
default <T> Reference2DoubleFunction<T>
composeReference(Reference2DoubleFunction<? super T> before)
default Short2DoubleFunction
composeShort(Short2DoubleFunction before)
default boolean
containsKey(double key)
Returns true if this function contains a mapping for the specified key.default boolean
containsKey(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default double
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(double rv)
Sets the default return value (optional operation).double
get(double key)
Returns the value to which the given key is mapped.default java.lang.Double
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default double
getOrDefault(double key, double defaultValue)
Returns the value associated by this function to the specified key, or give the specified value if not present.default java.lang.Double
getOrDefault(java.lang.Object key, java.lang.Double defaultValue)
Deprecated.Please use the corresponding type-specific method instead.static Double2DoubleFunction
identity()
default double
put(double key, double value)
Adds a pair to the map (optional operation).default java.lang.Double
put(java.lang.Double key, java.lang.Double value)
Deprecated.Please use the corresponding type-specific method instead.default double
remove(double key)
Removes the mapping with the given key (optional operation).default java.lang.Double
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Methods inherited from interface java.util.function.DoubleUnaryOperator
andThen, compose
-
Method Details
-
applyAsDouble
default double applyAsDouble(double operand)- Specified by:
applyAsDouble
in interfacejava.util.function.DoubleUnaryOperator
- Since:
- 8.0.0
-
put
default double put(double 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(double 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)
-
getOrDefault
default double getOrDefault(double key, double defaultValue)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
defaultValue
if no value was present for the given key. - Since:
- 8.5.0
- See Also:
Function.getOrDefault(Object, Object)
-
remove
default double remove(double 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 java.lang.Double put(java.lang.Double key, java.lang.Double value)Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation). -
get
@Deprecated default java.lang.Double get(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key. -
getOrDefault
@Deprecated default java.lang.Double getOrDefault(java.lang.Object key, java.lang.Double defaultValue)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:
getOrDefault
in interfaceFunction<java.lang.Double,java.lang.Double>
- Parameters:
key
- the key.defaultValue
- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValue
if no value was present for the given key. - See Also:
Map.getOrDefault(Object, Object)
-
remove
@Deprecated default java.lang.Double remove(java.lang.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). -
containsKey
default boolean containsKey(double 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(java.lang.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:
containsKey
in interfaceFunction<java.lang.Double,java.lang.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
/null
by 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 (
null
for objects, 0 for scalars, false for Booleans).- Returns:
- the current default return value.
-
identity
-
compose
@Deprecated default <T> java.util.function.Function<T,java.lang.Double> compose(java.util.function.Function<? super T,? extends java.lang.Double> before)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
compose
in interfacejava.util.function.Function<java.lang.Double,java.lang.Double>
-
andThen
@Deprecated default <T> java.util.function.Function<java.lang.Double,T> andThen(java.util.function.Function<? super java.lang.Double,? extends T> after)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
andThen
in interfacejava.util.function.Function<java.lang.Double,java.lang.Double>
-
andThenByte
-
composeByte
-
andThenShort
-
composeShort
-
andThenInt
-
composeInt
-
andThenLong
-
composeLong
-
andThenChar
-
composeChar
-
andThenFloat
-
composeFloat
-
andThenDouble
-
composeDouble
-
andThenObject
-
composeObject
-
andThenReference
default <T> Double2ReferenceFunction<T> andThenReference(Double2ReferenceFunction<? extends T> after) -
composeReference
default <T> Reference2DoubleFunction<T> composeReference(Reference2DoubleFunction<? super T> before)
-