All Superinterfaces:

Function<Short,Integer>, Function<Short,Integer>, IntUnaryOperator

All Known Subinterfaces:

Short2IntMap, Short2IntSortedMap

All Known Implementing Classes:

AbstractShort2IntFunction, AbstractShort2IntMap, AbstractShort2IntSortedMap, Short2IntArrayMap, Short2IntAVLTreeMap, Short2IntFunctions.EmptyFunction, Short2IntFunctions.PrimitiveFunction, Short2IntFunctions.Singleton, Short2IntFunctions.SynchronizedFunction, Short2IntFunctions.UnmodifiableFunction, Short2IntLinkedOpenHashMap, Short2IntMaps.EmptyMap, Short2IntMaps.Singleton, Short2IntMaps.SynchronizedMap, Short2IntMaps.UnmodifiableMap, Short2IntOpenCustomHashMap, Short2IntOpenHashMap, Short2IntRBTreeMap, Short2IntSortedMaps.EmptySortedMap, Short2IntSortedMaps.Singleton, Short2IntSortedMaps.SynchronizedSortedMap, Short2IntSortedMaps.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 Short2IntFunction
extends Function<Short,Integer>, IntUnaryOperator
```
A type-specific 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

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default Short2ByteFunction`	`andThenByte(Int2ByteFunction after)`
`default Short2CharFunction`	`andThenChar(Int2CharFunction after)`
`default Short2DoubleFunction`	`andThenDouble(Int2DoubleFunction after)`
`default Short2FloatFunction`	`andThenFloat(Int2FloatFunction after)`
`default Short2IntFunction`	`andThenInt(Int2IntFunction after)`
`default Short2LongFunction`	`andThenLong(Int2LongFunction after)`
`default <T> Short2ObjectFunction<T>`	`andThenObject(Int2ObjectFunction<T> after)`
`default <T> Short2ReferenceFunction<T>`	`andThenReference(Int2ReferenceFunction<T> after)`
`default Short2ShortFunction`	`andThenShort(Int2ShortFunction after)`
`default int`	`applyAsInt(int operand)`	Deprecated. Please use primitive types which don't have to be widened as keys.
`default Byte2IntFunction`	`composeByte(Byte2ShortFunction before)`
`default Char2IntFunction`	`composeChar(Char2ShortFunction before)`
`default Double2IntFunction`	`composeDouble(Double2ShortFunction before)`
`default Float2IntFunction`	`composeFloat(Float2ShortFunction before)`
`default Int2IntFunction`	`composeInt(Int2ShortFunction before)`
`default Long2IntFunction`	`composeLong(Long2ShortFunction before)`
`default <T> Object2IntFunction<T>`	`composeObject(Object2ShortFunction<T> before)`
`default <T> Reference2IntFunction<T>`	`composeReference(Reference2ShortFunction<T> before)`
`default Short2IntFunction`	`composeShort(Short2ShortFunction before)`
`default boolean`	`containsKey(short key)`	Returns true if this function contains a mapping for the specified key.
`default boolean`	`containsKey(Object key)`	Deprecated. Please use the corresponding type-specific method instead.
`default int`	`defaultReturnValue()`	Gets the default return value.
`default void`	`defaultReturnValue(int rv)`	Sets the default return value (optional operation).
`int`	`get(short key)`	Returns the value to which the given key is mapped.
`default Integer`	`get(Object key)`	Deprecated. Please use the corresponding type-specific method instead.
`default int`	`put(short key, int value)`	Adds a pair to the map (optional operation).
`default Integer`	`put(Short key, Integer value)`	Deprecated. Please use the corresponding type-specific method instead.
`default int`	`remove(short key)`	Removes the mapping with the given key (optional operation).
`default Integer`	`remove(Object key)`	Deprecated. Please use the corresponding type-specific method instead.

Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, size

Methods inherited from interface java.util.function.Function
andThen, compose

Methods inherited from interface java.util.function.IntUnaryOperator
andThen, compose

- Method Detail
  - applyAsInt
```
@Deprecated
default int applyAsInt(int 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., Int2IntFunction instead of Short2IntFunction).
    
    Specified by:
    
    applyAsInt in interface IntUnaryOperator
    
    Throws:
    
    IllegalArgumentException - If the given operand is not an element of the key domain.
    
    Since:
    
    8.0.0
  - put
```
default int put(short key,
                int 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
```
int get(short 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 int remove(short 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 Integer put(Short key,
                    Integer 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:
    
    put in interface Function<Short,Integer>
    
    Parameters:
    
    key - the key.
    
    value - the value.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.put(Object,Object)
  - get
```
@Deprecated
default Integer 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:
    
    get in interface Function<Short,Integer>
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - remove
```
@Deprecated
default Integer 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:
    
    remove in interface Function<Short,Integer>
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.remove(Object)
  - containsKey
```
default boolean containsKey(short 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:
    
    containsKey in interface Function<Short,Integer>
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - defaultReturnValue
```
default void defaultReturnValue(int rv)
```
    Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() 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 int 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.
  - andThenByte
```
default Short2ByteFunction andThenByte(Int2ByteFunction after)
```
  - composeByte
```
default Byte2IntFunction composeByte(Byte2ShortFunction before)
```
  - andThenShort
```
default Short2ShortFunction andThenShort(Int2ShortFunction after)
```
  - composeShort
```
default Short2IntFunction composeShort(Short2ShortFunction before)
```
  - andThenInt
```
default Short2IntFunction andThenInt(Int2IntFunction after)
```
  - composeInt
```
default Int2IntFunction composeInt(Int2ShortFunction before)
```
  - andThenLong
```
default Short2LongFunction andThenLong(Int2LongFunction after)
```
  - composeLong
```
default Long2IntFunction composeLong(Long2ShortFunction before)
```
  - andThenChar
```
default Short2CharFunction andThenChar(Int2CharFunction after)
```
  - composeChar
```
default Char2IntFunction composeChar(Char2ShortFunction before)
```
  - andThenFloat
```
default Short2FloatFunction andThenFloat(Int2FloatFunction after)
```
  - composeFloat
```
default Float2IntFunction composeFloat(Float2ShortFunction before)
```
  - andThenDouble
```
default Short2DoubleFunction andThenDouble(Int2DoubleFunction after)
```
  - composeDouble
```
default Double2IntFunction composeDouble(Double2ShortFunction before)
```
  - andThenObject
```
default <T> Short2ObjectFunction<T> andThenObject(Int2ObjectFunction<T> after)
```
  - composeObject
```
default <T> Object2IntFunction<T> composeObject(Object2ShortFunction<T> before)
```
  - andThenReference
```
default <T> Short2ReferenceFunction<T> andThenReference(Int2ReferenceFunction<T> after)
```
  - composeReference
```
default <T> Reference2IntFunction<T> composeReference(Reference2ShortFunction<T> before)
```

Interface Short2IntFunction

Method Summary

Methods inherited from interface it.unimi.dsi.fastutil.Function

Methods inherited from interface java.util.function.Function

Methods inherited from interface java.util.function.IntUnaryOperator

Method Detail

applyAsInt

put

get

remove

put

get

remove

containsKey

containsKey

defaultReturnValue

defaultReturnValue

andThenByte

composeByte

andThenShort

composeShort

andThenInt

composeInt

andThenLong

composeLong

andThenChar

composeChar

andThenFloat

composeFloat

andThenDouble

composeDouble

andThenObject

composeObject

andThenReference

composeReference