it.unimi.dsi.fastutil.ints.Int2ShortRBTreeMap

All Implemented Interfaces:: Function<Integer,Short>, Int2ShortFunction, Int2ShortMap, Int2ShortSortedMap, Serializable, Cloneable, Function<Integer,Short>, IntUnaryOperator, Map<Integer,Short>, SortedMap<Integer,Short>

public class Int2ShortRBTreeMap
extends AbstractInt2ShortSortedMap
implements Serializable, 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.ints.AbstractInt2ShortMap
AbstractInt2ShortMap.BasicEntry, AbstractInt2ShortMap.BasicEntrySet

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

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

Constructor Summary

Constructors
Constructor	Description
`Int2ShortRBTreeMap()`	Creates a new empty tree map.
`Int2ShortRBTreeMap(int[] k, short[] v)`	Creates a new tree map using the elements of two parallel arrays.
`Int2ShortRBTreeMap(int[] k, short[] v, Comparator<? super Integer> c)`	Creates a new tree map using the elements of two parallel arrays and the given comparator.
`Int2ShortRBTreeMap(Int2ShortMap m)`	Creates a new tree map copying a given map.
`Int2ShortRBTreeMap(Int2ShortSortedMap m)`	Creates a new tree map copying a given sorted map (and its `Comparator`).
`Int2ShortRBTreeMap(Comparator<? super Integer> c)`	Creates a new empty tree map with the given comparator.
`Int2ShortRBTreeMap(Map<? extends Integer,? extends Short> m)`	Creates a new tree map copying a given map.
`Int2ShortRBTreeMap(SortedMap<Integer,Short> m)`	Creates a new tree map copying a given sorted map (and its `Comparator`).

Method Summary

Modifier and Type	Method	Description
`short`	`addTo(int k, short incr)`	Adds an increment to value currently associated with a key.
`void`	`clear()`	Removes all of the mappings from this map (optional operation).
`Int2ShortRBTreeMap`	`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)`	Returns true if this function contains a mapping for the specified key.
`boolean`	`containsValue(short v)`	Returns `true` if this map maps one or more keys to the specified value.
`int`	`firstIntKey()`	Returns the first (lowest) key currently in this map.
`short`	`get(int k)`	Returns the value to which the given key is mapped.
`Int2ShortSortedMap`	`headMap(int to)`	Returns a view of the portion of this sorted map whose keys are strictly less than `toKey`.
`ObjectSortedSet<Int2ShortMap.Entry>`	`int2ShortEntrySet()`	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()`	Returns the last (highest) key currently in this map.
`short`	`put(int k, short v)`	Adds a pair to the map (optional operation).
`short`	`remove(int k)`	Removes the mapping with the given key (optional operation).
`int`	`size()`	Returns the number of key/value mappings in this map.
`Int2ShortSortedMap`	`subMap(int from, int to)`	Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Int2ShortSortedMap`	`tailMap(int 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.ints.AbstractInt2ShortMap

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose

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

applyAsInt

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsentNullable, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, getOrDefault, merge, merge, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose

Methods inherited from interface java.util.Map

containsKey, equals, forEach, get, hashCode, put, putAll, remove, replaceAll

Constructor Details
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap()
  
  Creates a new empty tree map.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(Comparator<? super Integer> c)
  
  Creates a new empty tree map with the given comparator.
  
  Parameters:
  
  c - a (possibly type-specific) comparator.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(Map<? extends Integer,? extends Short> m)
  
  Creates a new tree map copying a given map.
  
  Parameters:
  
  m - a Map to be copied into the new tree map.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(SortedMap<Integer,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.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(Int2ShortMap m)
  
  Creates a new tree map copying a given map.
  
  Parameters:
  
  m - a type-specific map to be copied into the new tree map.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(Int2ShortSortedMap 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.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(int[] k, short[] v, Comparator<? super 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:
  
  IllegalArgumentException - if k and v have different lengths.
- Int2ShortRBTreeMap
  
  public Int2ShortRBTreeMap(int[] 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:
  
  IllegalArgumentException - if k and v have different lengths.
Method Details
- addTo
  
  public short addTo(int 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(int k, short v)
  
  Description copied from interface: Int2ShortFunction
  
  Adds a pair to the map (optional operation).
  
  Specified by:
  
  put in interface Int2ShortFunction
  
  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(int k)
  
  Description copied from interface: Int2ShortFunction
  
  Removes the mapping with the given key (optional operation).
  
  Specified by:
  
  remove in interface Int2ShortFunction
  
  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(short v)
  
  Description copied from interface: Int2ShortMap
  
  Returns true if this map maps one or more keys to the specified value.
  
  Specified by:
  
  containsValue in interface Int2ShortMap
  
  Overrides:
  
  containsValue in class AbstractInt2ShortMap
  
  See Also:
  
  Map.containsValue(Object)
- clear
  
  public void clear()
  
  Description copied from interface: Int2ShortMap
  
  Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
  
  Specified by:
  
  clear in interface Function<Integer,Short>
  
  Specified by:
  
  clear in interface Int2ShortMap
  
  Specified by:
  
  clear in interface Map<Integer,Short>
  
  See Also:
  
  Map.clear()
- containsKey
  
  public boolean containsKey(int k)
  
  Description copied from interface: Int2ShortMap
  
  Returns true if this function contains a mapping for the specified key.
  
  Specified by:
  
  containsKey in interface Int2ShortFunction
  
  Specified by:
  
  containsKey in interface Int2ShortMap
  
  Overrides:
  
  containsKey in class AbstractInt2ShortMap
  
  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: Int2ShortMap
  
  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 Function<Integer,Short>
  
  Specified by:
  
  size in interface Int2ShortMap
  
  Specified by:
  
  size in interface Map<Integer,Short>
  
  Returns:
  
  the number of key-value mappings in this map.
  
  See Also:
  
  Size64
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Map<Integer,Short>
  
  Overrides:
  
  isEmpty in class AbstractInt2ShortMap
- get
  
  public short get(int k)
  
  Description copied from interface: Int2ShortFunction
  
  Returns the value to which the given key is mapped.
  
  Specified by:
  
  get in interface Int2ShortFunction
  
  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()
  
  Description copied from interface: Int2ShortSortedMap
  
  Returns the first (lowest) key currently in this map.
  
  Specified by:
  
  firstIntKey in interface Int2ShortSortedMap
  
  See Also:
  
  SortedMap.firstKey()
- lastIntKey
  
  public int lastIntKey()
  
  Description copied from interface: Int2ShortSortedMap
  
  Returns the last (highest) key currently in this map.
  
  Specified by:
  
  lastIntKey in interface Int2ShortSortedMap
  
  See Also:
  
  SortedMap.lastKey()
- int2ShortEntrySet
  
  public ObjectSortedSet<Int2ShortMap.Entry> int2ShortEntrySet()
  
  Description copied from interface: Int2ShortSortedMap
  
  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:
  
  int2ShortEntrySet in interface Int2ShortMap
  
  Specified by:
  
  int2ShortEntrySet in interface Int2ShortSortedMap
  
  Returns:
  
  a type-specific sorted-set view of the mappings contained in this map.
  
  See Also:
  
  Int2ShortSortedMap.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 Int2ShortMap
  
  Specified by:
  
  keySet in interface Int2ShortSortedMap
  
  Specified by:
  
  keySet in interface Map<Integer,Short>
  
  Specified by:
  
  keySet in interface SortedMap<Integer,Short>
  
  Overrides:
  
  keySet in class AbstractInt2ShortSortedMap
  
  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 Int2ShortMap
  
  Specified by:
  
  values in interface Int2ShortSortedMap
  
  Specified by:
  
  values in interface Map<Integer,Short>
  
  Specified by:
  
  values in interface SortedMap<Integer,Short>
  
  Overrides:
  
  values in class AbstractInt2ShortSortedMap
  
  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: Int2ShortSortedMap
  
  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 Int2ShortSortedMap
  
  Specified by:
  
  comparator in interface SortedMap<Integer,Short>
  
  See Also:
  
  SortedMap.comparator()
- headMap
  
  public Int2ShortSortedMap headMap(int to)
  
  Description copied from interface: Int2ShortSortedMap
  
  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 Int2ShortSortedMap
  
  See Also:
  
  SortedMap.headMap(Object)
- tailMap
  
  public Int2ShortSortedMap tailMap(int from)
  
  Description copied from interface: Int2ShortSortedMap
  
  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 Int2ShortSortedMap
  
  See Also:
  
  SortedMap.tailMap(Object)
- subMap
  
  public Int2ShortSortedMap subMap(int from, int to)
  
  Description copied from interface: Int2ShortSortedMap
  
  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 Int2ShortSortedMap
  
  See Also:
  
  SortedMap.subMap(Object,Object)
- clone
  
  public Int2ShortRBTreeMap 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.
  
  Returns:
  
  a deep copy of this tree map.

Class Int2ShortRBTreeMap

Nested Class Summary

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

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

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