All Superinterfaces:

Function<java.lang.Character,java.lang.Double>, java.util.function.Function<java.lang.Character,java.lang.Double>, java.util.function.IntToDoubleFunction

All Known Subinterfaces:

Char2DoubleMap, Char2DoubleSortedMap

All Known Implementing Classes:

AbstractChar2DoubleFunction, AbstractChar2DoubleMap, AbstractChar2DoubleSortedMap, Char2DoubleArrayMap, Char2DoubleAVLTreeMap, Char2DoubleFunctions.EmptyFunction, Char2DoubleFunctions.PrimitiveFunction, Char2DoubleFunctions.Singleton, Char2DoubleFunctions.SynchronizedFunction, Char2DoubleFunctions.UnmodifiableFunction, Char2DoubleLinkedOpenHashMap, Char2DoubleMaps.EmptyMap, Char2DoubleMaps.Singleton, Char2DoubleMaps.SynchronizedMap, Char2DoubleMaps.UnmodifiableMap, Char2DoubleOpenCustomHashMap, Char2DoubleOpenHashMap, Char2DoubleRBTreeMap, Char2DoubleSortedMaps.EmptySortedMap, Char2DoubleSortedMaps.Singleton, Char2DoubleSortedMaps.SynchronizedSortedMap, Char2DoubleSortedMaps.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 Char2DoubleFunction
extends Function<java.lang.Character,java.lang.Double>, java.util.function.IntToDoubleFunction
```
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 <T> java.util.function.Function<java.lang.Character,T>`	`andThen(java.util.function.Function<? super java.lang.Double,? extends T> after)`	Deprecated. Please use the corresponding type-specific method instead.
`default Char2ByteFunction`	`andThenByte(Double2ByteFunction after)`
`default Char2CharFunction`	`andThenChar(Double2CharFunction after)`
`default Char2DoubleFunction`	`andThenDouble(Double2DoubleFunction after)`
`default Char2FloatFunction`	`andThenFloat(Double2FloatFunction after)`
`default Char2IntFunction`	`andThenInt(Double2IntFunction after)`
`default Char2LongFunction`	`andThenLong(Double2LongFunction after)`
`default <T> Char2ObjectFunction<T>`	`andThenObject(Double2ObjectFunction<? extends T> after)`
`default <T> Char2ReferenceFunction<T>`	`andThenReference(Double2ReferenceFunction<? extends T> after)`
`default Char2ShortFunction`	`andThenShort(Double2ShortFunction after)`
`default double`	`applyAsDouble(int operand)`	Deprecated. Please use primitive types which do not have to be widened as keys.
`default <T> java.util.function.Function<T,java.lang.Double>`	`compose(java.util.function.Function<? super T,? extends java.lang.Character> before)`	Deprecated. Please use the corresponding type-specific method instead.
`default Byte2DoubleFunction`	`composeByte(Byte2CharFunction before)`
`default Char2DoubleFunction`	`composeChar(Char2CharFunction before)`
`default Double2DoubleFunction`	`composeDouble(Double2CharFunction before)`
`default Float2DoubleFunction`	`composeFloat(Float2CharFunction before)`
`default Int2DoubleFunction`	`composeInt(Int2CharFunction before)`
`default Long2DoubleFunction`	`composeLong(Long2CharFunction before)`
`default <T> Object2DoubleFunction<T>`	`composeObject(Object2CharFunction<? super T> before)`
`default <T> Reference2DoubleFunction<T>`	`composeReference(Reference2CharFunction<? super T> before)`
`default Short2DoubleFunction`	`composeShort(Short2CharFunction before)`
`default boolean`	`containsKey(char 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(char 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(char 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.
`default double`	`put(char key, double value)`	Adds a pair to the map (optional operation).
`default java.lang.Double`	`put(java.lang.Character key, java.lang.Double value)`	Deprecated. Please use the corresponding type-specific method instead.
`default double`	`remove(char 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 it.unimi.dsi.fastutil.Function
apply, clear, size

- Method Detail
  - applyAsDouble
```
@Deprecated
default double applyAsDouble(int operand)
```
    Deprecated.
    Please use primitive types which do not have to be widened as keys.
    
    Specified by:
    
    applyAsDouble in interface java.util.function.IntToDoubleFunction
    
    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., Int2IntFunction instead of Short2IntFunction).
  - put
```
default double put(char 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(char 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(char 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(char 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.Character 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).
    
    Specified by:
    
    put in interface Function<java.lang.Character,java.lang.Double>
    
    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 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.
    
    Specified by:
    
    get in interface Function<java.lang.Character,java.lang.Double>
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - 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 interface Function<java.lang.Character,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).
    
    Specified by:
    
    remove in interface Function<java.lang.Character,java.lang.Double>
    
    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(char 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 interface Function<java.lang.Character,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 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 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.
  - compose
```
@Deprecated
default <T> java.util.function.Function<T,java.lang.Double> compose(java.util.function.Function<? super T,? extends java.lang.Character> before)
```
    Deprecated.
    Please use the corresponding type-specific method instead.
    
    Specified by:
    
    compose in interface java.util.function.Function<java.lang.Character,java.lang.Double>
  - andThen
```
@Deprecated
default <T> java.util.function.Function<java.lang.Character,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 interface java.util.function.Function<java.lang.Character,java.lang.Double>
  - andThenByte
```
default Char2ByteFunction andThenByte(Double2ByteFunction after)
```
  - composeByte
```
default Byte2DoubleFunction composeByte(Byte2CharFunction before)
```
  - andThenShort
```
default Char2ShortFunction andThenShort(Double2ShortFunction after)
```
  - composeShort
```
default Short2DoubleFunction composeShort(Short2CharFunction before)
```
  - andThenInt
```
default Char2IntFunction andThenInt(Double2IntFunction after)
```
  - composeInt
```
default Int2DoubleFunction composeInt(Int2CharFunction before)
```
  - andThenLong
```
default Char2LongFunction andThenLong(Double2LongFunction after)
```
  - composeLong
```
default Long2DoubleFunction composeLong(Long2CharFunction before)
```
  - andThenChar
```
default Char2CharFunction andThenChar(Double2CharFunction after)
```
  - composeChar
```
default Char2DoubleFunction composeChar(Char2CharFunction before)
```
  - andThenFloat
```
default Char2FloatFunction andThenFloat(Double2FloatFunction after)
```
  - composeFloat
```
default Float2DoubleFunction composeFloat(Float2CharFunction before)
```
  - andThenDouble
```
default Char2DoubleFunction andThenDouble(Double2DoubleFunction after)
```
  - composeDouble
```
default Double2DoubleFunction composeDouble(Double2CharFunction before)
```
  - andThenObject
```
default <T> Char2ObjectFunction<T> andThenObject(Double2ObjectFunction<? extends T> after)
```
  - composeObject
```
default <T> Object2DoubleFunction<T> composeObject(Object2CharFunction<? super T> before)
```
  - andThenReference
```
default <T> Char2ReferenceFunction<T> andThenReference(Double2ReferenceFunction<? extends T> after)
```
  - composeReference
```
default <T> Reference2DoubleFunction<T> composeReference(Reference2CharFunction<? super T> before)
```

Interface Char2DoubleFunction

Method Summary

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

Method Detail

applyAsDouble

put

get

getOrDefault

remove

put

get

getOrDefault

remove

containsKey

containsKey

defaultReturnValue

defaultReturnValue

compose

andThen

andThenByte

composeByte

andThenShort

composeShort

andThenInt

composeInt

andThenLong

composeLong

andThenChar

composeChar

andThenFloat

composeFloat

andThenDouble

composeDouble

andThenObject

composeObject

andThenReference

composeReference