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

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2DoubleFunction<K>

All Implemented Interfaces:

Function<K,Double>, Object2DoubleFunction<K>, Serializable

Direct Known Subclasses:

AbstractObject2DoubleMap, Object2DoubleFunctions.EmptyFunction, Object2DoubleFunctions.Singleton, Object2DoubleFunctions.SynchronizedFunction, Object2DoubleFunctions.UnmodifiableFunction

public abstract class AbstractObject2DoubleFunction<K>
extends Object
implements Object2DoubleFunction<K>, Serializable

An abstract class providing basic methods for functions implementing a type-specific interface.

Optional operations just throw an UnsupportedOperationException. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules (they take care of returning null on a missing key).

This class handles directly a default return value (including methods to access it). Instances of classes inheriting from this class have just to return defRetValue to denote lack of a key in type-specific methods. The value is serialized.

Implementing subclasses have just to provide type-specific get(), type-specific containsKey(), and size() methods.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
double	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(double rv) Sets the default return value.
Double	get(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	put(K key, double value) Adds a pair to the map.
Double	put(K ok, Double ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
Double	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	removeDouble(Object key) Removes the mapping with the given key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleFunction

getDouble

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

containsKey, size

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

defaultReturnValue

public void defaultReturnValue(double rv)

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>

Parameters:

rv - the new default return value.

See Also:

Object2DoubleFunction.defaultReturnValue()

defaultReturnValue

public double defaultReturnValue()

Description copied from interface: Object2DoubleFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2DoubleFunction<K>

Returns:

the current default return value.

put

public double put(K key,
                  double value)

Description copied from interface: Object2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Object2DoubleFunction<K>

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)

removeDouble

public double removeDouble(Object key)

Description copied from interface: Object2DoubleFunction

Removes the mapping with the given key.

Specified by:

removeDouble in interface Object2DoubleFunction<K>

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,Double>

See Also:

Map.clear()

get

public Double get(Object ok)

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>

Parameters:

ok - the key.

Returns:

the corresponding value, or null if no value was present for the given key.

See Also:

Map.get(Object)

put

public Double put(K ok,
                  Double ov)

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>

Parameters:

ok - the key.

ov - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public Double remove(Object ok)

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>

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)