it.unimi.dsi.fastutil.doubles
Class Double2ObjectRBTreeMap<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectFunction<V>
      extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectMap<V>
          extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectSortedMap<V>
              extended by it.unimi.dsi.fastutil.doubles.Double2ObjectRBTreeMap<V>
All Implemented Interfaces:
Double2ObjectFunction<V>, Double2ObjectMap<V>, Double2ObjectSortedMap<V>, Function<java.lang.Double,V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Double,V>, java.util.SortedMap<java.lang.Double,V>

public class Double2ObjectRBTreeMap<V>
extends AbstractDouble2ObjectSortedMap<V>
implements java.io.Serializable, java.lang.Cloneable

A type-specific red-black tree map with a fast, small-footprint implementation.

The iterators provided by the views of this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectMap
AbstractDouble2ObjectMap.BasicEntry<V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectSortedMap
Double2ObjectSortedMap.FastSortedEntrySet<V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectMap
Double2ObjectMap.FastEntrySet<V>
 
Constructor Summary
Double2ObjectRBTreeMap()
          Creates a new empty tree map.
Double2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Double> c)
          Creates a new empty tree map with the given comparator.
Double2ObjectRBTreeMap(double[] k, V[] v)
          Creates a new tree map using the elements of two parallel arrays.
Double2ObjectRBTreeMap(double[] k, V[] v, java.util.Comparator<? super java.lang.Double> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Double2ObjectRBTreeMap(Double2ObjectMap<? extends V> m)
          Creates a new tree map copying a given map.
Double2ObjectRBTreeMap(Double2ObjectSortedMap<V> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Double2ObjectRBTreeMap(java.util.Map<? extends java.lang.Double,? extends V> m)
          Creates a new tree map copying a given map.
Double2ObjectRBTreeMap(java.util.SortedMap<java.lang.Double,V> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 Double2ObjectRBTreeMap<V> clone()
          Returns a deep copy of this tree map.
 DoubleComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(double k)
          Checks whether the given value is contained in AbstractDouble2ObjectMap.keySet().
 boolean containsValue(java.lang.Object v)
          Checks whether the given value is contained in AbstractDouble2ObjectMap.values().
 ObjectSortedSet<Double2ObjectMap.Entry<V>> double2ObjectEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 double firstDoubleKey()
           
 V get(double k)
          Returns the value to which the given key is mapped.
 Double2ObjectSortedMap<V> headMap(double to)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 boolean isEmpty()
           
 DoubleSortedSet keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 double lastDoubleKey()
           
 V put(double k, V v)
          Adds a pair to the map.
 V put(java.lang.Double ok, V ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 V remove(double k)
          Removes the mapping with the given key.
 V remove(java.lang.Object ok)
          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.
 Double2ObjectSortedMap<V> subMap(double from, double to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Double2ObjectSortedMap<V> tailMap(double from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ObjectCollection<V> values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectMap
equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectFunction
containsKey, defaultReturnValue, defaultReturnValue, get
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get
 
Methods inherited from interface java.util.Map
containsKey, equals, get, hashCode, putAll
 

Constructor Detail

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap()
Creates a new empty tree map.


Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Double> c)
Creates a new empty tree map with the given comparator.

Parameters:
c - a (possibly type-specific) comparator.

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(java.util.Map<? extends java.lang.Double,? extends V> m)
Creates a new tree map copying a given map.

Parameters:
m - a Map to be copied into the new tree map.

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(java.util.SortedMap<java.lang.Double,V> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:
m - a SortedMap to be copied into the new tree map.

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(Double2ObjectMap<? extends V> m)
Creates a new tree map copying a given map.

Parameters:
m - a type-specific map to be copied into the new tree map.

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(Double2ObjectSortedMap<V> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:
m - a type-specific sorted map to be copied into the new tree map.

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(double[] k,
                              V[] v,
                              java.util.Comparator<? super java.lang.Double> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Parameters:
k - the array of keys of the new tree map.
v - the array of corresponding values in the new tree map.
c - a (possibly type-specific) comparator.
Throws:
java.lang.IllegalArgumentException - if k and v have different lengths.

Double2ObjectRBTreeMap

public Double2ObjectRBTreeMap(double[] k,
                              V[] v)
Creates a new tree map using the elements of two parallel arrays.

Parameters:
k - the array of keys of the new tree map.
v - the array of corresponding values in the new tree map.
Throws:
java.lang.IllegalArgumentException - if k and v have different lengths.
Method Detail

put

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

Specified by:
put in interface Double2ObjectFunction<V>
Overrides:
put in class AbstractDouble2ObjectFunction<V>
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)

remove

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

Specified by:
remove in interface Double2ObjectFunction<V>
Overrides:
remove in class AbstractDouble2ObjectFunction<V>
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

put

public V put(java.lang.Double ok,
             V ov)
Description copied from class: AbstractDouble2ObjectFunction
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,V>
Specified by:
put in interface java.util.Map<java.lang.Double,V>
Overrides:
put in class AbstractDouble2ObjectFunction<V>
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 V remove(java.lang.Object ok)
Description copied from class: AbstractDouble2ObjectFunction
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.Double,V>
Specified by:
remove in interface java.util.Map<java.lang.Double,V>
Overrides:
remove in class AbstractDouble2ObjectFunction<V>
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

containsValue

public boolean containsValue(java.lang.Object v)
Description copied from class: AbstractDouble2ObjectMap
Checks whether the given value is contained in AbstractDouble2ObjectMap.values().

Specified by:
containsValue in interface java.util.Map<java.lang.Double,V>
Overrides:
containsValue in class AbstractDouble2ObjectMap<V>

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

containsKey

public boolean containsKey(double k)
Description copied from class: AbstractDouble2ObjectMap
Checks whether the given value is contained in AbstractDouble2ObjectMap.keySet().

Specified by:
containsKey in interface Double2ObjectFunction<V>
Overrides:
containsKey in class AbstractDouble2ObjectMap<V>
See Also:
Function.containsKey(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>
Specified by:
size in interface java.util.Map<java.lang.Double,V>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

isEmpty

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

get

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

Specified by:
get in interface Double2ObjectFunction<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)

firstDoubleKey

public double firstDoubleKey()
Specified by:
firstDoubleKey in interface Double2ObjectSortedMap<V>
See Also:
SortedMap.firstKey()

lastDoubleKey

public double lastDoubleKey()
Specified by:
lastDoubleKey in interface Double2ObjectSortedMap<V>
See Also:
SortedMap.lastKey()

double2ObjectEntrySet

public ObjectSortedSet<Double2ObjectMap.Entry<V>> double2ObjectEntrySet()
Description copied from interface: Double2ObjectSortedMap
Returns a type-specific sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:
double2ObjectEntrySet in interface Double2ObjectMap<V>
Specified by:
double2ObjectEntrySet in interface Double2ObjectSortedMap<V>
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Double2ObjectSortedMap.entrySet()

keySet

public DoubleSortedSet keySet()
Returns a type-specific sorted set view of the keys contained in this map.

In addition to the semantics of Map.keySet(), you can safely cast the set returned by this call to a type-specific sorted set interface.

Specified by:
keySet in interface Double2ObjectMap<V>
Specified by:
keySet in interface Double2ObjectSortedMap<V>
Specified by:
keySet in interface java.util.Map<java.lang.Double,V>
Specified by:
keySet in interface java.util.SortedMap<java.lang.Double,V>
Overrides:
keySet in class AbstractDouble2ObjectSortedMap<V>
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ObjectCollection<V> values()
Returns a type-specific collection view of the values contained in this map.

In addition to the semantics of Map.values(), you can safely cast the collection returned by this call to a type-specific collection interface.

Specified by:
values in interface Double2ObjectMap<V>
Specified by:
values in interface Double2ObjectSortedMap<V>
Specified by:
values in interface java.util.Map<java.lang.Double,V>
Specified by:
values in interface java.util.SortedMap<java.lang.Double,V>
Overrides:
values in class AbstractDouble2ObjectSortedMap<V>
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

public DoubleComparator comparator()
Description copied from interface: Double2ObjectSortedMap
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Note that this specification strengthens the one given in SortedMap.comparator().

Specified by:
comparator in interface Double2ObjectSortedMap<V>
Specified by:
comparator in interface java.util.SortedMap<java.lang.Double,V>
See Also:
SortedMap.comparator()

headMap

public Double2ObjectSortedMap<V> headMap(double to)
Description copied from interface: Double2ObjectSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Double2ObjectSortedMap<V>
See Also:
SortedMap.headMap(Object)

tailMap

public Double2ObjectSortedMap<V> tailMap(double from)
Description copied from interface: Double2ObjectSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:
tailMap in interface Double2ObjectSortedMap<V>
See Also:
SortedMap.tailMap(Object)

subMap

public Double2ObjectSortedMap<V> subMap(double from,
                                        double to)
Description copied from interface: Double2ObjectSortedMap
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:
subMap in interface Double2ObjectSortedMap<V>
See Also:
SortedMap.subMap(Object,Object)

clone

public Double2ObjectRBTreeMap<V> clone()
Returns a deep copy of this tree map.

This method performs a deep copy of this tree map; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:
clone in class java.lang.Object
Returns:
a deep copy of this tree map.