it.unimi.dsi.fastutil.doubles
Class Double2ReferenceFunctions.EmptyFunction<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ReferenceFunction<V>
      extended by it.unimi.dsi.fastutil.doubles.Double2ReferenceFunctions.EmptyFunction<V>
All Implemented Interfaces:
Double2ReferenceFunction<V>, Function<java.lang.Double,V>, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
Double2ReferenceMaps.EmptyMap
Enclosing class:
Double2ReferenceFunctions

public static class Double2ReferenceFunctions.EmptyFunction<V>
extends AbstractDouble2ReferenceFunction<V>
implements java.io.Serializable, java.lang.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
 void clear()
          Removes all associations from this function (optional operation).
 java.lang.Object clone()
           
 boolean containsKey(double k)
           
 V defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(V defRetValue)
          Sets the default return value.
 V get(double k)
          Returns the value to which the given key is mapped.
 V get(java.lang.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.doubles.AbstractDouble2ReferenceFunction
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 V get(double k)
Description copied from interface: Double2ReferenceFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Double2ReferenceFunction<V>
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(double k)
Specified by:
containsKey in interface Double2ReferenceFunction<V>
See Also:
Function.containsKey(Object)

defaultReturnValue

public V defaultReturnValue()
Description copied from interface: Double2ReferenceFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Double2ReferenceFunction<V>
Overrides:
defaultReturnValue in class AbstractDouble2ReferenceFunction<V>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)
Description copied from interface: Double2ReferenceFunction
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 Double2ReferenceFunction<V>
Overrides:
defaultReturnValue in class AbstractDouble2ReferenceFunction<V>
Parameters:
defRetValue - the new default return value.
See Also:
Double2ReferenceFunction.defaultReturnValue()

get

public V get(java.lang.Object k)
Description copied from class: AbstractDouble2ReferenceFunction
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<java.lang.Double,V>
Overrides:
get in class AbstractDouble2ReferenceFunction<V>
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<java.lang.Double,V>
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<java.lang.Double,V>
Overrides:
clear in class AbstractDouble2ReferenceFunction<V>
See Also:
Map.clear()

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object