Interface Int2DoubleFunction
- 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.
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:
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Please use the corresponding type-specific method instead.default Int2ByteFunctionandThenByte(Double2ByteFunction after) default Int2CharFunctionandThenChar(Double2CharFunction after) default Int2DoubleFunctiondefault Int2FloatFunctionandThenFloat(Double2FloatFunction after) default Int2IntFunctionandThenInt(Double2IntFunction after) default Int2LongFunctionandThenLong(Double2LongFunction after) default <T> Int2ObjectFunction<T> andThenObject(Double2ObjectFunction<? extends T> after) default <T> Int2ReferenceFunction<T> andThenReference(Double2ReferenceFunction<? extends T> after) default Int2ShortFunctionandThenShort(Double2ShortFunction after) default doubleapplyAsDouble(int operand) Deprecated.Please use the corresponding type-specific method instead.default Byte2DoubleFunctioncomposeByte(Byte2IntFunction before) default Char2DoubleFunctioncomposeChar(Char2IntFunction before) default Double2DoubleFunctioncomposeDouble(Double2IntFunction before) default Float2DoubleFunctioncomposeFloat(Float2IntFunction before) default Int2DoubleFunctioncomposeInt(Int2IntFunction before) default Long2DoubleFunctioncomposeLong(Long2IntFunction before) default <T> Object2DoubleFunction<T> composeObject(Object2IntFunction<? super T> before) default <T> Reference2DoubleFunction<T> composeReference(Reference2IntFunction<? super T> before) default Short2DoubleFunctioncomposeShort(Short2IntFunction before) default booleancontainsKey(int 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 doubleGets the default return value.default voiddefaultReturnValue(double rv) Sets the default return value (optional operation).doubleget(int key) Returns the value to which the given key is mapped.default DoubleDeprecated.Please use the corresponding type-specific method instead.default doublegetOrDefault(int key, double defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.default DoublegetOrDefault(Object key, Double defaultValue) Deprecated.Please use the corresponding type-specific method instead.default doubleput(int key, double value) Adds a pair to the map (optional operation).default DoubleDeprecated.Please use the corresponding type-specific method instead.default doubleremove(int key) Removes the mapping with the given key (optional operation).default DoubleDeprecated.Please use the corresponding type-specific method instead.
-
Method Details
-
applyAsDouble
default double applyAsDouble(int operand) - Specified by:
applyAsDoublein interfaceIntToDoubleFunction- 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:
-
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:
-
getOrDefault
default double getOrDefault(int 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
defaultValueif no value was present for the given key. - Since:
- 8.5.0
- See Also:
-
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:
-
put
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation). -
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key. -
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<Integer,Double> - 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:
-
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). -
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:
-
containsKey
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<Integer,Double> - Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
-
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
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.
-
compose
Deprecated.Please use the corresponding type-specific method instead. -
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
-
andThenReference
-
composeReference
-