it.unimi.dsi.fastutil.bytes.Byte2IntRBTreeMap

All Implemented Interfaces:: Byte2IntFunction, Byte2IntMap, Byte2IntSortedMap, Function<Byte,Integer>, Serializable, Cloneable, Function<Byte,Integer>, IntUnaryOperator, Map<Byte,Integer>, SortedMap<Byte,Integer>

public class Byte2IntRBTreeMap
extends AbstractByte2IntSortedMap
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.bytes.AbstractByte2IntMap
AbstractByte2IntMap.BasicEntry, AbstractByte2IntMap.BasicEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntMap
Byte2IntMap.FastEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntSortedMap
Byte2IntSortedMap.FastSortedEntrySet

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`int`	`addTo(byte k, int incr)`	Adds an increment to value currently associated with a key.
`ObjectSortedSet<Byte2IntMap.Entry>`	`byte2IntEntrySet()`	Returns a type-specific sorted-set view of the mappings contained in this map.
`void`	`clear()`	Removes all of the mappings from this map (optional operation).
`Byte2IntRBTreeMap`	`clone()`	Returns a deep copy of this tree map.
`ByteComparator`	`comparator()`	Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
`boolean`	`containsKey(byte k)`	Returns true if this function contains a mapping for the specified key.
`boolean`	`containsValue(int v)`	Returns `true` if this map maps one or more keys to the specified value.
`byte`	`firstByteKey()`	Returns the first (lowest) key currently in this map.
`int`	`get(byte k)`	Returns the value to which the given key is mapped.
`Byte2IntSortedMap`	`headMap(byte to)`	Returns a view of the portion of this sorted map whose keys are strictly less than `toKey`.
`boolean`	`isEmpty()`
`ByteSortedSet`	`keySet()`	Returns a type-specific sorted set view of the keys contained in this map.
`byte`	`lastByteKey()`	Returns the last (highest) key currently in this map.
`int`	`put(byte k, int v)`	Adds a pair to the map (optional operation).
`int`	`remove(byte k)`	Removes the mapping with the given key (optional operation).
`int`	`size()`	Returns the number of key/value mappings in this map.
`Byte2IntSortedMap`	`subMap(byte from, byte to)`	Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Byte2IntSortedMap`	`tailMap(byte from)`	Returns a view of the portion of this sorted map whose keys are greater than or equal to `fromKey`.
`IntCollection`	`values()`	Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2IntMap

equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2IntFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntFunction

applyAsInt

Methods inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntMap

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.bytes.Byte2IntSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose

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
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap()
  
  Creates a new empty tree map.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(Comparator<? super Byte> c)
  
  Creates a new empty tree map with the given comparator.
  
  Parameters:
  
  c - a (possibly type-specific) comparator.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(Map<? extends Byte,? extends Integer> m)
  
  Creates a new tree map copying a given map.
  
  Parameters:
  
  m - a Map to be copied into the new tree map.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(SortedMap<Byte,Integer> 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.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(Byte2IntMap m)
  
  Creates a new tree map copying a given map.
  
  Parameters:
  
  m - a type-specific map to be copied into the new tree map.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(Byte2IntSortedMap 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.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(byte[] k, int[] v, Comparator<? super Byte> 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.
- Byte2IntRBTreeMap
  
  public Byte2IntRBTreeMap(byte[] k, int[] 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 int addTo(byte k, int 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 int put(byte k, int v)
  
  Description copied from interface: Byte2IntFunction
  
  Adds a pair to the map (optional operation).
  
  Specified by:
  
  put in interface Byte2IntFunction
  
  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 int remove(byte k)
  
  Description copied from interface: Byte2IntFunction
  
  Removes the mapping with the given key (optional operation).
  
  Specified by:
  
  remove in interface Byte2IntFunction
  
  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(int v)
  
  Description copied from interface: Byte2IntMap
  
  Returns true if this map maps one or more keys to the specified value.
  
  Specified by:
  
  containsValue in interface Byte2IntMap
  
  Overrides:
  
  containsValue in class AbstractByte2IntMap
  
  See Also:
  
  Map.containsValue(Object)
- clear
  
  public void clear()
  
  Description copied from interface: Byte2IntMap
  
  Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
  
  Specified by:
  
  clear in interface Byte2IntMap
  
  Specified by:
  
  clear in interface Function<Byte,Integer>
  
  Specified by:
  
  clear in interface Map<Byte,Integer>
  
  See Also:
  
  Map.clear()
- containsKey
  
  public boolean containsKey(byte k)
  
  Description copied from interface: Byte2IntMap
  
  Returns true if this function contains a mapping for the specified key.
  
  Specified by:
  
  containsKey in interface Byte2IntFunction
  
  Specified by:
  
  containsKey in interface Byte2IntMap
  
  Overrides:
  
  containsKey in class AbstractByte2IntMap
  
  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: Byte2IntMap
  
  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 Byte2IntMap
  
  Specified by:
  
  size in interface Function<Byte,Integer>
  
  Specified by:
  
  size in interface Map<Byte,Integer>
  
  Returns:
  
  the number of key-value mappings in this map.
  
  See Also:
  
  Size64
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Map<Byte,Integer>
  
  Overrides:
  
  isEmpty in class AbstractByte2IntMap
- get
  
  public int get(byte k)
  
  Description copied from interface: Byte2IntFunction
  
  Returns the value to which the given key is mapped.
  
  Specified by:
  
  get in interface Byte2IntFunction
  
  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)
- firstByteKey
  
  public byte firstByteKey()
  
  Description copied from interface: Byte2IntSortedMap
  
  Returns the first (lowest) key currently in this map.
  
  Specified by:
  
  firstByteKey in interface Byte2IntSortedMap
  
  See Also:
  
  SortedMap.firstKey()
- lastByteKey
  
  public byte lastByteKey()
  
  Description copied from interface: Byte2IntSortedMap
  
  Returns the last (highest) key currently in this map.
  
  Specified by:
  
  lastByteKey in interface Byte2IntSortedMap
  
  See Also:
  
  SortedMap.lastKey()
- byte2IntEntrySet
  
  public ObjectSortedSet<Byte2IntMap.Entry> byte2IntEntrySet()
  
  Description copied from interface: Byte2IntSortedMap
  
  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:
  
  byte2IntEntrySet in interface Byte2IntMap
  
  Specified by:
  
  byte2IntEntrySet in interface Byte2IntSortedMap
  
  Returns:
  
  a type-specific sorted-set view of the mappings contained in this map.
  
  See Also:
  
  Byte2IntSortedMap.entrySet()
- keySet
  
  public ByteSortedSet 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 Byte2IntMap
  
  Specified by:
  
  keySet in interface Byte2IntSortedMap
  
  Specified by:
  
  keySet in interface Map<Byte,Integer>
  
  Specified by:
  
  keySet in interface SortedMap<Byte,Integer>
  
  Overrides:
  
  keySet in class AbstractByte2IntSortedMap
  
  Returns:
  
  a type-specific sorted set view of the keys contained in this map.
  
  See Also:
  
  Map.keySet()
- values
  
  public IntCollection 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 Byte2IntMap
  
  Specified by:
  
  values in interface Byte2IntSortedMap
  
  Specified by:
  
  values in interface Map<Byte,Integer>
  
  Specified by:
  
  values in interface SortedMap<Byte,Integer>
  
  Overrides:
  
  values in class AbstractByte2IntSortedMap
  
  Returns:
  
  a type-specific collection view of the values contained in this map.
  
  See Also:
  
  Map.values()
- comparator
  
  public ByteComparator comparator()
  
  Description copied from interface: Byte2IntSortedMap
  
  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 Byte2IntSortedMap
  
  Specified by:
  
  comparator in interface SortedMap<Byte,Integer>
  
  See Also:
  
  SortedMap.comparator()
- headMap
  
  public Byte2IntSortedMap headMap(byte to)
  
  Description copied from interface: Byte2IntSortedMap
  
  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 Byte2IntSortedMap
  
  See Also:
  
  SortedMap.headMap(Object)
- tailMap
  
  public Byte2IntSortedMap tailMap(byte from)
  
  Description copied from interface: Byte2IntSortedMap
  
  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 Byte2IntSortedMap
  
  See Also:
  
  SortedMap.tailMap(Object)
- subMap
  
  public Byte2IntSortedMap subMap(byte from, byte to)
  
  Description copied from interface: Byte2IntSortedMap
  
  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 Byte2IntSortedMap
  
  See Also:
  
  SortedMap.subMap(Object,Object)
- clone
  
  public Byte2IntRBTreeMap 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 Byte2IntRBTreeMap

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2IntMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntMap

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntSortedMap