it.unimi.dsi.fastutil.chars

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

AbstractChar2ObjectSortedMap.KeySetIterator<V>, AbstractChar2ObjectSortedMap.ValuesCollection, AbstractChar2ObjectSortedMap.ValuesIterator<V>

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

AbstractChar2ObjectMap.BasicEntry<V>

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

Char2ObjectSortedMap.FastSortedEntrySet<V>

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

Char2ObjectMap.FastEntrySet<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected CharComparator	actualComparator This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
protected int	count Number of entries in this map.
protected ObjectSortedSet<Char2ObjectMap.Entry<V>>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.chars.Char2ObjectRBTreeMap.Entry<V>	firstEntry The first key in this map.
protected CharSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.chars.Char2ObjectRBTreeMap.Entry<V>	lastEntry The last key in this map.
protected boolean	modified The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.
static long	serialVersionUID
protected Comparator<? super Character>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.chars.Char2ObjectRBTreeMap.Entry<V>	tree A reference to the root entry.
protected ObjectCollection<V>	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

Constructor and 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

Methods

Modifier and Type	Method and Description
ObjectSortedSet<Char2ObjectMap.Entry<V>>	char2ObjectEntrySet() Returns a type-specific sorted-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) Checks whether the given value is contained in AbstractChar2ObjectMap.keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in AbstractChar2ObjectMap.values().
char	firstCharKey()
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()
V	put(Character ok, V ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
V	put(char k, V v) Adds a pair to the map.
V	remove(char k) Removes the mapping with the given key.
V	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
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.AbstractChar2ObjectSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

defaultReturnValue, defaultReturnValue

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

containsKey, get

Methods inherited from interface java.util.Map

containsKey, equals, get, hashCode, putAll

Field Detail

tree

protected transient it.unimi.dsi.fastutil.chars.Char2ObjectRBTreeMap.Entry<V> tree

A reference to the root entry.

count

protected int count

Number of entries in this map.

firstEntry

protected transient it.unimi.dsi.fastutil.chars.Char2ObjectRBTreeMap.Entry<V> firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.chars.Char2ObjectRBTreeMap.Entry<V> lastEntry

The last key in this map.

entries

protected transient volatile ObjectSortedSet<Char2ObjectMap.Entry<V>> entries

Cached set of entries.

keys

protected transient volatile CharSortedSet keys

Cached set of keys.

values

protected transient volatile ObjectCollection<V> values

Cached collection of values.

modified

protected transient boolean modified

The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.

storedComparator

protected Comparator<? super Character> storedComparator

This map's comparator, as provided in the constructor.

actualComparator

protected transient CharComparator actualComparator

This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

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 Detail

put

public V put(char k,
    V v)

Description copied from interface: Char2ObjectFunction

Adds a pair to the map.

Specified by:

put in interface Char2ObjectFunction<V>

Overrides:

put in class AbstractChar2ObjectFunction<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.

Specified by:

remove in interface Char2ObjectFunction<V>

Overrides:

remove in class AbstractChar2ObjectFunction<V>

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.remove(Object)

put

public V put(Character ok,
    V ov)

Description copied from class: AbstractChar2ObjectFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

put in interface Function<Character,V>

Specified by:

put in interface Map<Character,V>

Overrides:

put in class AbstractChar2ObjectFunction<V>

Parameters:

ok - the key.

ov - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public V remove(Object ok)

Description copied from class: AbstractChar2ObjectFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

remove in interface Function<Character,V>

Specified by:

remove in interface Map<Character,V>

Overrides:

remove in class AbstractChar2ObjectFunction<V>

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractChar2ObjectMap

Checks whether the given value is contained in AbstractChar2ObjectMap.values().

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 Function<Character,V>

Specified by:

clear in interface Map<Character,V>

Overrides:

clear in class AbstractChar2ObjectFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(char k)

Description copied from class: AbstractChar2ObjectMap

Checks whether the given value is contained in AbstractChar2ObjectMap.keySet().

Specified by:

containsKey in interface Char2ObjectFunction<V>

Overrides:

containsKey in class AbstractChar2ObjectMap<V>

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.

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.

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()

Specified by:

firstCharKey in interface Char2ObjectSortedMap<V>

See Also:

SortedMap.firstKey()

lastCharKey

public char lastCharKey()

Specified by:

lastCharKey in interface Char2ObjectSortedMap<V>

See Also:

SortedMap.lastKey()

char2ObjectEntrySet

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

Description copied from interface: Char2ObjectSortedMap

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:

char2ObjectEntrySet in interface Char2ObjectMap<V>

Specified by:

char2ObjectEntrySet in interface Char2ObjectSortedMap<V>

Returns:

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

See Also:

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

Note that this specification strengthens the one given in SortedMap.comparator().

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.

Overrides:

clone in class Object

Returns:

a deep copy of this tree map.