it.unimi.dsi.fastutil.chars

Class Char2IntRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction

it.unimi.dsi.fastutil.chars.AbstractChar2IntMap

it.unimi.dsi.fastutil.chars.AbstractChar2IntSortedMap

it.unimi.dsi.fastutil.chars.Char2IntRBTreeMap

All Implemented Interfaces:

Char2IntFunction, Char2IntMap, Char2IntSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Character,java.lang.Integer>, java.util.function.IntUnaryOperator, java.util.Map<java.lang.Character,java.lang.Integer>, java.util.SortedMap<java.lang.Character,java.lang.Integer>

public class Char2IntRBTreeMap
extends AbstractChar2IntSortedMap
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.AbstractChar2IntMap

AbstractChar2IntMap.BasicEntry, AbstractChar2IntMap.BasicEntrySet

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

Char2IntSortedMap.FastSortedEntrySet

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

Char2IntMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Char2IntRBTreeMap() Creates a new empty tree map.
Char2IntRBTreeMap(char[] k, int[] v) Creates a new tree map using the elements of two parallel arrays.
Char2IntRBTreeMap(char[] k, int[] 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.
Char2IntRBTreeMap(Char2IntMap m) Creates a new tree map copying a given map.
Char2IntRBTreeMap(Char2IntSortedMap m) Creates a new tree map copying a given sorted map (and its Comparator).
Char2IntRBTreeMap(java.util.Comparator<? super java.lang.Character> c) Creates a new empty tree map with the given comparator.
Char2IntRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> m) Creates a new tree map copying a given map.
Char2IntRBTreeMap(java.util.SortedMap<java.lang.Character,java.lang.Integer> m) Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

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

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

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

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

Constructor Detail

Char2IntRBTreeMap

public Char2IntRBTreeMap()

Creates a new empty tree map.

Char2IntRBTreeMap

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

Char2IntRBTreeMap

public Char2IntRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> m)

Creates a new tree map copying a given map.

Parameters:

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

Char2IntRBTreeMap

public Char2IntRBTreeMap(java.util.SortedMap<java.lang.Character,java.lang.Integer> 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.

Char2IntRBTreeMap

public Char2IntRBTreeMap(Char2IntMap m)

Creates a new tree map copying a given map.

Parameters:

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

Char2IntRBTreeMap

public Char2IntRBTreeMap(Char2IntSortedMap 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.

Char2IntRBTreeMap

public Char2IntRBTreeMap(char[] k,
                         int[] 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 - if k and v have different lengths.

Char2IntRBTreeMap

public Char2IntRBTreeMap(char[] k,
                         int[] 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 - if k and v have different lengths.

Method Detail

addTo

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

Description copied from interface: Char2IntFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Char2IntFunction

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

Description copied from interface: Char2IntFunction

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

Specified by:

remove in interface Char2IntFunction

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

Description copied from interface: Char2IntMap

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

Specified by:

containsValue in interface Char2IntMap

Overrides:

containsValue in class AbstractChar2IntMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Char2IntMap

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

Specified by:

clear in interface Char2IntMap

Specified by:

clear in interface java.util.Map<java.lang.Character,java.lang.Integer>

See Also:

Map.clear()

containsKey

public boolean containsKey(char k)

Description copied from interface: Char2IntMap

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

Specified by:

containsKey in interface Char2IntFunction

Specified by:

containsKey in interface Char2IntMap

Overrides:

containsKey in class AbstractChar2IntMap

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

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 Char2IntMap

Specified by:

size in interface java.util.Map<java.lang.Character,java.lang.Integer>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Character,java.lang.Integer>

Overrides:

isEmpty in class AbstractChar2IntMap

get

public int get(char k)

Description copied from interface: Char2IntFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2IntFunction

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

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

Specified by:

firstCharKey in interface Char2IntSortedMap

See Also:

SortedMap.firstKey()

lastCharKey

public char lastCharKey()

Description copied from interface: Char2IntSortedMap

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

Specified by:

lastCharKey in interface Char2IntSortedMap

See Also:

SortedMap.lastKey()

char2IntEntrySet

public ObjectSortedSet<Char2IntMap.Entry> char2IntEntrySet()

Description copied from interface: Char2IntSortedMap

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:

char2IntEntrySet in interface Char2IntMap

Specified by:

char2IntEntrySet in interface Char2IntSortedMap

Returns:

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

See Also:

Char2IntSortedMap.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 Char2IntMap

Specified by:

keySet in interface Char2IntSortedMap

Specified by:

keySet in interface java.util.Map<java.lang.Character,java.lang.Integer>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Character,java.lang.Integer>

Overrides:

keySet in class AbstractChar2IntSortedMap

Returns:

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

See Also:

Map.keySet()

values

public IntCollection 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 Char2IntMap

Specified by:

values in interface Char2IntSortedMap

Specified by:

values in interface java.util.Map<java.lang.Character,java.lang.Integer>

Specified by:

values in interface java.util.SortedMap<java.lang.Character,java.lang.Integer>

Overrides:

values in class AbstractChar2IntSortedMap

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

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 Char2IntSortedMap

Specified by:

comparator in interface java.util.SortedMap<java.lang.Character,java.lang.Integer>

See Also:

SortedMap.comparator()

headMap

public Char2IntSortedMap headMap(char to)

Description copied from interface: Char2IntSortedMap

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 Char2IntSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Char2IntSortedMap tailMap(char from)

Description copied from interface: Char2IntSortedMap

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 Char2IntSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Char2IntSortedMap subMap(char from,
                                char to)

Description copied from interface: Char2IntSortedMap

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 Char2IntSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

public Char2IntRBTreeMap 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 java.lang.Object

Returns:

a deep copy of this tree map.