Reference2DoubleFunctions.SynchronizedFunction (fastutil 6.4.1 API)

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

All Implemented Interfaces:

Function<K,Double>, Reference2DoubleFunction<K>, Serializable

Direct Known Subclasses:

Reference2DoubleMaps.SynchronizedMap

Enclosing class:

Reference2DoubleFunctions
```
public static class Reference2DoubleFunctions.SynchronizedFunction<K>
extends AbstractReference2DoubleFunction<K>
implements Serializable
```
A synchronized wrapper class for functions.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Reference2DoubleFunction<K> function

static long serialVersionUID

protected Object sync
- Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2DoubleFunction
  defRetValue

Fields
Modifier and Type	Field and Description
`protected Reference2DoubleFunction<K>`	`function`
`static long`	`serialVersionUID`
`protected Object`	`sync`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Reference2DoubleFunctions.SynchronizedFunction(Reference2DoubleFunction<K> f)`
`protected`	`Reference2DoubleFunctions.SynchronizedFunction(Reference2DoubleFunction<K> f, Object sync)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all associations from this function (optional operation).
`boolean`	`containsKey(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.
`Double`	`get(Object k)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`double`	`getDouble(Object k)` Returns the value to which the given key is mapped.
`double`	`put(K k, double v)` Adds a pair to the map.
`Double`	`put(K k, Double v)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`Double`	`remove(Object k)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`double`	`removeDouble(Object k)` Removes the mapping with the given key.
`int`	`size()` Returns the intended number of keys in this function, or -1 if no such number exists.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - function
```
protected final Reference2DoubleFunction<K> function
```
  - sync
```
protected final Object sync
```
- Constructor Detail
  - Reference2DoubleFunctions.SynchronizedFunction
```
protected Reference2DoubleFunctions.SynchronizedFunction(Reference2DoubleFunction<K> f,
                                              Object sync)
```
  - Reference2DoubleFunctions.SynchronizedFunction
```
protected Reference2DoubleFunctions.SynchronizedFunction(Reference2DoubleFunction<K> f)
```
- Method Detail
  - 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.
    
    Specified by:
    
    size in interface Function<K,Double>
    
    Returns:
    the intended number of keys in this function, or -1 if that number is not available.
  - containsKey
```
public boolean containsKey(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.
    
    Specified by:
    
    containsKey in interface Function<K,Double>
    
    Parameters:
    k - the key.
    
    Returns:
    true if this function associates a value to key.
    See Also:
    Map.containsKey(Object)
  - defaultReturnValue
```
public double defaultReturnValue()
```
    Description copied from interface: Reference2DoubleFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Reference2DoubleFunction<K>
    
    Overrides:
    
    defaultReturnValue in class AbstractReference2DoubleFunction<K>
    
    Returns:
    the current default return value.
  - defaultReturnValue
```
public void defaultReturnValue(double defRetValue)
```
    Description copied from interface: Reference2DoubleFunction
    
    Sets the default return value. 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>
    
    Overrides:
    
    defaultReturnValue in class AbstractReference2DoubleFunction<K>
    
    Parameters:
    defRetValue - the new default return value.
    See Also:
    Reference2DoubleFunction.defaultReturnValue()
  - put
```
public double put(K k,
         double v)
```
    Description copied from interface: Reference2DoubleFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Reference2DoubleFunction<K>
    
    Overrides:
    
    put in class AbstractReference2DoubleFunction<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)
  - clear
```
public void clear()
```
    Description copied from interface: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<K,Double>
    
    Overrides:
    
    clear in class AbstractReference2DoubleFunction<K>
    
    See Also:
    Map.clear()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - put
```
public Double put(K k,
         Double v)
```
    Description copied from class: AbstractReference2DoubleFunction
    
    Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
    This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.
    
    Specified by:
    
    put in interface Function<K,Double>
    
    Overrides:
    
    put in class AbstractReference2DoubleFunction<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
```
public Double get(Object k)
```
    Description copied from class: AbstractReference2DoubleFunction
    
    Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
    This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.
    
    Specified by:
    
    get in interface Function<K,Double>
    
    Overrides:
    
    get in class AbstractReference2DoubleFunction<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
```
public Double remove(Object k)
```
    Description copied from class: AbstractReference2DoubleFunction
    
    Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
    This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.
    
    Specified by:
    
    remove in interface Function<K,Double>
    
    Overrides:
    
    remove in class AbstractReference2DoubleFunction<K>
    
    Returns:
    the old value, or null if no value was present for the given key.
    See Also:
    Map.remove(Object)
  - removeDouble
```
public double removeDouble(Object k)
```
    Description copied from interface: Reference2DoubleFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    removeDouble in interface Reference2DoubleFunction<K>
    
    Overrides:
    
    removeDouble in class AbstractReference2DoubleFunction<K>
    
    Returns:
    the old value, or the default return value if no value was present for the given key.
    See Also:
    Function.remove(Object)
  - getDouble
```
public double getDouble(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)

Class Reference2DoubleFunctions.SynchronizedFunction<K>

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2DoubleFunction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

function

sync

Constructor Detail

Reference2DoubleFunctions.SynchronizedFunction

Reference2DoubleFunctions.SynchronizedFunction

Method Detail

size

containsKey

defaultReturnValue

defaultReturnValue

put

clear

toString

put

get

remove

removeDouble

getDouble