Class Char2ObjectRBTreeMap<V>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Char2ObjectFunction<V>, Char2ObjectMap<V>, Char2ObjectSortedMap<V>, Function<Character, V>, Serializable, Cloneable, Function<Character, V>, IntFunction<V>, Map<Character, V>, SequencedMap<Character, V>, SortedMap<Character, V>

public class Char2ObjectRBTreeMap<V>
extends AbstractChar2ObjectSortedMap<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.AbstractChar2ObjectMap

AbstractChar2ObjectMap.BasicEntry<V>, AbstractChar2ObjectMap.BasicEntrySet<V>

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

Char2ObjectMap.FastEntrySet<V>

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

Char2ObjectSortedMap.FastSortedEntrySet<V>

Constructor Summary

Constructors

Constructor	Description
Char2ObjectRBTreeMap()	Creates a new empty tree map.
Char2ObjectRBTreeMap(char[] k, V[] v)	Creates a new tree map using the elements of two parallel arrays.
Char2ObjectRBTreeMap(char[] k, V[] v, Comparator<? super Character> c)	Creates a new tree map using the elements of two parallel arrays and the given comparator.
Char2ObjectRBTreeMap(Char2ObjectMap<? extends V> m)	Creates a new tree map copying a given map.
Char2ObjectRBTreeMap(Char2ObjectSortedMap<V> m)	Creates a new tree map copying a given sorted map (and its Comparator).
Char2ObjectRBTreeMap(Comparator<? super Character> c)	Creates a new empty tree map with the given comparator.
Char2ObjectRBTreeMap(Map<? extends Character, ? extends V> m)	Creates a new tree map copying a given map.
Char2ObjectRBTreeMap(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<Char2ObjectMap.Entry<V>>	char2ObjectEntrySet()	Returns a type-specific set view of the mappings contained in this map.
void	clear()	Removes all associations from this function (optional operation).
Char2ObjectRBTreeMap<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.
Char2ObjectSortedMap<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 intended number of keys in this function, or -1 if no such number exists.
Char2ObjectSortedMap<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.
Char2ObjectSortedMap<V>	tailMap(char from)	Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ObjectCollection<V>	values()	Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

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

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

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

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, get, getOrDefault, hashCode, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

putFirst, putLast, reversed

Constructor Details

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap()

Creates a new empty tree map.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(Comparator<? super Character> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(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.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(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.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(Char2ObjectMap<? 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.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(Char2ObjectSortedMap<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.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(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.

Char2ObjectRBTreeMap

public Char2ObjectRBTreeMap(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: Char2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Char2ObjectFunction<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: Char2ObjectFunction

Removes the mapping with the given key (optional operation).

Specified by:

remove in interface Char2ObjectFunction<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)

Description copied from class: AbstractChar2ObjectMap

Specified by:

containsValue in interface Map<Character, V>

Overrides:

containsValue in class AbstractChar2ObjectMap<V>

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Char2ObjectMap<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 class: AbstractChar2ObjectMap

Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true. In particular, this default implementation always returns true.

Specified by:

containsKey in interface Char2ObjectFunction<V>

Specified by:

containsKey in interface Char2ObjectMap<V>

Overrides:

containsKey in class AbstractChar2ObjectMap<V>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

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. This default implementation, in particular, returns -1.

Specified by:

size in interface Char2ObjectMap<V>

Specified by:

size in interface Function<Character, V>

Specified by:

size in interface Map<Character, V>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

See Also:

• Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character, V>

Overrides:

isEmpty in class AbstractChar2ObjectMap<V>

get

public V get(char k)

Description copied from interface: Char2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2ObjectFunction<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: Char2ObjectSortedMap

Returns the first (lowest) key currently in this map.

Specified by:

firstCharKey in interface Char2ObjectSortedMap<V>

See Also:

• SortedMap.firstKey()

lastCharKey

public char lastCharKey()

Description copied from interface: Char2ObjectSortedMap

Returns the last (highest) key currently in this map.

Specified by:

lastCharKey in interface Char2ObjectSortedMap<V>

See Also:

• SortedMap.lastKey()

char2ObjectEntrySet

public ObjectSortedSet<Char2ObjectMap.Entry<V>> char2ObjectEntrySet()

Description copied from interface: Char2ObjectMap

Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Map.entrySet() so that it returns an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

char2ObjectEntrySet in interface Char2ObjectMap<V>

Specified by:

char2ObjectEntrySet in interface Char2ObjectSortedMap<V>

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

• Map.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 Char2ObjectMap<V>

Specified by:

keySet in interface Char2ObjectSortedMap<V>

Specified by:

keySet in interface Map<Character, V>

Specified by:

keySet in interface SortedMap<Character, V>

Overrides:

keySet in class AbstractChar2ObjectSortedMap<V>

Returns:

a type-specific sorted set view of the keys contained in this map.

See Also:

• Map.keySet()

values

public ObjectCollection<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 Char2ObjectMap<V>

Specified by:

values in interface Char2ObjectSortedMap<V>

Specified by:

values in interface Map<Character, V>

Specified by:

values in interface SortedMap<Character, V>

Overrides:

values in class AbstractChar2ObjectSortedMap<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: Char2ObjectSortedMap

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Specified by:

comparator in interface Char2ObjectSortedMap<V>

Specified by:

comparator in interface SortedMap<Character, V>

See Also:

• SortedMap.comparator()

headMap

public Char2ObjectSortedMap<V> headMap(char to)

Description copied from interface: Char2ObjectSortedMap

Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:

headMap in interface Char2ObjectSortedMap<V>

See Also:

• SortedMap.headMap(Object)

tailMap

public Char2ObjectSortedMap<V> tailMap(char from)

Description copied from interface: Char2ObjectSortedMap

Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:

tailMap in interface Char2ObjectSortedMap<V>

See Also:

• SortedMap.tailMap(Object)

subMap

public Char2ObjectSortedMap<V> subMap(char from,
 char to)

Description copied from interface: Char2ObjectSortedMap

Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:

subMap in interface Char2ObjectSortedMap<V>

See Also:

• SortedMap.subMap(Object,Object)

clone

public Char2ObjectRBTreeMap<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.