Object2DoubleAVLTreeMap (fastutil-reference-char-maps 8.3.1 API)

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.Object2DoubleAVLTreeMap<K>

All Implemented Interfaces:

Object2DoubleFunction<K>, Object2DoubleMap<K>, Object2DoubleSortedMap<K>, Serializable, Cloneable, Function<K,Double>, ToDoubleFunction<K>, Map<K,Double>, SortedMap<K,Double>
```
public class Object2DoubleAVLTreeMap<K>
extends AbstractObject2DoubleSortedMap<K>
implements Serializable, Cloneable
```
A type-specific AVL 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.AbstractObject2DoubleSortedMap
  AbstractObject2DoubleSortedMap.KeySetIterator<K>, AbstractObject2DoubleSortedMap.ValuesCollection, AbstractObject2DoubleSortedMap.ValuesIterator<K>
- Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleMap
  AbstractObject2DoubleMap.BasicEntry<K>, AbstractObject2DoubleMap.BasicEntrySet<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>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Comparator<? super K>`	`actualComparator` This map's actual comparator; it may differ from `storedComparator` because it is always a type-specific comparator, so it could be derived from the former by wrapping.
`protected int`	`count` Number of entries in this map.
`protected ObjectSortedSet<Object2DoubleMap.Entry<K>>`	`entries` Cached set of entries.
`protected it.unimi.dsi.fastutil.objects.Object2DoubleAVLTreeMap.Entry<K>`	`firstEntry` The first key in this map.
`protected ObjectSortedSet<K>`	`keys` Cached set of keys.
`protected it.unimi.dsi.fastutil.objects.Object2DoubleAVLTreeMap.Entry<K>`	`lastEntry` The last key in this map.
`protected boolean`	`modified` The value of this variable remembers, after a `put()` or a `remove()`, whether the domain of the map has been modified.
`protected Comparator<? super K>`	`storedComparator` This map's comparator, as provided in the constructor.
`protected it.unimi.dsi.fastutil.objects.Object2DoubleAVLTreeMap.Entry<K>`	`tree` A reference to the root entry.
`protected DoubleCollection`	`values` Cached collection of values.

Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2DoubleFunction
defRetValue

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete 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 of the mappings from this map (optional operation).
`Object2DoubleAVLTreeMap<K>`	`clone()` Returns a deep copy of this tree map.
`Comparator<? super K>`	`comparator()` Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
`boolean`	`containsKey(Object k)` Returns true if this function contains a mapping for the specified key.
`boolean`	`containsValue(double v)` Returns `true` if this map maps one or more keys to the specified value.
`K`	`firstKey()`
`double`	`getDouble(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 (optional operation).
`double`	`removeDouble(Object k)` Removes the mapping with the given key (optional operation).
`int`	`size()` Returns the number of key/value mappings in this map.
`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.AbstractObject2DoubleMap
equals, hashCode, putAll, toString

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

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

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleSortedMap
entrySet

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2DoubleMap
computeDouble, computeDoubleIfAbsent, computeDoubleIfAbsentPartial, computeDoubleIfPresent, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, getOrDefault, merge, mergeDouble, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

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

Methods inherited from interface it.unimi.dsi.fastutil.Function
apply

Methods inherited from interface java.util.function.Function
andThen, compose, identity

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, hashCode, putAll, replaceAll

- Field Detail
  - tree
```
protected transient it.unimi.dsi.fastutil.objects.Object2DoubleAVLTreeMap.Entry<K> tree
```
    A reference to the root entry.
  - count
```
protected int count
```
    Number of entries in this map.
  - firstEntry
```
protected transient it.unimi.dsi.fastutil.objects.Object2DoubleAVLTreeMap.Entry<K> firstEntry
```
    The first key in this map.
  - lastEntry
```
protected transient it.unimi.dsi.fastutil.objects.Object2DoubleAVLTreeMap.Entry<K> lastEntry
```
    The last key in this map.
  - entries
```
protected transient ObjectSortedSet<Object2DoubleMap.Entry<K>> entries
```
    Cached set of entries.
  - keys
```
protected transient ObjectSortedSet<K> keys
```
    Cached set of keys.
  - values
```
protected transient DoubleCollection values
```
    Cached collection of values.
  - modified
```
protected transient boolean modified
```
    The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.
  - storedComparator
```
protected Comparator<? super K> storedComparator
```
    This map's comparator, as provided in the constructor.
  - actualComparator
```
protected transient Comparator<? super K> actualComparator
```
    This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
- Constructor Detail
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap()
```
    Creates a new empty tree map.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(Comparator<? super K> c)
```
    Creates a new empty tree map with the given comparator.
    
    Parameters:
    
    c - a (possibly type-specific) comparator.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(Map<? extends K,? extends Double> m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a Map to be copied into the new tree map.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(SortedMap<K,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.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(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.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(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.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(K[] k,
                               double[] v,
                               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:
    
    IllegalArgumentException - if k and v have different lengths.
  - Object2DoubleAVLTreeMap
```
public Object2DoubleAVLTreeMap(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:
    
    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 (optional operation).
    
    Specified by:
    
    put in interface Object2DoubleFunction<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(Object k)
```
    Description copied from interface: Object2DoubleFunction
    
    Removes the mapping with the given key (optional operation).
    
    Specified by:
    
    removeDouble in interface Object2DoubleFunction<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)
  - containsValue
```
public boolean containsValue(double v)
```
    Description copied from interface: Object2DoubleMap
    
    Returns true if this map maps one or more keys to the specified value.
    
    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: Object2DoubleMap
    
    Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
    
    Specified by:
    
    clear in interface Object2DoubleMap<K>
    
    Specified by:
    
    clear in interface Map<K,Double>
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(Object k)
```
    Description copied from interface: Object2DoubleMap
    
    Returns true if this function contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface Object2DoubleMap<K>
    
    Specified by:
    
    containsKey in interface Map<K,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: Object2DoubleMap
    
    Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface Object2DoubleMap<K>
    
    Specified by:
    
    size in interface Map<K,Double>
    
    Returns:
    
    the number of key-value mappings in this map.
    
    See Also:
    
    Size64
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<K,Double>
    
    Overrides:
    
    isEmpty in class AbstractObject2DoubleMap<K>
  - getDouble
```
public double getDouble(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)
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface SortedMap<K,Double>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface SortedMap<K,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 Map<K,Double>
    
    Specified by:
    
    keySet in interface SortedMap<K,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 Map<K,Double>
    
    Specified by:
    
    values in interface SortedMap<K,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 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 SortedMap<K,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 SortedMap<K,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 SortedMap<K,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 SortedMap<K,Double>
    
    See Also:
    
    SortedMap.subMap(Object,Object)
  - clone
```
public Object2DoubleAVLTreeMap<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 Object
    
    Returns:
    
    a deep copy of this tree map.

Class Object2DoubleAVLTreeMap<K>

Nested Class Summary

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

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

Field Summary

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

Constructor Summary

Method Summary

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.Object2DoubleSortedMap

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

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

Methods inherited from interface it.unimi.dsi.fastutil.Function

Methods inherited from interface java.util.function.Function

Methods inherited from interface java.util.Map

Field Detail

tree

count

firstEntry

lastEntry

entries

keys

values

modified

storedComparator

actualComparator

Constructor Detail

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Object2DoubleAVLTreeMap

Method Detail

addTo

put

removeDouble

containsValue

clear

containsKey

size

isEmpty

getDouble

firstKey

lastKey

object2DoubleEntrySet

keySet

values

comparator

headMap

tailMap

subMap

clone