it.unimi.dsi.fastutil.chars

Class Char2DoubleFunctions.EmptyFunction

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2DoubleFunction

it.unimi.dsi.fastutil.chars.Char2DoubleFunctions.EmptyFunction

All Implemented Interfaces:

Char2DoubleFunction, Function<Character,Double>, Serializable, Cloneable

Direct Known Subclasses:

Char2DoubleMaps.EmptyMap

Enclosing class:

Char2DoubleFunctions

public static class Char2DoubleFunctions.EmptyFunction
extends AbstractChar2DoubleFunction
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

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
Object	clone()
boolean	containsKey(char k)
double	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(double defRetValue) Sets the default return value.
double	get(char k) Returns the value to which the given key is mapped.
Double	get(Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
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.chars.AbstractChar2DoubleFunction

containsKey, put, put, remove, remove

Methods inherited from class java.lang.Object

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

Method Detail

get

public double get(char k)

Description copied from interface: Char2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2DoubleFunction

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

Specified by:

containsKey in interface Char2DoubleFunction

See Also:

Function.containsKey(Object)

defaultReturnValue

public double defaultReturnValue()

Description copied from interface: Char2DoubleFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Char2DoubleFunction

Overrides:

defaultReturnValue in class AbstractChar2DoubleFunction

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(double defRetValue)

Description copied from interface: Char2DoubleFunction

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 Char2DoubleFunction

Overrides:

defaultReturnValue in class AbstractChar2DoubleFunction

Parameters:

defRetValue - the new default return value.

See Also:

Char2DoubleFunction.defaultReturnValue()

get

public Double get(Object k)

Description copied from class: AbstractChar2DoubleFunction

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

Overrides:

get in class AbstractChar2DoubleFunction

Parameters:

k - the key.

Returns:

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

See Also:

Map.get(Object)

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

Overrides:

clear in class AbstractChar2DoubleFunction

See Also:

Map.clear()

clone

public Object clone()

Overrides:

clone in class Object