it.unimi.dsi.fastutil.ints
Class AbstractInt2DoubleFunction
java.lang.Object
it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction
- All Implemented Interfaces:
- Function<java.lang.Integer,java.lang.Double>, Int2DoubleFunction, java.io.Serializable
- Direct Known Subclasses:
- AbstractInt2DoubleMap, Int2DoubleFunctions.EmptyFunction, Int2DoubleFunctions.Singleton, Int2DoubleFunctions.SynchronizedFunction, Int2DoubleFunctions.UnmodifiableFunction
public abstract class AbstractInt2DoubleFunction
- extends java.lang.Object
- implements Int2DoubleFunction, java.io.Serializable
An abstract class providing basic methods for functions implementing a type-specific interface.
Optional operations just throw an UnsupportedOperationException
. Generic versions of accessors delegate to
the corresponding type-specific counterparts following the interface rules
(they take care of returning null
on a missing key).
This class handles directly a default return
value (including methods to access
it). Instances of classes inheriting from this class have just to return
defRetValue
to denote lack of a key in type-specific methods. The value
is serialized.
Implementing subclasses have just to provide type-specific get()
,
type-specific containsKey()
, and size() methods.
- See Also:
- Serialized Form
Method Summary |
void |
clear()
Removes all associations from this function (optional operation). |
boolean |
containsKey(java.lang.Object ok)
Returns true if this function contains a mapping for the specified key. |
double |
defaultReturnValue()
Gets the default return value. |
void |
defaultReturnValue(double rv)
Sets the default return value. |
java.lang.Double |
get(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning null on a missing key. |
double |
put(int key,
double value)
Adds a pair to the map. |
java.lang.Double |
put(java.lang.Integer ok,
java.lang.Double ov)
Delegates to the corresponding type-specific method, taking care of returning null on a missing key. |
double |
remove(int key)
Removes the mapping with the given key. |
java.lang.Double |
remove(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning null on a missing key. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface it.unimi.dsi.fastutil.Function |
size |
defaultReturnValue
public void defaultReturnValue(double rv)
- Description copied from interface:
Int2DoubleFunction
- 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 Int2DoubleFunction
- Parameters:
rv
- the new default return value.- See Also:
Int2DoubleFunction.defaultReturnValue()
defaultReturnValue
public double defaultReturnValue()
- Description copied from interface:
Int2DoubleFunction
- Gets the default return value.
- Specified by:
defaultReturnValue
in interface Int2DoubleFunction
- Returns:
- the current default return value.
put
public double put(int key,
double value)
- Description copied from interface:
Int2DoubleFunction
- Adds a pair to the map.
- Specified by:
put
in interface Int2DoubleFunction
- Parameters:
key
- the key.value
- 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)
remove
public double remove(int key)
- Description copied from interface:
Int2DoubleFunction
- Removes the mapping with the given key.
- Specified by:
remove
in interface Int2DoubleFunction
- 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<java.lang.Integer,java.lang.Double>
- See Also:
Map.clear()
containsKey
public boolean containsKey(java.lang.Object ok)
- 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<java.lang.Integer,java.lang.Double>
- Parameters:
ok
- the key.
- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
get
public java.lang.Double get(java.lang.Object ok)
- 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.Integer,java.lang.Double>
- Parameters:
ok
- the key.
- Returns:
- the corresponding value, or
null
if no value was present for the given key. - See Also:
Map.get(Object)
put
public java.lang.Double put(java.lang.Integer ok,
java.lang.Double ov)
- 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:
put
in interface Function<java.lang.Integer,java.lang.Double>
- Parameters:
ok
- the key.ov
- the value.
- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.put(Object,Object)
remove
public java.lang.Double remove(java.lang.Object ok)
- 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:
remove
in interface Function<java.lang.Integer,java.lang.Double>
- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.remove(Object)