Char2ShortRBTreeMap (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.chars.AbstractChar2ShortFunction
- - it.unimi.dsi.fastutil.chars.AbstractChar2ShortMap
  - - it.unimi.dsi.fastutil.chars.AbstractChar2ShortSortedMap
    - - it.unimi.dsi.fastutil.chars.Char2ShortRBTreeMap

All Implemented Interfaces:

Char2ShortFunction, Char2ShortMap, Char2ShortSortedMap, Function<java.lang.Character,java.lang.Short>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Character,java.lang.Short>, java.util.SortedMap<java.lang.Character,java.lang.Short>
```
public class Char2ShortRBTreeMap
extends AbstractChar2ShortSortedMap
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.chars.AbstractChar2ShortMap
  AbstractChar2ShortMap.BasicEntry
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ShortSortedMap
  Char2ShortSortedMap.FastSortedEntrySet
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ShortMap
  Char2ShortMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Char2ShortRBTreeMap()` Creates a new empty tree map.
`Char2ShortRBTreeMap(char[] k, short[] v)` Creates a new tree map using the elements of two parallel arrays.
`Char2ShortRBTreeMap(char[] k, short[] v, java.util.Comparator<? super java.lang.Character> c)` Creates a new tree map using the elements of two parallel arrays and the given comparator.
`Char2ShortRBTreeMap(Char2ShortMap m)` Creates a new tree map copying a given map.
`Char2ShortRBTreeMap(Char2ShortSortedMap m)` Creates a new tree map copying a given sorted map (and its `Comparator`).
`Char2ShortRBTreeMap(java.util.Comparator<? super java.lang.Character> c)` Creates a new empty tree map with the given comparator.
`Char2ShortRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> m)` Creates a new tree map copying a given map.
`Char2ShortRBTreeMap(java.util.SortedMap<java.lang.Character,java.lang.Short> 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
`short`	`addTo(char k, short incr)` Adds an increment to value currently associated with a key.
`ObjectSortedSet<Char2ShortMap.Entry>`	`char2ShortEntrySet()` Returns a type-specific sorted-set view of the mappings contained in this map.
`void`	`clear()` Removes all associations from this function (optional operation).
`Char2ShortRBTreeMap`	`clone()` Returns a deep copy of this tree map.
`CharComparator`	`comparator()` Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
`boolean`	`containsKey(char k)` Checks whether the given value is contained in `AbstractChar2ShortMap.keySet()`.
`boolean`	`containsValue(short v)` Checks whether the given value is contained in `AbstractChar2ShortMap.values()`.
`char`	`firstCharKey()`
`short`	`get(char k)` Returns the value to which the given key is mapped.
`Char2ShortSortedMap`	`headMap(char to)` Returns a view of the portion of this sorted map whose keys are strictly less than `toKey`.
`boolean`	`isEmpty()`
`CharSortedSet`	`keySet()` Returns a type-specific sorted set view of the keys contained in this map.
`char`	`lastCharKey()`
`java.lang.Short`	`put(java.lang.Character ok, java.lang.Short ov)` Deprecated. Please use the corresponding type-specific method instead.
`short`	`put(char k, short v)` Adds a pair to the map.
`short`	`remove(char k)` Removes the mapping with the given key.
`java.lang.Short`	`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.
`Char2ShortSortedMap`	`subMap(char from, char to)` Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Char2ShortSortedMap`	`tailMap(char from)` Returns a view of the portion of this sorted map whose keys are greater than or equal to `fromKey`.
`ShortCollection`	`values()` Returns a type-specific collection view of the values contained in this map.

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

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ShortMap
containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ShortFunction
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.chars.Char2ShortFunction
defaultReturnValue, defaultReturnValue

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

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

- Constructor Detail
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap()
```
    Creates a new empty tree map.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.util.Comparator<? super java.lang.Character> c)
```
    Creates a new empty tree map with the given comparator.
    
    Parameters:
    
    c - a (possibly type-specific) comparator.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a Map to be copied into the new tree map.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(java.util.SortedMap<java.lang.Character,java.lang.Short> 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.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(Char2ShortMap m)
```
    Creates a new tree map copying a given map.
    
    Parameters:
    
    m - a type-specific map to be copied into the new tree map.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(Char2ShortSortedMap 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.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(char[] k,
                           short[] v,
                           java.util.Comparator<? super java.lang.Character> 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.
  - Char2ShortRBTreeMap
```
public Char2ShortRBTreeMap(char[] k,
                           short[] 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 short addTo(char k,
                   short 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 short put(char k,
                 short v)
```
    Description copied from interface: Char2ShortFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Char2ShortFunction
    
    Overrides:
    
    put in class AbstractChar2ShortFunction
    
    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 short remove(char k)
```
    Description copied from interface: Char2ShortFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Char2ShortFunction
    
    Overrides:
    
    remove in class AbstractChar2ShortFunction
    
    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.Short put(java.lang.Character ok,
                                       java.lang.Short 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.Character,java.lang.Short>
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    put in class AbstractChar2ShortFunction
    
    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.Short 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.Character,java.lang.Short>
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    remove in class AbstractChar2ShortFunction
    
    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(short v)
```
    Description copied from class: AbstractChar2ShortMap
    
    Checks whether the given value is contained in AbstractChar2ShortMap.values().
    
    Specified by:
    
    containsValue in interface Char2ShortMap
    
    Overrides:
    
    containsValue in class AbstractChar2ShortMap
    
    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<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    clear in class AbstractChar2ShortFunction
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(char k)
```
    Description copied from class: AbstractChar2ShortMap
    
    Checks whether the given value is contained in AbstractChar2ShortMap.keySet().
    
    Specified by:
    
    containsKey in interface Char2ShortFunction
    
    Overrides:
    
    containsKey in class AbstractChar2ShortMap
    
    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.Character,java.lang.Short>
    
    Specified by:
    
    size in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    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.Character,java.lang.Short>
    
    Overrides:
    
    isEmpty in class AbstractChar2ShortMap
  - get
```
public short get(char k)
```
    Description copied from interface: Char2ShortFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    get in interface Char2ShortFunction
    
    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)
  - firstCharKey
```
public char firstCharKey()
```
    Specified by:
    
    firstCharKey in interface Char2ShortSortedMap
    
    See Also:
    
    SortedMap.firstKey()
  - lastCharKey
```
public char lastCharKey()
```
    Specified by:
    
    lastCharKey in interface Char2ShortSortedMap
    
    See Also:
    
    SortedMap.lastKey()
  - char2ShortEntrySet
```
public ObjectSortedSet<Char2ShortMap.Entry> char2ShortEntrySet()
```
    Description copied from interface: Char2ShortSortedMap
    
    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:
    
    char2ShortEntrySet in interface Char2ShortMap
    
    Specified by:
    
    char2ShortEntrySet in interface Char2ShortSortedMap
    
    Returns:
    
    a type-specific sorted-set view of the mappings contained in this map.
    
    See Also:
    
    Char2ShortSortedMap.entrySet()
  - keySet
```
public CharSortedSet 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 Char2ShortMap
    
    Specified by:
    
    keySet in interface Char2ShortSortedMap
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    keySet in class AbstractChar2ShortSortedMap
    
    Returns:
    
    a type-specific sorted set view of the keys contained in this map.
    
    See Also:
    
    Map.keySet()
  - values
```
public ShortCollection 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 Char2ShortMap
    
    Specified by:
    
    values in interface Char2ShortSortedMap
    
    Specified by:
    
    values in interface java.util.Map<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    Overrides:
    
    values in class AbstractChar2ShortSortedMap
    
    Returns:
    
    a type-specific collection view of the values contained in this map.
    
    See Also:
    
    Map.values()
  - comparator
```
public CharComparator comparator()
```
    Description copied from interface: Char2ShortSortedMap
    
    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 Char2ShortSortedMap
    
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    See Also:
    
    SortedMap.comparator()
  - headMap
```
public Char2ShortSortedMap headMap(char to)
```
    Description copied from interface: Char2ShortSortedMap
    
    Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
    
    Specified by:
    
    headMap in interface Char2ShortSortedMap
    
    See Also:
    
    SortedMap.headMap(Object)
  - tailMap
```
public Char2ShortSortedMap tailMap(char from)
```
    Description copied from interface: Char2ShortSortedMap
    
    Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
    
    Specified by:
    
    tailMap in interface Char2ShortSortedMap
    
    See Also:
    
    SortedMap.tailMap(Object)
  - subMap
```
public Char2ShortSortedMap subMap(char from,
                                  char to)
```
    Description copied from interface: Char2ShortSortedMap
    
    Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
    
    Specified by:
    
    subMap in interface Char2ShortSortedMap
    
    See Also:
    
    SortedMap.subMap(Object,Object)
  - clone
```
public Char2ShortRBTreeMap 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 Char2ShortRBTreeMap

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ShortMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ShortSortedMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ShortMap

Constructor Summary

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ShortSortedMap

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ShortMap

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ShortFunction

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ShortFunction

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

Methods inherited from interface java.util.Map

Constructor Detail

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Char2ShortRBTreeMap

Method Detail

addTo

put

remove

put

remove

containsValue

clear

containsKey

size

isEmpty

get

firstCharKey

lastCharKey

char2ShortEntrySet

keySet

values

comparator

headMap

tailMap

subMap

clone