Object2DoubleRBTreeMap (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.objects.AbstractObject2DoubleFunction<K>
- - it.unimi.dsi.fastutil.objects.AbstractObject2DoubleMap<K>
  - - it.unimi.dsi.fastutil.objects.AbstractObject2DoubleSortedMap<K>
    - - it.unimi.dsi.fastutil.objects.Object2DoubleRBTreeMap<K>

All Implemented Interfaces:

Function<K,java.lang.Double>, Object2DoubleFunction<K>, Object2DoubleMap<K>, Object2DoubleSortedMap<K>, java.io.Serializable, java.lang.Cloneable, java.util.Map<K,java.lang.Double>, java.util.SortedMap<K,java.lang.Double>
```
public class Object2DoubleRBTreeMap<K>
extends AbstractObject2DoubleSortedMap<K>
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.objects.AbstractObject2DoubleMap
  AbstractObject2DoubleMap.BasicEntry<K>
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleSortedMap
  Object2DoubleSortedMap.FastSortedEntrySet<K>
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleMap
  Object2DoubleMap.FastEntrySet<K>

Constructor Summary

Constructors
Constructor and Description
`Object2DoubleRBTreeMap()` Creates a new empty tree map.
`Object2DoubleRBTreeMap(java.util.Comparator<? super K> c)` Creates a new empty tree map with the given comparator.
`Object2DoubleRBTreeMap(K[] k, double[] v)` Creates a new tree map using the elements of two parallel arrays.
`Object2DoubleRBTreeMap(K[] k, double[] v, java.util.Comparator<? super K> c)` Creates a new tree map using the elements of two parallel arrays and the given comparator.
`Object2DoubleRBTreeMap(java.util.Map<? extends K,? extends java.lang.Double> m)` Creates a new tree map copying a given map.
`Object2DoubleRBTreeMap(Object2DoubleMap<? extends K> m)` Creates a new tree map copying a given map.
`Object2DoubleRBTreeMap(Object2DoubleSortedMap<K> m)` Creates a new tree map copying a given sorted map (and its `Comparator`).
`Object2DoubleRBTreeMap(java.util.SortedMap<K,java.lang.Double> m)` Creates a new tree map copying a given sorted map (and its `Comparator`).

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`double`	`addTo(K k, double incr)` Adds an increment to value currently associated with a key.
`void`	`clear()` Removes all associations from this function (optional operation).
`Object2DoubleRBTreeMap<K>`	`clone()` Returns a deep copy of this tree map.
`java.util.Comparator<? super K>`	`comparator()` Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
`boolean`	`containsKey(java.lang.Object k)` Checks whether the given value is contained in `AbstractObject2DoubleMap.keySet()`.
`boolean`	`containsValue(double v)` Checks whether the given value is contained in `AbstractObject2DoubleMap.values()`.
`K`	`firstKey()`
`java.lang.Double`	`get(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`double`	`getDouble(java.lang.Object k)` Returns the value to which the given key is mapped.
`Object2DoubleSortedMap<K>`	`headMap(K to)` Returns a view of the portion of this sorted map whose keys are strictly less than `toKey`.
`boolean`	`isEmpty()`
`ObjectSortedSet<K>`	`keySet()` Returns a type-specific sorted set view of the keys contained in this map.
`K`	`lastKey()`
`ObjectSortedSet<Object2DoubleMap.Entry<K>>`	`object2DoubleEntrySet()` Returns a type-specific sorted-set view of the mappings contained in this map.
`double`	`put(K k, double v)` Adds a pair to the map.
`java.lang.Double`	`put(K ok, java.lang.Double ov)` Deprecated. Please use the corresponding type-specific method instead.
`java.lang.Double`	`remove(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`double`	`removeDouble(java.lang.Object 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.
`Object2DoubleSortedMap<K>`	`subMap(K from, K to)` Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Object2DoubleSortedMap<K>`	`tailMap(K from)` Returns a view of the portion of this sorted map whose keys are greater than or equal to `fromKey`.
`DoubleCollection`	`values()` Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleSortedMap
entrySet

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleMap
containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleFunction
defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleFunction
defaultReturnValue, defaultReturnValue

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, getOrDefault, hashCode, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap()
```
    Creates a new empty tree map.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(java.util.Comparator<? super K> c)
```
    Creates a new empty tree map with the given comparator.
    
    Parameters:
    
    c - a (possibly type-specific) comparator.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(java.util.Map<? extends K,? extends java.lang.Double> m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a Map to be copied into the new tree map.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(java.util.SortedMap<K,java.lang.Double> 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.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(Object2DoubleMap<? extends K> m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a type-specific map to be copied into the new tree map.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(Object2DoubleSortedMap<K> 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.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(K[] k,
                              double[] v,
                              java.util.Comparator<? super K> 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.
  - Object2DoubleRBTreeMap
```
public Object2DoubleRBTreeMap(K[] k,
                              double[] 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
  - addTo
```
public double addTo(K k,
                    double incr)
```
    Adds an increment to value currently associated with a key.
    Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.
    
    Parameters:
    
    k - the key.
    
    incr - the increment.
    
    Returns:
    
    the old value, or the default return value if no value was present for the given key.
  - put
```
public double put(K k,
                  double v)
```
    Description copied from interface: Object2DoubleFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Object2DoubleFunction<K>
    
    Overrides:
    
    put in class AbstractObject2DoubleFunction<K>
    
    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)
  - removeDouble
```
public double removeDouble(java.lang.Object k)
```
    Description copied from interface: Object2DoubleFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    removeDouble in interface Object2DoubleFunction<K>
    
    Overrides:
    
    removeDouble in class AbstractObject2DoubleFunction<K>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    the old value, or the default return value if no value was present for the given key.
    
    See Also:
    
    Function.remove(Object)
  - put
```
@Deprecated
public java.lang.Double put(K ok,
                                        java.lang.Double ov)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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<K,java.lang.Double>
    
    Specified by:
    
    put in interface java.util.Map<K,java.lang.Double>
    
    Overrides:
    
    put in class AbstractObject2DoubleFunction<K>
    
    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
```
@Deprecated
public java.lang.Double remove(java.lang.Object ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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<K,java.lang.Double>
    
    Specified by:
    
    remove in interface java.util.Map<K,java.lang.Double>
    
    Overrides:
    
    remove in class AbstractObject2DoubleFunction<K>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.remove(Object)
  - containsValue
```
public boolean containsValue(double v)
```
    Description copied from class: AbstractObject2DoubleMap
    
    Checks whether the given value is contained in AbstractObject2DoubleMap.values().
    
    Specified by:
    
    containsValue in interface Object2DoubleMap<K>
    
    Overrides:
    
    containsValue in class AbstractObject2DoubleMap<K>
    
    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<K,java.lang.Double>
    
    Specified by:
    
    clear in interface java.util.Map<K,java.lang.Double>
    
    Overrides:
    
    clear in class AbstractObject2DoubleFunction<K>
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(java.lang.Object k)
```
    Description copied from class: AbstractObject2DoubleMap
    
    Checks whether the given value is contained in AbstractObject2DoubleMap.keySet().
    
    Specified by:
    
    containsKey in interface Function<K,java.lang.Double>
    
    Specified by:
    
    containsKey in interface java.util.Map<K,java.lang.Double>
    
    Overrides:
    
    containsKey in class AbstractObject2DoubleMap<K>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.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<K,java.lang.Double>
    
    Specified by:
    
    size in interface java.util.Map<K,java.lang.Double>
    
    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<K,java.lang.Double>
    
    Overrides:
    
    isEmpty in class AbstractObject2DoubleMap<K>
  - getDouble
```
public double getDouble(java.lang.Object k)
```
    Description copied from interface: Object2DoubleFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    getDouble in interface Object2DoubleFunction<K>
    
    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)
  - get
```
@Deprecated
public java.lang.Double get(java.lang.Object ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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<K,java.lang.Double>
    
    Specified by:
    
    get in interface java.util.Map<K,java.lang.Double>
    
    Overrides:
    
    get in class AbstractObject2DoubleFunction<K>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<K,java.lang.Double>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<K,java.lang.Double>
  - object2DoubleEntrySet
```
public ObjectSortedSet<Object2DoubleMap.Entry<K>> object2DoubleEntrySet()
```
    Description copied from interface: Object2DoubleSortedMap
    
    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:
    
    object2DoubleEntrySet in interface Object2DoubleMap<K>
    
    Specified by:
    
    object2DoubleEntrySet in interface Object2DoubleSortedMap<K>
    
    Returns:
    
    a type-specific sorted-set view of the mappings contained in this map.
    
    See Also:
    
    Object2DoubleSortedMap.entrySet()
  - keySet
```
public ObjectSortedSet<K> 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 Object2DoubleMap<K>
    
    Specified by:
    
    keySet in interface Object2DoubleSortedMap<K>
    
    Specified by:
    
    keySet in interface java.util.Map<K,java.lang.Double>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<K,java.lang.Double>
    
    Overrides:
    
    keySet in class AbstractObject2DoubleSortedMap<K>
    
    Returns:
    
    a type-specific sorted set view of the keys contained in this map.
    
    See Also:
    
    Map.keySet()
  - values
```
public DoubleCollection 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 Object2DoubleMap<K>
    
    Specified by:
    
    values in interface Object2DoubleSortedMap<K>
    
    Specified by:
    
    values in interface java.util.Map<K,java.lang.Double>
    
    Specified by:
    
    values in interface java.util.SortedMap<K,java.lang.Double>
    
    Overrides:
    
    values in class AbstractObject2DoubleSortedMap<K>
    
    Returns:
    
    a type-specific collection view of the values contained in this map.
    
    See Also:
    
    Map.values()
  - comparator
```
public java.util.Comparator<? super K> comparator()
```
    Description copied from interface: Object2DoubleSortedMap
    
    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 Object2DoubleSortedMap<K>
    
    Specified by:
    
    comparator in interface java.util.SortedMap<K,java.lang.Double>
    
    See Also:
    
    SortedMap.comparator()
  - headMap
```
public Object2DoubleSortedMap<K> headMap(K to)
```
    Description copied from interface: Object2DoubleSortedMap
    
    Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
    Note that this specification strengthens the one given in SortedMap.headMap(Object).
    
    Specified by:
    
    headMap in interface Object2DoubleSortedMap<K>
    
    Specified by:
    
    headMap in interface java.util.SortedMap<K,java.lang.Double>
    
    See Also:
    
    SortedMap.headMap(Object)
  - tailMap
```
public Object2DoubleSortedMap<K> tailMap(K from)
```
    Description copied from interface: Object2DoubleSortedMap
    
    Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
    Note that this specification strengthens the one given in SortedMap.tailMap(Object).
    
    Specified by:
    
    tailMap in interface Object2DoubleSortedMap<K>
    
    Specified by:
    
    tailMap in interface java.util.SortedMap<K,java.lang.Double>
    
    See Also:
    
    SortedMap.tailMap(Object)
  - subMap
```
public Object2DoubleSortedMap<K> subMap(K from,
                                        K to)
```
    Description copied from interface: Object2DoubleSortedMap
    
    Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
    Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).
    
    Specified by:
    
    subMap in interface Object2DoubleSortedMap<K>
    
    Specified by:
    
    subMap in interface java.util.SortedMap<K,java.lang.Double>
    
    See Also:
    
    SortedMap.subMap(Object,Object)
  - clone
```
public Object2DoubleRBTreeMap<K> 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.

Class Object2DoubleRBTreeMap<K>

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleSortedMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleMap

Constructor Summary

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleSortedMap

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleMap

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleFunction

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleFunction

Methods inherited from interface java.util.Map

Constructor Detail

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Object2DoubleRBTreeMap

Method Detail

addTo

put

removeDouble

put

remove

containsValue

clear

containsKey

size

isEmpty

getDouble

get

firstKey

lastKey

object2DoubleEntrySet

keySet

values

comparator

headMap

tailMap

subMap

clone