it.unimi.dsi.fastutil.doubles
Class Double2IntRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2IntFunction
      extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2IntMap
          extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2IntSortedMap
              extended by it.unimi.dsi.fastutil.doubles.Double2IntRBTreeMap
All Implemented Interfaces:
Double2IntFunction, Double2IntMap, Double2IntSortedMap, Function<Double,Integer>, Serializable, Cloneable, Map<Double,Integer>, SortedMap<Double,Integer>

public class Double2IntRBTreeMap
extends AbstractDouble2IntSortedMap
implements Serializable, 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.AbstractDouble2IntMap
AbstractDouble2IntMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2IntSortedMap
Double2IntSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2IntMap
Double2IntMap.FastEntrySet
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Double2IntRBTreeMap()
          Creates a new empty tree map.
Double2IntRBTreeMap(Comparator<? super Double> c)
          Creates a new empty tree map with the given comparator.
Double2IntRBTreeMap(double[] k, int[] v)
          Creates a new tree map using the elements of two parallel arrays.
Double2IntRBTreeMap(double[] k, int[] v, Comparator<? super Double> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Double2IntRBTreeMap(Double2IntMap m)
          Creates a new tree map copying a given map.
Double2IntRBTreeMap(Double2IntSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Double2IntRBTreeMap(Map<? extends Double,? extends Integer> m)
          Creates a new tree map copying a given map.
Double2IntRBTreeMap(SortedMap<Double,Integer> 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).
 Object 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 AbstractDouble2IntMap.keySet().
 boolean containsValue(int v)
          Checks whether the given value is contained in AbstractDouble2IntMap.values().
 ObjectSortedSet<Double2IntMap.Entry> double2IntEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 double firstDoubleKey()
           
 int get(double k)
          Returns the value to which the given key is mapped.
 Double2IntSortedMap 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()
           
 int put(double k, int v)
          Adds a pair to the map.
 Integer put(Double ok, Integer ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int remove(double k)
          Removes the mapping with the given key.
 Integer remove(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.
 Double2IntSortedMap subMap(double from, double to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Double2IntSortedMap tailMap(double from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 IntCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2IntSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2IntMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2IntFunction
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.Double2IntFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Double2IntRBTreeMap

public Double2IntRBTreeMap()
Creates a new empty tree map.


Double2IntRBTreeMap

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

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

Double2IntRBTreeMap

public Double2IntRBTreeMap(Map<? extends Double,? extends Integer> m)
Creates a new tree map copying a given map.

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

Double2IntRBTreeMap

public Double2IntRBTreeMap(SortedMap<Double,Integer> 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.

Double2IntRBTreeMap

public Double2IntRBTreeMap(Double2IntMap m)
Creates a new tree map copying a given map.

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

Double2IntRBTreeMap

public Double2IntRBTreeMap(Double2IntSortedMap 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.

Double2IntRBTreeMap

public Double2IntRBTreeMap(double[] k,
                           int[] v,
                           Comparator<? super 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:
IllegalArgumentException - if k and v have different lengths.

Double2IntRBTreeMap

public Double2IntRBTreeMap(double[] k,
                           int[] 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:
IllegalArgumentException - if k and v have different lengths.
Method Detail

put

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

Specified by:
put in interface Double2IntFunction
Overrides:
put in class AbstractDouble2IntFunction
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 int remove(double k)
Description copied from interface: Double2IntFunction
Removes the mapping with the given key.

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

containsValue

public boolean containsValue(int v)
Description copied from class: AbstractDouble2IntMap
Checks whether the given value is contained in AbstractDouble2IntMap.values().

Specified by:
containsValue in interface Double2IntMap
Overrides:
containsValue in class AbstractDouble2IntMap
See Also:
Map.containsValue(Object)

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<Double,Integer>
Specified by:
clear in interface Map<Double,Integer>
Overrides:
clear in class AbstractDouble2IntFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Double2IntFunction
Overrides:
containsKey in class AbstractDouble2IntMap
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<Double,Integer>
Specified by:
size in interface Map<Double,Integer>
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 Map<Double,Integer>
Overrides:
isEmpty in class AbstractDouble2IntMap

get

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

Specified by:
get in interface Double2IntFunction
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 Double2IntSortedMap
See Also:
SortedMap.firstKey()

lastDoubleKey

public double lastDoubleKey()
Specified by:
lastDoubleKey in interface Double2IntSortedMap
See Also:
SortedMap.lastKey()

double2IntEntrySet

public ObjectSortedSet<Double2IntMap.Entry> double2IntEntrySet()
Description copied from interface: Double2IntMap
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 Double2IntMap.entrySet() so that it returns an ObjectSet of objects of type Double2IntMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
double2IntEntrySet in interface Double2IntMap
Specified by:
double2IntEntrySet in interface Double2IntSortedMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Double2IntMap.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 Double2IntMap
Specified by:
keySet in interface Double2IntSortedMap
Specified by:
keySet in interface Map<Double,Integer>
Overrides:
keySet in class AbstractDouble2IntSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public IntCollection 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 Double2IntMap
Specified by:
values in interface Double2IntSortedMap
Specified by:
values in interface Map<Double,Integer>
Overrides:
values in class AbstractDouble2IntSortedMap
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: Double2IntSortedMap
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 Double2IntSortedMap
Specified by:
comparator in interface SortedMap<Double,Integer>
See Also:
SortedMap.comparator()

headMap

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

Specified by:
headMap in interface Double2IntSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

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

Specified by:
tailMap in interface Double2IntSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

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

Specified by:
subMap in interface Double2IntSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

public Object 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 Object
Returns:
a deep copy of this tree map.