it.unimi.dsi.fastutil.objects
Interface Reference2DoubleMap

All Superinterfaces:
Map
All Known Subinterfaces:
Reference2DoubleSortedMap
All Known Implementing Classes:
AbstractReference2DoubleMap, Reference2DoubleLinkedOpenHashMap, Reference2DoubleOpenHashMap

public interface Reference2DoubleMap
extends Map

A type-specific Map; provides some additional methods that use polymorphism to reduce type juggling.

See Also:
Map

Nested Class Summary
static interface Reference2DoubleMap.Entry
          A type-specific Map.Entry; provides some additional methods to access its content reducing type juggling.
 
Method Summary
 boolean containsValue(double value)
           
 double defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(double rv)
          Sets the default return value.
 double getDefRetValue()
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 double getDouble(Object key)
          Returns the value to which the given key is mapped.
 double put(Object key, double value)
          Adds a pair to the map.
 double removeDouble(Object key)
          Removes the mapping with the given key.
 void setDefRetValue(double rv)
          Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

put

public double put(Object key,
                  double value)
Adds a pair to the map.

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:
Map.put(Object,Object)

getDouble

public double getDouble(Object key)
Returns the value to which the given key is mapped.

Parameters:
key - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

removeDouble

public double removeDouble(Object key)
Removes the mapping with the given key.

Parameters:
key -
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Map.remove(Object)

containsValue

public boolean containsValue(double value)
See Also:
Map.containsValue(Object)

setDefRetValue

public void setDefRetValue(double rv)
Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().

Sets the default return value. This value is returned by get(), put() and remove() to denote that the map does not contain the specified key. It is 0/false/null by default.

Parameters:
rv - the new default return value.
See Also:
getDefRetValue(), defaultReturnValue()

getDefRetValue

public double getDefRetValue()
Deprecated. As of fastutil 2.0, replaced by defaultReturnValue().

Gets the default return value.

Returns:
the current default return value.
See Also:
defaultReturnValue()

defaultReturnValue

public void defaultReturnValue(double rv)
Sets the default return value. This value is returned by get(), put() and remove() to denote that the map does not contain the specified key. It is 0/false/null by default.

Parameters:
rv - the new default return value.
See Also:
defaultReturnValue()

defaultReturnValue

public double defaultReturnValue()
Gets the default return value.

Returns:
the current default return value.