Reference2DoubleFunctions.SynchronizedFunction (fastutil 8.2.1)

java.lang.Object
- it.unimi.dsi.fastutil.objects.Reference2DoubleFunctions.SynchronizedFunction<K>

All Implemented Interfaces:

Function<K,java.lang.Double>, Reference2DoubleFunction<K>, java.io.Serializable, java.util.function.Function<K,java.lang.Double>, java.util.function.ToDoubleFunction<K>

Direct Known Subclasses:

Reference2DoubleMaps.SynchronizedMap

Enclosing class:

Reference2DoubleFunctions
```
public static class Reference2DoubleFunctions.SynchronizedFunction<K>
extends java.lang.Object
implements Reference2DoubleFunction<K>, java.io.Serializable
```
A synchronized wrapper class for functions.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.Double`	`apply(K key)`	Deprecated. Please use the corresponding type-specific method instead.
`double`	`applyAsDouble(K operand)`
`void`	`clear()`	Removes all associations from this function (optional operation).
`boolean`	`containsKey(java.lang.Object k)`	Returns true if this function contains a mapping for the specified key.
`double`	`defaultReturnValue()`	Gets the default return value.
`void`	`defaultReturnValue(double defRetValue)`	Sets the default return value (optional operation).
`boolean`	`equals(java.lang.Object o)`
`java.lang.Double`	`get(java.lang.Object k)`	Deprecated. Please use the corresponding type-specific method instead.
`double`	`getDouble(java.lang.Object k)`	Returns the value to which the given key is mapped.
`int`	`hashCode()`
`double`	`put(K k, double v)`	Adds a pair to the map (optional operation).
`java.lang.Double`	`put(K k, java.lang.Double v)`	Deprecated. Please use the corresponding type-specific method instead.
`java.lang.Double`	`remove(java.lang.Object k)`	Deprecated. Please use the corresponding type-specific method instead.
`double`	`removeDouble(java.lang.Object k)`	Removes the mapping with the given key (optional operation).
`int`	`size()`	Returns the intended number of keys in this function, or -1 if no such number exists.
`java.lang.String`	`toString()`

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - applyAsDouble
```
public double applyAsDouble(K operand)
```
    Description copied from interface: Reference2DoubleFunction
    
    Specified by:
    
    applyAsDouble in interface Reference2DoubleFunction<K>
    
    Specified by:
    
    applyAsDouble in interface java.util.function.ToDoubleFunction<K>
  - apply
```
@Deprecated
public java.lang.Double apply(K key)
```
    Deprecated.
    Please use the corresponding type-specific method instead.
    
    This is equivalent to calling Function.get(Object).
    
    Specified by:
    
    apply in interface Function<K,java.lang.Double>
    
    Specified by:
    
    apply in interface java.util.function.Function<K,java.lang.Double>
    
    Parameters:
    
    key -
    
    Returns:
    
    See Also:
    
    Function.apply(Object), Function.get(Object)
  - size
```
public int size()
```
    Description copied from interface: Function
    
    Returns the intended number of keys in this function, or -1 if no such number exists.
    Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible. This default implementation, in particular, returns -1.
    
    Specified by:
    
    size in interface Function<K,java.lang.Double>
    
    Returns:
    
    the intended number of keys in this function, or -1 if that number is not available.
  - defaultReturnValue
```
public double defaultReturnValue()
```
    Description copied from interface: Reference2DoubleFunction
    
    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).
    
    Specified by:
    
    defaultReturnValue in interface Reference2DoubleFunction<K>
    
    Returns:
    
    the current default return value.
  - defaultReturnValue
```
public void defaultReturnValue(double defRetValue)
```
    Description copied from interface: Reference2DoubleFunction
    
    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.
    
    Specified by:
    
    defaultReturnValue in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    defRetValue - the new default return value.
    
    See Also:
    
    Reference2DoubleFunction.defaultReturnValue()
  - containsKey
```
public boolean containsKey(java.lang.Object k)
```
    Description copied from interface: Function
    
    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<K,java.lang.Double>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - put
```
public double put(K k,
                  double v)
```
    Description copied from interface: Reference2DoubleFunction
    
    Adds a pair to the map (optional operation).
    
    Specified by:
    
    put in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    k - the key.
    
    v - 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)
  - getDouble
```
public double getDouble(java.lang.Object k)
```
    Description copied from interface: Reference2DoubleFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    getDouble in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    k - 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)
  - removeDouble
```
public double removeDouble(java.lang.Object k)
```
    Description copied from interface: Reference2DoubleFunction
    
    Removes the mapping with the given key (optional operation).
    
    Specified by:
    
    removeDouble in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    k - 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)
  - clear
```
public void clear()
```
    Description copied from interface: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<K,java.lang.Double>
    
    See Also:
    
    Map.clear()
  - put
```
@Deprecated
public java.lang.Double put(K k,
                            java.lang.Double v)
```
    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<K,java.lang.Double>
    
    Specified by:
    
    put in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    k - the key.
    
    v - 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
public java.lang.Double get(java.lang.Object k)
```
    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<K,java.lang.Double>
    
    Specified by:
    
    get in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - remove
```
@Deprecated
public java.lang.Double remove(java.lang.Object k)
```
    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<K,java.lang.Double>
    
    Specified by:
    
    remove in interface Reference2DoubleFunction<K>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.remove(Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Reference2DoubleFunctions.SynchronizedFunction<K>

Method Summary

Methods inherited from interface java.util.function.Function

Methods inherited from class java.lang.Object

Method Detail

applyAsDouble

apply

size

defaultReturnValue

defaultReturnValue

containsKey

put

getDouble

removeDouble

clear

put

get

remove

hashCode

equals

toString