it.unimi.dsi.fastutil.objects
Class Reference2DoubleFunctions.UnmodifiableFunction<K>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Reference2DoubleMaps.UnmodifiableMap

Enclosing class:

Reference2DoubleFunctions

public static class Reference2DoubleFunctions.UnmodifiableFunction<K>
extends AbstractReference2DoubleFunction<K>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Method Summary

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	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	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 it.unimi.dsi.fastutil.objects.AbstractReference2DoubleFunction

get, put, remove

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

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

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)