Interface Int2DoubleFunction
-
- All Superinterfaces:
Function<java.lang.Integer,java.lang.Double>
,java.util.function.Function<java.lang.Integer,java.lang.Double>
,java.util.function.IntToDoubleFunction
- All Known Subinterfaces:
Int2DoubleMap
,Int2DoubleSortedMap
- All Known Implementing Classes:
AbstractInt2DoubleFunction
,AbstractInt2DoubleMap
,AbstractInt2DoubleSortedMap
,Int2DoubleArrayMap
,Int2DoubleAVLTreeMap
,Int2DoubleFunctions.EmptyFunction
,Int2DoubleFunctions.PrimitiveFunction
,Int2DoubleFunctions.Singleton
,Int2DoubleFunctions.SynchronizedFunction
,Int2DoubleFunctions.UnmodifiableFunction
,Int2DoubleLinkedOpenHashMap
,Int2DoubleMaps.EmptyMap
,Int2DoubleMaps.Singleton
,Int2DoubleMaps.SynchronizedMap
,Int2DoubleMaps.UnmodifiableMap
,Int2DoubleOpenCustomHashMap
,Int2DoubleOpenHashMap
,Int2DoubleRBTreeMap
,Int2DoubleSortedMaps.EmptySortedMap
,Int2DoubleSortedMaps.Singleton
,Int2DoubleSortedMaps.SynchronizedSortedMap
,Int2DoubleSortedMaps.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 Int2DoubleFunction extends Function<java.lang.Integer,java.lang.Double>, java.util.function.IntToDoubleFunction
A type-specificFunction
; provides some additional methods that use polymorphism to avoid (un)boxing.Type-specific versions of
get()
,put()
andremove()
cannot rely onnull
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 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 returnnull
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 notnull
.- See Also:
Function
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Int2ByteFunction
andThen(Double2ByteFunction after)
default Int2CharFunction
andThen(Double2CharFunction after)
default Int2DoubleFunction
andThen(Double2DoubleFunction after)
default Int2FloatFunction
andThen(Double2FloatFunction after)
default Int2IntFunction
andThen(Double2IntFunction after)
default Int2LongFunction
andThen(Double2LongFunction after)
default <T> Int2ObjectFunction<T>
andThen(Double2ObjectFunction<T> after)
default <T> Int2ReferenceFunction<T>
andThen(Double2ReferenceFunction<T> after)
default Int2ShortFunction
andThen(Double2ShortFunction after)
default double
applyAsDouble(int operand)
default Byte2DoubleFunction
compose(Byte2IntFunction before)
default Char2DoubleFunction
compose(Char2IntFunction before)
default Double2DoubleFunction
compose(Double2IntFunction before)
default Float2DoubleFunction
compose(Float2IntFunction before)
default Int2DoubleFunction
compose(Int2IntFunction before)
default Long2DoubleFunction
compose(Long2IntFunction before)
default <T> Object2DoubleFunction<T>
compose(Object2IntFunction<T> before)
default <T> Reference2DoubleFunction<T>
compose(Reference2IntFunction<T> before)
default Short2DoubleFunction
compose(Short2IntFunction before)
default boolean
containsKey(int 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(int 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
put(int key, double value)
Adds a pair to the map (optional operation).default java.lang.Double
put(java.lang.Integer key, java.lang.Double value)
Deprecated.Please use the corresponding type-specific method instead.default double
remove(int 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.
-
-
-
Method Detail
-
applyAsDouble
default double applyAsDouble(int operand)
- Specified by:
applyAsDouble
in interfacejava.util.function.IntToDoubleFunction
- Since:
- 8.0.0
-
put
default double put(int 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(int 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(int 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.Integer 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.
-
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(int 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.Integer,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.
-
andThen
default Int2ByteFunction andThen(Double2ByteFunction after)
-
compose
default Byte2DoubleFunction compose(Byte2IntFunction before)
-
andThen
default Int2ShortFunction andThen(Double2ShortFunction after)
-
compose
default Short2DoubleFunction compose(Short2IntFunction before)
-
andThen
default Int2IntFunction andThen(Double2IntFunction after)
-
compose
default Int2DoubleFunction compose(Int2IntFunction before)
-
andThen
default Int2LongFunction andThen(Double2LongFunction after)
-
compose
default Long2DoubleFunction compose(Long2IntFunction before)
-
andThen
default Int2CharFunction andThen(Double2CharFunction after)
-
compose
default Char2DoubleFunction compose(Char2IntFunction before)
-
andThen
default Int2FloatFunction andThen(Double2FloatFunction after)
-
compose
default Float2DoubleFunction compose(Float2IntFunction before)
-
andThen
default Int2DoubleFunction andThen(Double2DoubleFunction after)
-
compose
default Double2DoubleFunction compose(Double2IntFunction before)
-
andThen
default <T> Int2ObjectFunction<T> andThen(Double2ObjectFunction<T> after)
-
compose
default <T> Object2DoubleFunction<T> compose(Object2IntFunction<T> before)
-
andThen
default <T> Int2ReferenceFunction<T> andThen(Double2ReferenceFunction<T> after)
-
compose
default <T> Reference2DoubleFunction<T> compose(Reference2IntFunction<T> before)
-
-