Package 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, Function<K,Double>, ToDoubleFunction<K>

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

Method Summary

Modifier and Type	Method	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 (optional operation).
boolean	equals(Object o)
Double	get(Object k)	Deprecated. Please use the corresponding type-specific method instead.
double	getDouble(Object k)	Returns the value to which the given key is mapped.
double	getOrDefault(Object k, double defaultValue)	Returns the value associated by this function to the specified key, or give the specified value if not present.
Double	getOrDefault(Object k, Double defaultValue)	Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
double	put(K k, double v)	Adds a pair to the map (optional operation).
Double	put(K k, Double v)	Deprecated. Please use the corresponding type-specific method instead.
Double	remove(Object k)	Deprecated. Please use the corresponding type-specific method instead.
double	removeDouble(Object k)	Removes the mapping with the given key (optional operation).
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

getClass, notify, notifyAll, wait, wait, wait

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

apply

Methods inherited from interface java.util.function.Function

compose

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

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsDouble, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

Method Details

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. This default implementation, in particular, returns -1.

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.

defaultReturnValue

public double defaultReturnValue()

Description copied from interface: Reference2DoubleFunction

Gets the default return value.

This default implementation just return the default null value of the type (null for objects, 0 for scalars, false for Booleans).

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 (optional operation). 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()

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. This default implementation, in particular, 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)

put

public double put(K k,
 double v)

Description copied from interface: Reference2DoubleFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Reference2DoubleFunction<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)

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)

getOrDefault

public double getOrDefault(Object k,
 double defaultValue)

Description copied from interface: Reference2DoubleFunction

Returns the value associated by this function to the specified key, or give the specified value if not present.

Specified by:

getOrDefault in interface Reference2DoubleFunction<K>

Parameters:

k - the key.

defaultValue - the value to return if not present.

Returns:

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

See Also:

• Function.getOrDefault(Object, Object)

removeDouble

public double removeDouble(Object k)

Description copied from interface: Reference2DoubleFunction

Removes the mapping with the given key (optional operation).

Specified by:

removeDouble in interface Reference2DoubleFunction<K>

Parameters:

k - the key.

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

put

@Deprecated
public Double put(K k,
 Double v)

Deprecated.

Please use the corresponding type-specific method instead.

Associates the specified value with the specified key in this function (optional operation).

Specified by:

put in interface Function<K,Double>

Specified by:

put in interface Reference2DoubleFunction<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

@Deprecated
public Double get(Object k)

Deprecated.

Please use the corresponding type-specific method instead.

Returns the value associated by this function to the specified key.

Specified by:

get in interface Function<K,Double>

Specified by:

get in interface Reference2DoubleFunction<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)

getOrDefault

@Deprecated
public Double getOrDefault(Object k,
 Double defaultValue)

Deprecated.

Please use the corresponding type-specific method instead.

Returns the value associated by this function to the specified key, or give the specified value if not present.

Specified by:

getOrDefault in interface Function<K,Double>

Specified by:

getOrDefault in interface Reference2DoubleFunction<K>

Parameters:

k - the key.

defaultValue - the default value to return if not present.

Returns:

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

See Also:

• Map.getOrDefault(Object, Object)

remove

@Deprecated
public Double remove(Object k)

Deprecated.

Please use the corresponding type-specific method instead.

Removes this key and the associated value from this function if it is present (optional operation).

Specified by:

remove in interface Function<K,Double>

Specified by:

remove in interface Reference2DoubleFunction<K>

Parameters:

k - the key.

Returns:

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

See Also:

• Map.remove(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object