Interface Float2ShortFunction
- All Superinterfaces:
java.util.function.DoubleToIntFunction,it.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>,java.util.function.Function<java.lang.Float,java.lang.Short>
- All Known Subinterfaces:
Float2ShortMap,Float2ShortSortedMap
- All Known Implementing Classes:
AbstractFloat2ShortFunction,AbstractFloat2ShortMap,AbstractFloat2ShortSortedMap,Float2ShortArrayMap,Float2ShortAVLTreeMap,Float2ShortFunctions.EmptyFunction,Float2ShortFunctions.PrimitiveFunction,Float2ShortFunctions.Singleton,Float2ShortFunctions.SynchronizedFunction,Float2ShortFunctions.UnmodifiableFunction,Float2ShortLinkedOpenHashMap,Float2ShortMaps.EmptyMap,Float2ShortMaps.Singleton,Float2ShortMaps.SynchronizedMap,Float2ShortMaps.UnmodifiableMap,Float2ShortOpenCustomHashMap,Float2ShortOpenHashMap,Float2ShortRBTreeMap,Float2ShortSortedMaps.EmptySortedMap,Float2ShortSortedMaps.Singleton,Float2ShortSortedMaps.SynchronizedSortedMap,Float2ShortSortedMaps.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 Float2ShortFunction
extends it.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>, java.util.function.DoubleToIntFunction
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.Float,T>andThen(java.util.function.Function<? super java.lang.Short,? extends T> after)Deprecated.Please use the corresponding type-specific method instead.default it.unimi.dsi.fastutil.floats.Float2ByteFunctionandThenByte(it.unimi.dsi.fastutil.shorts.Short2ByteFunction after)default it.unimi.dsi.fastutil.floats.Float2CharFunctionandThenChar(it.unimi.dsi.fastutil.shorts.Short2CharFunction after)default it.unimi.dsi.fastutil.floats.Float2DoubleFunctionandThenDouble(it.unimi.dsi.fastutil.shorts.Short2DoubleFunction after)default Float2FloatFunctionandThenFloat(Short2FloatFunction after)default it.unimi.dsi.fastutil.floats.Float2IntFunctionandThenInt(it.unimi.dsi.fastutil.shorts.Short2IntFunction after)default it.unimi.dsi.fastutil.floats.Float2LongFunctionandThenLong(it.unimi.dsi.fastutil.shorts.Short2LongFunction after)default <T> it.unimi.dsi.fastutil.floats.Float2ObjectFunction<T>andThenObject(it.unimi.dsi.fastutil.shorts.Short2ObjectFunction<? extends T> after)default <T> it.unimi.dsi.fastutil.floats.Float2ReferenceFunction<T>andThenReference(it.unimi.dsi.fastutil.shorts.Short2ReferenceFunction<? extends T> after)default Float2ShortFunctionandThenShort(Short2ShortFunction after)default intapplyAsInt(double operand)Deprecated.Please use primitive types which do not have to be widened as keys.default <T> java.util.function.Function<T,java.lang.Short>compose(java.util.function.Function<? super T,? extends java.lang.Float> before)Deprecated.Please use the corresponding type-specific method instead.default it.unimi.dsi.fastutil.bytes.Byte2ShortFunctioncomposeByte(it.unimi.dsi.fastutil.bytes.Byte2FloatFunction before)default it.unimi.dsi.fastutil.chars.Char2ShortFunctioncomposeChar(it.unimi.dsi.fastutil.chars.Char2FloatFunction before)default it.unimi.dsi.fastutil.doubles.Double2ShortFunctioncomposeDouble(it.unimi.dsi.fastutil.doubles.Double2FloatFunction before)default Float2ShortFunctioncomposeFloat(Float2FloatFunction before)default it.unimi.dsi.fastutil.ints.Int2ShortFunctioncomposeInt(it.unimi.dsi.fastutil.ints.Int2FloatFunction before)default it.unimi.dsi.fastutil.longs.Long2ShortFunctioncomposeLong(it.unimi.dsi.fastutil.longs.Long2FloatFunction before)default <T> it.unimi.dsi.fastutil.objects.Object2ShortFunction<T>composeObject(it.unimi.dsi.fastutil.objects.Object2FloatFunction<? super T> before)default <T> it.unimi.dsi.fastutil.objects.Reference2ShortFunction<T>composeReference(it.unimi.dsi.fastutil.objects.Reference2FloatFunction<? super T> before)default Short2ShortFunctioncomposeShort(Short2FloatFunction before)default booleancontainsKey(float key)Returns true if this function contains a mapping for the specified key.default booleancontainsKey(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default shortdefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(short rv)Sets the default return value (optional operation).shortget(float key)Returns the value to which the given key is mapped.default java.lang.Shortget(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default shortgetOrDefault(float key, short defaultValue)Returns the value associated by this function to the specified key, or give the specified value if not present.default java.lang.ShortgetOrDefault(java.lang.Object key, java.lang.Short defaultValue)Deprecated.Please use the corresponding type-specific method instead.default shortput(float key, short value)Adds a pair to the map (optional operation).default java.lang.Shortput(java.lang.Float key, java.lang.Short value)Deprecated.Please use the corresponding type-specific method instead.default shortremove(float key)Removes the mapping with the given key (optional operation).default java.lang.Shortremove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, size
-
Method Details
-
applyAsInt
@Deprecated default int applyAsInt(double operand)Deprecated.Please use primitive types which do not have to be widened as keys.- Specified by:
applyAsIntin interfacejava.util.function.DoubleToIntFunction- Throws:
java.lang.IllegalArgumentException- If the given operand is not an element of the key domain.- Since:
- 8.0.0
- Implementation Specification:
- This default implementation delegates to the type-specific
get()method after narrowing down the key to the actual key type, throwing an exception if the given key cannot be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. The use of this method is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g.,Int2IntFunctioninstead ofShort2IntFunction).
-
put
default short put(float key, short 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
short 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)
-
getOrDefault
default short getOrDefault(float key, short 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:
Function.getOrDefault(Object, Object)
-
remove
default short 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 java.lang.Short put(java.lang.Float key, java.lang.Short value)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
putin interfaceit.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>
-
get
@Deprecated default java.lang.Short get(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
getin interfaceit.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>
-
getOrDefault
@Deprecated default java.lang.Short getOrDefault(java.lang.Object key, java.lang.Short defaultValue)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
getOrDefaultin interfaceit.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>
-
remove
@Deprecated default java.lang.Short remove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
removein interfaceit.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>
-
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(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsKeyin interfaceit.unimi.dsi.fastutil.Function<java.lang.Float,java.lang.Short>
-
defaultReturnValue
default void defaultReturnValue(short 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 short 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 default <T> java.util.function.Function<T,java.lang.Short> compose(java.util.function.Function<? super T,? extends java.lang.Float> before)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
composein interfacejava.util.function.Function<java.lang.Float,java.lang.Short>
-
andThen
@Deprecated default <T> java.util.function.Function<java.lang.Float,T> andThen(java.util.function.Function<? super java.lang.Short,? extends T> after)Deprecated.Please use the corresponding type-specific method instead.- Specified by:
andThenin interfacejava.util.function.Function<java.lang.Float,java.lang.Short>
-
andThenByte
default it.unimi.dsi.fastutil.floats.Float2ByteFunction andThenByte(it.unimi.dsi.fastutil.shorts.Short2ByteFunction after) -
composeByte
default it.unimi.dsi.fastutil.bytes.Byte2ShortFunction composeByte(it.unimi.dsi.fastutil.bytes.Byte2FloatFunction before) -
andThenShort
-
composeShort
-
andThenInt
default it.unimi.dsi.fastutil.floats.Float2IntFunction andThenInt(it.unimi.dsi.fastutil.shorts.Short2IntFunction after) -
composeInt
default it.unimi.dsi.fastutil.ints.Int2ShortFunction composeInt(it.unimi.dsi.fastutil.ints.Int2FloatFunction before) -
andThenLong
default it.unimi.dsi.fastutil.floats.Float2LongFunction andThenLong(it.unimi.dsi.fastutil.shorts.Short2LongFunction after) -
composeLong
default it.unimi.dsi.fastutil.longs.Long2ShortFunction composeLong(it.unimi.dsi.fastutil.longs.Long2FloatFunction before) -
andThenChar
default it.unimi.dsi.fastutil.floats.Float2CharFunction andThenChar(it.unimi.dsi.fastutil.shorts.Short2CharFunction after) -
composeChar
default it.unimi.dsi.fastutil.chars.Char2ShortFunction composeChar(it.unimi.dsi.fastutil.chars.Char2FloatFunction before) -
andThenFloat
-
composeFloat
-
andThenDouble
default it.unimi.dsi.fastutil.floats.Float2DoubleFunction andThenDouble(it.unimi.dsi.fastutil.shorts.Short2DoubleFunction after) -
composeDouble
default it.unimi.dsi.fastutil.doubles.Double2ShortFunction composeDouble(it.unimi.dsi.fastutil.doubles.Double2FloatFunction before) -
andThenObject
default <T> it.unimi.dsi.fastutil.floats.Float2ObjectFunction<T> andThenObject(it.unimi.dsi.fastutil.shorts.Short2ObjectFunction<? extends T> after) -
composeObject
default <T> it.unimi.dsi.fastutil.objects.Object2ShortFunction<T> composeObject(it.unimi.dsi.fastutil.objects.Object2FloatFunction<? super T> before) -
andThenReference
default <T> it.unimi.dsi.fastutil.floats.Float2ReferenceFunction<T> andThenReference(it.unimi.dsi.fastutil.shorts.Short2ReferenceFunction<? extends T> after) -
composeReference
default <T> it.unimi.dsi.fastutil.objects.Reference2ShortFunction<T> composeReference(it.unimi.dsi.fastutil.objects.Reference2FloatFunction<? super T> before)
-