it.unimi.dsi.fastutil.chars.Char2ReferenceRBTreeMap<V>

All Implemented Interfaces:: Char2ReferenceFunction<V>, Char2ReferenceMap<V>, Char2ReferenceSortedMap<V>, Function<Character,V>, Serializable, Cloneable, Function<Character,V>, IntFunction<V>, Map<Character,V>, SortedMap<Character,V>

public class Char2ReferenceRBTreeMap<V>
extends AbstractChar2ReferenceSortedMap<V>
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.chars.AbstractChar2ReferenceMap
AbstractChar2ReferenceMap.BasicEntry<V>, AbstractChar2ReferenceMap.BasicEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ReferenceMap
Char2ReferenceMap.FastEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ReferenceSortedMap
Char2ReferenceSortedMap.FastSortedEntrySet<V>

Constructor Summary

Constructors
Constructor	Description
`Char2ReferenceRBTreeMap()`	Creates a new empty tree map.
`Char2ReferenceRBTreeMap(char[] k, V[] v)`	Creates a new tree map using the elements of two parallel arrays.
`Char2ReferenceRBTreeMap(char[] k, V[] v, Comparator<? super Character> c)`	Creates a new tree map using the elements of two parallel arrays and the given comparator.
`Char2ReferenceRBTreeMap(Char2ReferenceMap<? extends V> m)`	Creates a new tree map copying a given map.
`Char2ReferenceRBTreeMap(Char2ReferenceSortedMap<V> m)`	Creates a new tree map copying a given sorted map (and its `Comparator`).
`Char2ReferenceRBTreeMap(Comparator<? super Character> c)`	Creates a new empty tree map with the given comparator.
`Char2ReferenceRBTreeMap(Map<? extends Character,? extends V> m)`	Creates a new tree map copying a given map.
`Char2ReferenceRBTreeMap(SortedMap<Character,V> m)`	Creates a new tree map copying a given sorted map (and its `Comparator`).

Method Summary

Modifier and Type	Method	Description
`ObjectSortedSet<Char2ReferenceMap.Entry<V>>`	`char2ReferenceEntrySet()`	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).
`Char2ReferenceRBTreeMap<V>`	`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)`	Returns true if this function contains a mapping for the specified key.
`boolean`	`containsValue(Object v)`
`char`	`firstCharKey()`	Returns the first (lowest) key currently in this map.
`V`	`get(char k)`	Returns the value to which the given key is mapped.
`Char2ReferenceSortedMap<V>`	`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()`	Returns the last (highest) key currently in this map.
`V`	`put(char k, V v)`	Adds a pair to the map (optional operation).
`V`	`remove(char k)`	Removes the mapping with the given key (optional operation).
`int`	`size()`	Returns the number of key/value mappings in this map.
`Char2ReferenceSortedMap<V>`	`subMap(char from, char to)`	Returns a view of the portion of this sorted map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`Char2ReferenceSortedMap<V>`	`tailMap(char 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.chars.AbstractChar2ReferenceMap

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

apply

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, 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.chars.Char2ReferenceSortedMap

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.Map

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

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

Class Char2ReferenceRBTreeMap<V>

Nested Class Summary

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

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

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