Class Char2ReferenceRBTreeMap<V>
- java.lang.Object
-
- it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceFunction<V>
-
- it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceMap<V>
-
- it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceSortedMap<V>
-
- it.unimi.dsi.fastutil.chars.Char2ReferenceRBTreeMap<V>
-
- All Implemented Interfaces:
Char2ReferenceFunction<V>
,Char2ReferenceMap<V>
,Char2ReferenceSortedMap<V>
,Function<java.lang.Character,V>
,java.io.Serializable
,java.lang.Cloneable
,java.util.function.Function<java.lang.Character,V>
,java.util.function.IntFunction<V>
,java.util.Map<java.lang.Character,V>
,java.util.SortedMap<java.lang.Character,V>
public class Char2ReferenceRBTreeMap<V> extends AbstractChar2ReferenceSortedMap<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.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, java.util.Comparator<? super java.lang.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 itsComparator
).Char2ReferenceRBTreeMap(java.util.Comparator<? super java.lang.Character> c)
Creates a new empty tree map with the given comparator.Char2ReferenceRBTreeMap(java.util.Map<? extends java.lang.Character,? extends V> m)
Creates a new tree map copying a given map.Char2ReferenceRBTreeMap(java.util.SortedMap<java.lang.Character,V> m)
Creates a new tree map copying a given sorted map (and itsComparator
).
-
Method Summary
All Methods Instance Methods Concrete Methods 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(java.lang.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 thantoKey
.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 fromfromKey
, inclusive, totoKey
, exclusive.Char2ReferenceSortedMap<V>
tailMap(char from)
Returns a view of the portion of this sorted map whose keys are greater than or equal tofromKey
.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 interface it.unimi.dsi.fastutil.chars.Char2ReferenceFunction
andThen, andThen, andThen, andThen, andThen, andThen, andThen, andThen, andThen, apply, compose, compose, compose, compose, compose, compose, compose, compose, compose
-
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
-
-
-
-
Constructor Detail
-
Char2ReferenceRBTreeMap
public Char2ReferenceRBTreeMap()
Creates a new empty tree map.
-
Char2ReferenceRBTreeMap
public Char2ReferenceRBTreeMap(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.
-
Char2ReferenceRBTreeMap
public Char2ReferenceRBTreeMap(java.util.Map<? extends java.lang.Character,? extends V> m)
Creates a new tree map copying a given map.- Parameters:
m
- aMap
to be copied into the new tree map.
-
Char2ReferenceRBTreeMap
public Char2ReferenceRBTreeMap(java.util.SortedMap<java.lang.Character,V> m)
Creates a new tree map copying a given sorted map (and itsComparator
).- Parameters:
m
- aSortedMap
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 itsComparator
).- Parameters:
m
- a type-specific sorted map to be copied into the new tree map.
-
Char2ReferenceRBTreeMap
public Char2ReferenceRBTreeMap(char[] k, V[] 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
- ifk
andv
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:
java.lang.IllegalArgumentException
- ifk
andv
have different lengths.
-
-
Method Detail
-
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 interfaceChar2ReferenceFunction<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 interfaceChar2ReferenceFunction<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(java.lang.Object v)
- Specified by:
containsValue
in interfacejava.util.Map<java.lang.Character,V>
- Overrides:
containsValue
in classAbstractChar2ReferenceMap<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.
-
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 interfaceChar2ReferenceFunction<V>
- Specified by:
containsKey
in interfaceChar2ReferenceMap<V>
- Overrides:
containsKey
in classAbstractChar2ReferenceMap<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 thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfacejava.util.Map<java.lang.Character,V>
- Overrides:
isEmpty
in classAbstractChar2ReferenceMap<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 interfaceChar2ReferenceFunction<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 interfaceChar2ReferenceSortedMap<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 interfaceChar2ReferenceSortedMap<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 interfaceChar2ReferenceMap<V>
- Specified by:
char2ReferenceEntrySet
in interfaceChar2ReferenceSortedMap<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 interfaceChar2ReferenceMap<V>
- Specified by:
keySet
in interfaceChar2ReferenceSortedMap<V>
- Specified by:
keySet
in interfacejava.util.Map<java.lang.Character,V>
- Specified by:
keySet
in interfacejava.util.SortedMap<java.lang.Character,V>
- Overrides:
keySet
in classAbstractChar2ReferenceSortedMap<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 interfaceChar2ReferenceMap<V>
- Specified by:
values
in interfaceChar2ReferenceSortedMap<V>
- Specified by:
values
in interfacejava.util.Map<java.lang.Character,V>
- Specified by:
values
in interfacejava.util.SortedMap<java.lang.Character,V>
- Overrides:
values
in classAbstractChar2ReferenceSortedMap<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 interfaceChar2ReferenceSortedMap<V>
- Specified by:
comparator
in interfacejava.util.SortedMap<java.lang.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 thantoKey
.Note that this specification strengthens the one given in
SortedMap.headMap(Object)
.- Specified by:
headMap
in interfaceChar2ReferenceSortedMap<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 tofromKey
.Note that this specification strengthens the one given in
SortedMap.tailMap(Object)
.- Specified by:
tailMap
in interfaceChar2ReferenceSortedMap<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 fromfromKey
, inclusive, totoKey
, exclusive.Note that this specification strengthens the one given in
SortedMap.subMap(Object,Object)
.- Specified by:
subMap
in interfaceChar2ReferenceSortedMap<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.
-
-