it.unimi.dsi.fastutil.objects

Class Object2DoubleFunctions.SynchronizedFunction<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2DoubleFunction<K>

it.unimi.dsi.fastutil.objects.Object2DoubleFunctions.SynchronizedFunction<K>

All Implemented Interfaces:

Function<K,java.lang.Double>, Object2DoubleFunction<K>, java.io.Serializable

Direct Known Subclasses:

Object2DoubleMaps.SynchronizedMap

Enclosing class:

Object2DoubleFunctions

public static class Object2DoubleFunctions.SynchronizedFunction<K>
extends AbstractObject2DoubleFunction<K>
implements java.io.Serializable

A synchronized wrapper class for functions.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
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.
java.lang.Double	get(java.lang.Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	getDouble(java.lang.Object k) Returns the value to which the given key is mapped.
double	put(K k, double v) Adds a pair to the map.
java.lang.Double	put(K k, java.lang.Double v) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
java.lang.Double	remove(java.lang.Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	removeDouble(java.lang.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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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,java.lang.Double>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

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.

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)

defaultReturnValue

public double defaultReturnValue()

Description copied from interface: Object2DoubleFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2DoubleFunction<K>

Overrides:

defaultReturnValue in class AbstractObject2DoubleFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(double defRetValue)

Description copied from interface: Object2DoubleFunction

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 Object2DoubleFunction<K>

Overrides:

defaultReturnValue in class AbstractObject2DoubleFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Object2DoubleFunction.defaultReturnValue()

put

public double put(K k,
         double v)

Description copied from interface: Object2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Object2DoubleFunction<K>

Overrides:

put in class AbstractObject2DoubleFunction<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,java.lang.Double>

Overrides:

clear in class AbstractObject2DoubleFunction<K>

See Also:

Map.clear()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

put

public java.lang.Double put(K k,
                   java.lang.Double v)

Description copied from class: AbstractObject2DoubleFunction

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,java.lang.Double>

Overrides:

put in class AbstractObject2DoubleFunction<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 java.lang.Double get(java.lang.Object k)

Description copied from class: AbstractObject2DoubleFunction

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,java.lang.Double>

Overrides:

get in class AbstractObject2DoubleFunction<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 java.lang.Double remove(java.lang.Object k)

Description copied from class: AbstractObject2DoubleFunction

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,java.lang.Double>

Overrides:

remove in class AbstractObject2DoubleFunction<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(java.lang.Object k)

Description copied from interface: Object2DoubleFunction

Removes the mapping with the given key.

Specified by:

removeDouble in interface Object2DoubleFunction<K>

Overrides:

removeDouble in class AbstractObject2DoubleFunction<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(java.lang.Object k)

Description copied from interface: Object2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

getDouble in interface Object2DoubleFunction<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)