Int2ReferenceAVLTreeMap (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction<V>
- - it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap<V>
  - - it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceSortedMap<V>
    - - it.unimi.dsi.fastutil.ints.Int2ReferenceAVLTreeMap<V>

All Implemented Interfaces:

Function<java.lang.Integer,V>, Int2ReferenceFunction<V>, Int2ReferenceMap<V>, Int2ReferenceSortedMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>
```
public class Int2ReferenceAVLTreeMap<V>
extends AbstractInt2ReferenceSortedMap<V>
implements java.io.Serializable, java.lang.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.ints.AbstractInt2ReferenceMap
  AbstractInt2ReferenceMap.BasicEntry<V>
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceSortedMap
  Int2ReferenceSortedMap.FastSortedEntrySet<V>
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceMap
  Int2ReferenceMap.FastEntrySet<V>

Constructor Summary

Constructors
Constructor and Description
`Int2ReferenceAVLTreeMap()` Creates a new empty tree map.
`Int2ReferenceAVLTreeMap(java.util.Comparator<? super java.lang.Integer> c)` Creates a new empty tree map with the given comparator.
`Int2ReferenceAVLTreeMap(int[] k, V[] v)` Creates a new tree map using the elements of two parallel arrays.
`Int2ReferenceAVLTreeMap(int[] k, V[] v, java.util.Comparator<? super java.lang.Integer> c)` Creates a new tree map using the elements of two parallel arrays and the given comparator.
`Int2ReferenceAVLTreeMap(Int2ReferenceMap<? extends V> m)` Creates a new tree map copying a given map.
`Int2ReferenceAVLTreeMap(Int2ReferenceSortedMap<V> m)` Creates a new tree map copying a given sorted map (and its `Comparator`).
`Int2ReferenceAVLTreeMap(java.util.Map<? extends java.lang.Integer,? extends V> m)` Creates a new tree map copying a given map.
`Int2ReferenceAVLTreeMap(java.util.SortedMap<java.lang.Integer,V> 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
`void`	`clear()` Removes all associations from this function (optional operation).
`Int2ReferenceAVLTreeMap<V>`	`clone()` Returns a deep copy of this tree map.
`IntComparator`	`comparator()` Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
`boolean`	`containsKey(int k)` Checks whether the given value is contained in `AbstractInt2ReferenceMap.keySet()`.
`boolean`	`containsValue(java.lang.Object v)` Checks whether the given value is contained in `AbstractInt2ReferenceMap.values()`.
`int`	`firstIntKey()`
`V`	`get(int k)` Returns the value to which the given key is mapped.
`Int2ReferenceSortedMap<V>`	`headMap(int to)` Returns a view of the portion of this sorted map whose keys are strictly less than `toKey`.
`ObjectSortedSet<Int2ReferenceMap.Entry<V>>`	`int2ReferenceEntrySet()` Returns a type-specific sorted-set view of the mappings contained in this map.
`boolean`	`isEmpty()`
`IntSortedSet`	`keySet()` Returns a type-specific sorted set view of the keys contained in this map.
`int`	`lastIntKey()`
`V`	`put(java.lang.Integer ok, V ov)` Deprecated. Please use the corresponding type-specific method instead.
`V`	`put(int k, V v)` Adds a pair to the map.
`V`	`remove(int k)` Removes the mapping with the given key.
`V`	`remove(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`int`	`size()` Returns the intended number of keys in this function, or -1 if no such number exists.
`Int2ReferenceSortedMap<V>`	`subMap(int from, int to)` Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Int2ReferenceSortedMap<V>`	`tailMap(int from)` Returns a view of the portion of this sorted map whose keys are greater than or equal to `fromKey`.
`ReferenceCollection<V>`	`values()` Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap
equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction
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.ints.Int2ReferenceFunction
defaultReturnValue, defaultReturnValue

Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get

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

- Constructor Detail
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap()
```
    Creates a new empty tree map.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(java.util.Comparator<? super java.lang.Integer> c)
```
    Creates a new empty tree map with the given comparator.
    
    Parameters:
    
    c - a (possibly type-specific) comparator.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(java.util.Map<? extends java.lang.Integer,? extends V> m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a Map to be copied into the new tree map.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(java.util.SortedMap<java.lang.Integer,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.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(Int2ReferenceMap<? 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.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(Int2ReferenceSortedMap<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.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(int[] k,
                               V[] v,
                               java.util.Comparator<? super java.lang.Integer> 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.
  - Int2ReferenceAVLTreeMap
```
public Int2ReferenceAVLTreeMap(int[] 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(int k,
             V v)
```
    Description copied from interface: Int2ReferenceFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Int2ReferenceFunction<V>
    
    Overrides:
    
    put in class AbstractInt2ReferenceFunction<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(int k)
```
    Description copied from interface: Int2ReferenceFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Int2ReferenceFunction<V>
    
    Overrides:
    
    remove in class AbstractInt2ReferenceFunction<V>
    
    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 V put(java.lang.Integer ok,
                         V 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<java.lang.Integer,V>
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Integer,V>
    
    Overrides:
    
    put in class AbstractInt2ReferenceFunction<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
```
@Deprecated
public V 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<java.lang.Integer,V>
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Integer,V>
    
    Overrides:
    
    remove in class AbstractInt2ReferenceFunction<V>
    
    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(java.lang.Object v)
```
    Description copied from class: AbstractInt2ReferenceMap
    
    Checks whether the given value is contained in AbstractInt2ReferenceMap.values().
    
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Integer,V>
    
    Overrides:
    
    containsValue in class AbstractInt2ReferenceMap<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.Integer,V>
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.Integer,V>
    
    Overrides:
    
    clear in class AbstractInt2ReferenceFunction<V>
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(int k)
```
    Description copied from class: AbstractInt2ReferenceMap
    
    Checks whether the given value is contained in AbstractInt2ReferenceMap.keySet().
    
    Specified by:
    
    containsKey in interface Int2ReferenceFunction<V>
    
    Overrides:
    
    containsKey in class AbstractInt2ReferenceMap<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.Integer,V>
    
    Specified by:
    
    size in interface java.util.Map<java.lang.Integer,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.Integer,V>
    
    Overrides:
    
    isEmpty in class AbstractInt2ReferenceMap<V>
  - get
```
public V get(int k)
```
    Description copied from interface: Int2ReferenceFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    get in interface Int2ReferenceFunction<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)
  - firstIntKey
```
public int firstIntKey()
```
    Specified by:
    
    firstIntKey in interface Int2ReferenceSortedMap<V>
    
    See Also:
    
    SortedMap.firstKey()
  - lastIntKey
```
public int lastIntKey()
```
    Specified by:
    
    lastIntKey in interface Int2ReferenceSortedMap<V>
    
    See Also:
    
    SortedMap.lastKey()
  - int2ReferenceEntrySet
```
public ObjectSortedSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
```
    Description copied from interface: Int2ReferenceSortedMap
    
    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:
    
    int2ReferenceEntrySet in interface Int2ReferenceMap<V>
    
    Specified by:
    
    int2ReferenceEntrySet in interface Int2ReferenceSortedMap<V>
    
    Returns:
    
    a type-specific sorted-set view of the mappings contained in this map.
    
    See Also:
    
    Int2ReferenceSortedMap.entrySet()
  - keySet
```
public IntSortedSet 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 Int2ReferenceMap<V>
    
    Specified by:
    
    keySet in interface Int2ReferenceSortedMap<V>
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Integer,V>
    
    Overrides:
    
    keySet in class AbstractInt2ReferenceSortedMap<V>
    
    Returns:
    
    a type-specific sorted set view of the keys contained in this map.
    
    See Also:
    
    Map.keySet()
  - values
```
public ReferenceCollection<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 Int2ReferenceMap<V>
    
    Specified by:
    
    values in interface Int2ReferenceSortedMap<V>
    
    Specified by:
    
    values in interface java.util.Map<java.lang.Integer,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Integer,V>
    
    Overrides:
    
    values in class AbstractInt2ReferenceSortedMap<V>
    
    Returns:
    
    a type-specific collection view of the values contained in this map.
    
    See Also:
    
    Map.values()
  - comparator
```
public IntComparator comparator()
```
    Description copied from interface: Int2ReferenceSortedMap
    
    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 Int2ReferenceSortedMap<V>
    
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Integer,V>
    
    See Also:
    
    SortedMap.comparator()
  - headMap
```
public Int2ReferenceSortedMap<V> headMap(int to)
```
    Description copied from interface: Int2ReferenceSortedMap
    
    Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
    
    Specified by:
    
    headMap in interface Int2ReferenceSortedMap<V>
    
    See Also:
    
    SortedMap.headMap(Object)
  - tailMap
```
public Int2ReferenceSortedMap<V> tailMap(int from)
```
    Description copied from interface: Int2ReferenceSortedMap
    
    Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
    
    Specified by:
    
    tailMap in interface Int2ReferenceSortedMap<V>
    
    See Also:
    
    SortedMap.tailMap(Object)
  - subMap
```
public Int2ReferenceSortedMap<V> subMap(int from,
                                        int to)
```
    Description copied from interface: Int2ReferenceSortedMap
    
    Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
    
    Specified by:
    
    subMap in interface Int2ReferenceSortedMap<V>
    
    See Also:
    
    SortedMap.subMap(Object,Object)
  - clone
```
public Int2ReferenceAVLTreeMap<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.

Class Int2ReferenceAVLTreeMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceSortedMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceMap

Constructor Summary

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceSortedMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceFunction

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

Methods inherited from interface java.util.Map

Constructor Detail

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Int2ReferenceAVLTreeMap

Method Detail

put

remove

put

remove

containsValue

clear

containsKey

size

isEmpty

get

firstIntKey

lastIntKey

int2ReferenceEntrySet

keySet

values

comparator

headMap

tailMap

subMap

clone