it.unimi.dsi.fastutil.doubles
Class Double2DoubleMaps.SynchronizedMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2DoubleFunction
      extended by it.unimi.dsi.fastutil.doubles.Double2DoubleFunctions.SynchronizedFunction
          extended by it.unimi.dsi.fastutil.doubles.Double2DoubleMaps.SynchronizedMap
All Implemented Interfaces:
Double2DoubleFunction, Double2DoubleMap, Function<java.lang.Double,java.lang.Double>, java.io.Serializable, java.util.Map<java.lang.Double,java.lang.Double>
Direct Known Subclasses:
Double2DoubleSortedMaps.SynchronizedSortedMap
Enclosing class:
Double2DoubleMaps

public static class Double2DoubleMaps.SynchronizedMap
extends Double2DoubleFunctions.SynchronizedFunction
implements Double2DoubleMap, java.io.Serializable

A synchronized wrapper class for maps.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2DoubleMap
Double2DoubleMap.Entry, Double2DoubleMap.FastEntrySet
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(double k)
           
 boolean containsKey(java.lang.Object ok)
          Returns true if this function contains a mapping for the specified key.
 boolean containsValue(double v)
           
 boolean containsValue(java.lang.Object ov)
           
 double defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(double defRetValue)
          Sets the default return value.
 ObjectSet<Double2DoubleMap.Entry> double2DoubleEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 ObjectSet<java.util.Map.Entry<java.lang.Double,java.lang.Double>> entrySet()
          Returns a set view of the mappings contained in this map.
 boolean equals(java.lang.Object o)
           
 double get(double k)
          Returns the value to which the given key is mapped.
 int hashCode()
           
 boolean isEmpty()
           
 DoubleSet keySet()
          Returns a set view of the keys contained in this map.
 double put(double k, double v)
          Adds a pair to the map.
 java.lang.Double put(java.lang.Double k, java.lang.Double v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 void putAll(java.util.Map<? extends java.lang.Double,? extends java.lang.Double> m)
           
 double remove(double k)
          Removes the mapping with the given key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 java.lang.String toString()
           
 DoubleCollection values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.Double2DoubleFunctions.SynchronizedFunction
get, remove
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
get, remove
 
Methods inherited from interface java.util.Map
get, remove
 

Method Detail

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,java.lang.Double>
Specified by:
size in interface java.util.Map<java.lang.Double,java.lang.Double>
Overrides:
size in class Double2DoubleFunctions.SynchronizedFunction
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(double k)
Specified by:
containsKey in interface Double2DoubleFunction
Overrides:
containsKey in class Double2DoubleFunctions.SynchronizedFunction
See Also:
Function.containsKey(Object)

containsValue

public boolean containsValue(double v)
Specified by:
containsValue in interface Double2DoubleMap
See Also:
Map.containsValue(Object)

defaultReturnValue

public double defaultReturnValue()
Description copied from interface: Double2DoubleFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Double2DoubleFunction
Overrides:
defaultReturnValue in class Double2DoubleFunctions.SynchronizedFunction
Returns:
the current default return value.

defaultReturnValue

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

put

public double put(double k,
                  double v)
Description copied from interface: Double2DoubleFunction
Adds a pair to the map.

Specified by:
put in interface Double2DoubleFunction
Overrides:
put in class Double2DoubleFunctions.SynchronizedFunction
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)

putAll

public void putAll(java.util.Map<? extends java.lang.Double,? extends java.lang.Double> m)
Specified by:
putAll in interface java.util.Map<java.lang.Double,java.lang.Double>

double2DoubleEntrySet

public ObjectSet<Double2DoubleMap.Entry> double2DoubleEntrySet()
Description copied from interface: Double2DoubleMap
Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Double2DoubleMap.entrySet() so that it returns an ObjectSet of objects of type Map.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
double2DoubleEntrySet in interface Double2DoubleMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Double2DoubleMap.entrySet()

keySet

public DoubleSet keySet()
Description copied from interface: Double2DoubleMap
Returns a set view of the keys contained in this map.

Note that this specification strengthens the one given in Map.keySet().

Specified by:
keySet in interface Double2DoubleMap
Specified by:
keySet in interface java.util.Map<java.lang.Double,java.lang.Double>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

public DoubleCollection values()
Description copied from interface: Double2DoubleMap
Returns a set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values().

Specified by:
values in interface Double2DoubleMap
Specified by:
values in interface java.util.Map<java.lang.Double,java.lang.Double>
Returns:
a set view of the values contained in this map.
See Also:
Map.values()

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,java.lang.Double>
Specified by:
clear in interface java.util.Map<java.lang.Double,java.lang.Double>
Overrides:
clear in class Double2DoubleFunctions.SynchronizedFunction
See Also:
Map.clear()

toString

public java.lang.String toString()
Overrides:
toString in class Double2DoubleFunctions.SynchronizedFunction

put

public java.lang.Double put(java.lang.Double k,
                            java.lang.Double v)
Description copied from class: AbstractDouble2DoubleFunction
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.Double,java.lang.Double>
Specified by:
put in interface java.util.Map<java.lang.Double,java.lang.Double>
Overrides:
put in class Double2DoubleFunctions.SynchronizedFunction
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)

remove

public double remove(double k)
Description copied from interface: Double2DoubleFunction
Removes the mapping with the given key.

Specified by:
remove in interface Double2DoubleFunction
Overrides:
remove in class Double2DoubleFunctions.SynchronizedFunction
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

get

public double get(double k)
Description copied from interface: Double2DoubleFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Double2DoubleFunction
Overrides:
get in class Double2DoubleFunctions.SynchronizedFunction
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(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.Double,java.lang.Double>
Specified by:
containsKey in interface java.util.Map<java.lang.Double,java.lang.Double>
Overrides:
containsKey in class Double2DoubleFunctions.SynchronizedFunction
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object ov)
Specified by:
containsValue in interface java.util.Map<java.lang.Double,java.lang.Double>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.Double,java.lang.Double>

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Double,java.lang.Double>> entrySet()
Description copied from interface: Double2DoubleMap
Returns a set view of the mappings contained in this map.

Note that this specification strengthens the one given in Map.entrySet().

Specified by:
entrySet in interface Double2DoubleMap
Specified by:
entrySet in interface java.util.Map<java.lang.Double,java.lang.Double>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()

hashCode

public int hashCode()
Specified by:
hashCode in interface java.util.Map<java.lang.Double,java.lang.Double>
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Map<java.lang.Double,java.lang.Double>
Overrides:
equals in class java.lang.Object