it.unimi.dsi.fastutil.chars

Class Char2CharRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction

it.unimi.dsi.fastutil.chars.AbstractChar2CharMap

it.unimi.dsi.fastutil.chars.AbstractChar2CharSortedMap

it.unimi.dsi.fastutil.chars.Char2CharRBTreeMap

All Implemented Interfaces:

Char2CharFunction, Char2CharMap, Char2CharSortedMap, Serializable, Cloneable, Function<Character,Character>, IntUnaryOperator, Map<Character,Character>, SortedMap<Character,Character>

public class Char2CharRBTreeMap
extends AbstractChar2CharSortedMap
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.AbstractChar2CharSortedMap

AbstractChar2CharSortedMap.KeySetIterator, AbstractChar2CharSortedMap.ValuesCollection, AbstractChar2CharSortedMap.ValuesIterator

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

AbstractChar2CharMap.BasicEntry, AbstractChar2CharMap.BasicEntrySet

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

Char2CharSortedMap.FastSortedEntrySet

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

Char2CharMap.FastEntrySet

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<Char2CharMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.chars.Char2CharRBTreeMap.Entry	firstEntry The first key in this map.
protected CharSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.chars.Char2CharRBTreeMap.Entry	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.
protected Comparator<? super Character>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.chars.Char2CharRBTreeMap.Entry	tree A reference to the root entry.
protected CharCollection	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
char	addTo(char k, char incr) Adds an increment to value currently associated with a key.
ObjectSortedSet<Char2CharMap.Entry>	char2CharEntrySet() 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).
Char2CharRBTreeMap	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(char v) Returns true if this map maps one or more keys to the specified value.
char	firstCharKey() Returns the first (lowest) key currently in this map.
char	get(char k) Returns the value to which the given key is mapped.
Char2CharSortedMap	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.
char	put(char k, char v) Adds a pair to the map (optional operation).
char	remove(char k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Char2CharSortedMap	subMap(char from, char to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Char2CharSortedMap	tailMap(char from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
CharCollection	values() Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

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.chars.Char2CharFunction

applyAsInt

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, putAll, replaceAll

Field Detail

tree

protected transient it.unimi.dsi.fastutil.chars.Char2CharRBTreeMap.Entry 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.Char2CharRBTreeMap.Entry firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.chars.Char2CharRBTreeMap.Entry lastEntry

The last key in this map.

entries

protected transient ObjectSortedSet<Char2CharMap.Entry> entries

Cached set of entries.

keys

protected transient CharSortedSet keys

Cached set of keys.

values

protected transient CharCollection 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.

Constructor Detail

Char2CharRBTreeMap

public Char2CharRBTreeMap()

Creates a new empty tree map.

Char2CharRBTreeMap

public Char2CharRBTreeMap(Comparator<? super Character> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Char2CharRBTreeMap

public Char2CharRBTreeMap(Map<? extends Character,? extends Character> m)

Creates a new tree map copying a given map.

Parameters:

m - a Map to be copied into the new tree map.

Char2CharRBTreeMap

public Char2CharRBTreeMap(SortedMap<Character,Character> 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.

Char2CharRBTreeMap

public Char2CharRBTreeMap(Char2CharMap m)

Creates a new tree map copying a given map.

Parameters:

m - a type-specific map to be copied into the new tree map.

Char2CharRBTreeMap

public Char2CharRBTreeMap(Char2CharSortedMap 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.

Char2CharRBTreeMap

public Char2CharRBTreeMap(char[] k,
                          char[] 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.

Char2CharRBTreeMap

public Char2CharRBTreeMap(char[] k,
                          char[] 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

addTo

public char addTo(char k,
                  char 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 char put(char k,
                char v)

Description copied from interface: Char2CharFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Char2CharFunction

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 char remove(char k)

Description copied from interface: Char2CharFunction

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

Specified by:

remove in interface Char2CharFunction

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

Description copied from interface: Char2CharMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Char2CharMap

Overrides:

containsValue in class AbstractChar2CharMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Char2CharMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Char2CharMap

Specified by:

clear in interface Map<Character,Character>

See Also:

Map.clear()

containsKey

public boolean containsKey(char k)

Description copied from interface: Char2CharMap

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

Specified by:

containsKey in interface Char2CharFunction

Specified by:

containsKey in interface Char2CharMap

Overrides:

containsKey in class AbstractChar2CharMap

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: Char2CharMap

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 Char2CharMap

Specified by:

size in interface Map<Character,Character>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character,Character>

Overrides:

isEmpty in class AbstractChar2CharMap

get

public char get(char k)

Description copied from interface: Char2CharFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2CharFunction

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: Char2CharSortedMap

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

Specified by:

firstCharKey in interface Char2CharSortedMap

See Also:

SortedMap.firstKey()

lastCharKey

public char lastCharKey()

Description copied from interface: Char2CharSortedMap

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

Specified by:

lastCharKey in interface Char2CharSortedMap

See Also:

SortedMap.lastKey()

char2CharEntrySet

public ObjectSortedSet<Char2CharMap.Entry> char2CharEntrySet()

Description copied from interface: Char2CharSortedMap

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:

char2CharEntrySet in interface Char2CharMap

Specified by:

char2CharEntrySet in interface Char2CharSortedMap

Returns:

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

See Also:

Char2CharSortedMap.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 Char2CharMap

Specified by:

keySet in interface Char2CharSortedMap

Specified by:

keySet in interface Map<Character,Character>

Specified by:

keySet in interface SortedMap<Character,Character>

Overrides:

keySet in class AbstractChar2CharSortedMap

Returns:

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

See Also:

Map.keySet()

values

public CharCollection 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 Char2CharMap

Specified by:

values in interface Char2CharSortedMap

Specified by:

values in interface Map<Character,Character>

Specified by:

values in interface SortedMap<Character,Character>

Overrides:

values in class AbstractChar2CharSortedMap

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: Char2CharSortedMap

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 Char2CharSortedMap

Specified by:

comparator in interface SortedMap<Character,Character>

See Also:

SortedMap.comparator()

headMap

public Char2CharSortedMap headMap(char to)

Description copied from interface: Char2CharSortedMap

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 Char2CharSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Char2CharSortedMap tailMap(char from)

Description copied from interface: Char2CharSortedMap

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 Char2CharSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Char2CharSortedMap subMap(char from,
                                 char to)

Description copied from interface: Char2CharSortedMap

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 Char2CharSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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