it.unimi.dsi.fastutil.objects

Class Reference2DoubleFunctions.EmptyFunction<K>

java.lang.Object

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

it.unimi.dsi.fastutil.objects.Reference2DoubleFunctions.EmptyFunction<K>

All Implemented Interfaces:

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

Direct Known Subclasses:

Reference2DoubleMaps.EmptyMap

Enclosing class:

Reference2DoubleFunctions

public static class Reference2DoubleFunctions.EmptyFunction<K>
extends AbstractReference2DoubleFunction<K>
implements Serializable, Cloneable

An immutable class representing an empty type-specific function.

This class may be useful to implement your own in case you subclass a type-specific function.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Reference2DoubleFunctions.EmptyFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
Object	clone()
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	getDouble(Object k) Returns the value to which the given key is mapped.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.

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

get, put, put, remove, removeDouble

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Reference2DoubleFunctions.EmptyFunction

protected Reference2DoubleFunctions.EmptyFunction()

Method Detail

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)

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()

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.

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()

clone

public Object clone()

Overrides:

clone in class Object