Short2ObjectRBTreeMap (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction<V>
- - it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectMap<V>
  - - it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectSortedMap<V>
    - - it.unimi.dsi.fastutil.shorts.Short2ObjectRBTreeMap<V>

All Implemented Interfaces:

Function<java.lang.Short,V>, Short2ObjectFunction<V>, Short2ObjectMap<V>, Short2ObjectSortedMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Short,V>, java.util.SortedMap<java.lang.Short,V>
```
public class Short2ObjectRBTreeMap<V>
extends AbstractShort2ObjectSortedMap<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.shorts.AbstractShort2ObjectMap
  AbstractShort2ObjectMap.BasicEntry<V>
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectSortedMap
  Short2ObjectSortedMap.FastSortedEntrySet<V>
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectMap
  Short2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors
Constructor and Description
`Short2ObjectRBTreeMap()` Creates a new empty tree map.
`Short2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Short> c)` Creates a new empty tree map with the given comparator.
`Short2ObjectRBTreeMap(java.util.Map<? extends java.lang.Short,? extends V> m)` Creates a new tree map copying a given map.
`Short2ObjectRBTreeMap(short[] k, V[] v)` Creates a new tree map using the elements of two parallel arrays.
`Short2ObjectRBTreeMap(short[] k, V[] v, java.util.Comparator<? super java.lang.Short> c)` Creates a new tree map using the elements of two parallel arrays and the given comparator.
`Short2ObjectRBTreeMap(Short2ObjectMap<? extends V> m)` Creates a new tree map copying a given map.
`Short2ObjectRBTreeMap(Short2ObjectSortedMap<V> m)` Creates a new tree map copying a given sorted map (and its `Comparator`).
`Short2ObjectRBTreeMap(java.util.SortedMap<java.lang.Short,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).
`Short2ObjectRBTreeMap<V>`	`clone()` Returns a deep copy of this tree map.
`ShortComparator`	`comparator()` Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
`boolean`	`containsKey(short k)` Checks whether the given value is contained in `AbstractShort2ObjectMap.keySet()`.
`boolean`	`containsValue(java.lang.Object v)` Checks whether the given value is contained in `AbstractShort2ObjectMap.values()`.
`short`	`firstShortKey()`
`V`	`get(short k)` Returns the value to which the given key is mapped.
`Short2ObjectSortedMap<V>`	`headMap(short to)` Returns a view of the portion of this sorted map whose keys are strictly less than `toKey`.
`boolean`	`isEmpty()`
`ShortSortedSet`	`keySet()` Returns a type-specific sorted set view of the keys contained in this map.
`short`	`lastShortKey()`
`V`	`put(short k, V v)` Adds a pair to the map.
`V`	`put(java.lang.Short ok, V ov)` Deprecated. Please use the corresponding type-specific method instead.
`V`	`remove(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`V`	`remove(short k)` Removes the mapping with the given key.
`ObjectSortedSet<Short2ObjectMap.Entry<V>>`	`short2ObjectEntrySet()` Returns a type-specific sorted-set view of the mappings contained in this map.
`int`	`size()` Returns the intended number of keys in this function, or -1 if no such number exists.
`Short2ObjectSortedMap<V>`	`subMap(short from, short to)` Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Short2ObjectSortedMap<V>`	`tailMap(short 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.shorts.AbstractShort2ObjectSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectMap
equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction
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.shorts.Short2ObjectFunction
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
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap()
```
    Creates a new empty tree map.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Short> c)
```
    Creates a new empty tree map with the given comparator.
    
    Parameters:
    
    c - a (possibly type-specific) comparator.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(java.util.Map<? extends java.lang.Short,? extends V> m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a Map to be copied into the new tree map.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(java.util.SortedMap<java.lang.Short,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.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(Short2ObjectMap<? 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.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(Short2ObjectSortedMap<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.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(short[] k,
                             V[] v,
                             java.util.Comparator<? super java.lang.Short> 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.
  - Short2ObjectRBTreeMap
```
public Short2ObjectRBTreeMap(short[] 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(short k,
             V v)
```
    Description copied from interface: Short2ObjectFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Short2ObjectFunction<V>
    
    Overrides:
    
    put in class AbstractShort2ObjectFunction<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(short k)
```
    Description copied from interface: Short2ObjectFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Short2ObjectFunction<V>
    
    Overrides:
    
    remove in class AbstractShort2ObjectFunction<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.Short 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.Short,V>
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Short,V>
    
    Overrides:
    
    put in class AbstractShort2ObjectFunction<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.Short,V>
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Short,V>
    
    Overrides:
    
    remove in class AbstractShort2ObjectFunction<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: AbstractShort2ObjectMap
    
    Checks whether the given value is contained in AbstractShort2ObjectMap.values().
    
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Short,V>
    
    Overrides:
    
    containsValue in class AbstractShort2ObjectMap<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.Short,V>
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.Short,V>
    
    Overrides:
    
    clear in class AbstractShort2ObjectFunction<V>
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(short k)
```
    Description copied from class: AbstractShort2ObjectMap
    
    Checks whether the given value is contained in AbstractShort2ObjectMap.keySet().
    
    Specified by:
    
    containsKey in interface Short2ObjectFunction<V>
    
    Overrides:
    
    containsKey in class AbstractShort2ObjectMap<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.Short,V>
    
    Specified by:
    
    size in interface java.util.Map<java.lang.Short,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.Short,V>
    
    Overrides:
    
    isEmpty in class AbstractShort2ObjectMap<V>
  - get
```
public V get(short k)
```
    Description copied from interface: Short2ObjectFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    get in interface Short2ObjectFunction<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)
  - firstShortKey
```
public short firstShortKey()
```
    Specified by:
    
    firstShortKey in interface Short2ObjectSortedMap<V>
    
    See Also:
    
    SortedMap.firstKey()
  - lastShortKey
```
public short lastShortKey()
```
    Specified by:
    
    lastShortKey in interface Short2ObjectSortedMap<V>
    
    See Also:
    
    SortedMap.lastKey()
  - short2ObjectEntrySet
```
public ObjectSortedSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()
```
    Description copied from interface: Short2ObjectSortedMap
    
    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:
    
    short2ObjectEntrySet in interface Short2ObjectMap<V>
    
    Specified by:
    
    short2ObjectEntrySet in interface Short2ObjectSortedMap<V>
    
    Returns:
    
    a type-specific sorted-set view of the mappings contained in this map.
    
    See Also:
    
    Short2ObjectSortedMap.entrySet()
  - keySet
```
public ShortSortedSet 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 Short2ObjectMap<V>
    
    Specified by:
    
    keySet in interface Short2ObjectSortedMap<V>
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Short,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Short,V>
    
    Overrides:
    
    keySet in class AbstractShort2ObjectSortedMap<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 Short2ObjectMap<V>
    
    Specified by:
    
    values in interface Short2ObjectSortedMap<V>
    
    Specified by:
    
    values in interface java.util.Map<java.lang.Short,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Short,V>
    
    Overrides:
    
    values in class AbstractShort2ObjectSortedMap<V>
    
    Returns:
    
    a type-specific collection view of the values contained in this map.
    
    See Also:
    
    Map.values()
  - comparator
```
public ShortComparator comparator()
```
    Description copied from interface: Short2ObjectSortedMap
    
    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 Short2ObjectSortedMap<V>
    
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Short,V>
    
    See Also:
    
    SortedMap.comparator()
  - headMap
```
public Short2ObjectSortedMap<V> headMap(short to)
```
    Description copied from interface: Short2ObjectSortedMap
    
    Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
    
    Specified by:
    
    headMap in interface Short2ObjectSortedMap<V>
    
    See Also:
    
    SortedMap.headMap(Object)
  - tailMap
```
public Short2ObjectSortedMap<V> tailMap(short from)
```
    Description copied from interface: Short2ObjectSortedMap
    
    Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
    
    Specified by:
    
    tailMap in interface Short2ObjectSortedMap<V>
    
    See Also:
    
    SortedMap.tailMap(Object)
  - subMap
```
public Short2ObjectSortedMap<V> subMap(short from,
                                       short to)
```
    Description copied from interface: Short2ObjectSortedMap
    
    Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
    
    Specified by:
    
    subMap in interface Short2ObjectSortedMap<V>
    
    See Also:
    
    SortedMap.subMap(Object,Object)
  - clone
```
public Short2ObjectRBTreeMap<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 Short2ObjectRBTreeMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectSortedMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectMap

Constructor Summary

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectSortedMap

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectMap

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectFunction

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

Methods inherited from interface java.util.Map

Constructor Detail

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Short2ObjectRBTreeMap

Method Detail

put

remove

put

remove

containsValue

clear

containsKey

size

isEmpty

get

firstShortKey

lastShortKey

short2ObjectEntrySet

keySet

values

comparator

headMap

tailMap

subMap

clone