it.unimi.dsi.fastutil.ints
Class Int2CharRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction
      it.unimi.dsi.fastutil.ints.AbstractInt2CharMap
          it.unimi.dsi.fastutil.ints.AbstractInt2CharSortedMap
              it.unimi.dsi.fastutil.ints.Int2CharRBTreeMap

All Implemented Interfaces:

Function<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap, Int2CharSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Integer,java.lang.Character>, java.util.SortedMap<java.lang.Integer,java.lang.Character>

public class Int2CharRBTreeMap
extends AbstractInt2CharSortedMap
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.ints.AbstractInt2CharMap

AbstractInt2CharMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2CharSortedMap

Int2CharSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2CharMap

Int2CharMap.FastEntrySet

Constructor Summary

Int2CharRBTreeMap()
Creates a new empty tree map.

Int2CharRBTreeMap(java.util.Comparator<? super java.lang.Integer> c)
Creates a new empty tree map with the given comparator.

Int2CharRBTreeMap(int[] k, char[] v)
Creates a new tree map using the elements of two parallel arrays.

Int2CharRBTreeMap(int[] k, char[] v, java.util.Comparator<? super java.lang.Integer> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Int2CharRBTreeMap(Int2CharMap m)
Creates a new tree map copying a given map.

Int2CharRBTreeMap(Int2CharSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Int2CharRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> m)
Creates a new tree map copying a given map.

Int2CharRBTreeMap(java.util.SortedMap<java.lang.Integer,java.lang.Character> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

void	clear() Removes all associations from this function (optional operation).
Int2CharRBTreeMap	clone() Returns a deep copy of this tree map.
IntComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(int k) Checks whether the given value is contained in AbstractInt2CharMap.keySet().
boolean	containsValue(char v) Checks whether the given value is contained in AbstractInt2CharMap.values().
int	firstIntKey()
char	get(int k) Returns the value to which the given key is mapped.
Int2CharSortedMap	headMap(int to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2CharMap.Entry>	int2CharEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
boolean	isEmpty()
IntSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
int	lastIntKey()
char	put(int k, char v) Adds a pair to the map.
java.lang.Character	put(java.lang.Integer ok, java.lang.Character ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
char	remove(int k) Removes the mapping with the given key.
java.lang.Character	remove(java.lang.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.
Int2CharSortedMap	subMap(int from, int to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Int2CharSortedMap	tailMap(int 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.ints.AbstractInt2CharSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2CharMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2CharFunction

defaultReturnValue, defaultReturnValue

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

containsKey, get

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, putAll

Constructor Detail

Int2CharRBTreeMap

public Int2CharRBTreeMap()

Creates a new empty tree map.

Int2CharRBTreeMap

public Int2CharRBTreeMap(java.util.Comparator<? super java.lang.Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2CharRBTreeMap

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

Creates a new tree map copying a given map.

Parameters:

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

Int2CharRBTreeMap

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

Int2CharRBTreeMap

public Int2CharRBTreeMap(Int2CharMap m)

Creates a new tree map copying a given map.

Parameters:

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

Int2CharRBTreeMap

public Int2CharRBTreeMap(Int2CharSortedMap 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.

Int2CharRBTreeMap

public Int2CharRBTreeMap(int[] k,
                         char[] v,
                         java.util.Comparator<? super java.lang.Integer> 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.

Int2CharRBTreeMap

public Int2CharRBTreeMap(int[] 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:

java.lang.IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public char put(int k,
                char v)

Description copied from interface: Int2CharFunction

Adds a pair to the map.

Specified by:

put in interface Int2CharFunction

Overrides:

put in class AbstractInt2CharFunction

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

Description copied from interface: Int2CharFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2CharFunction

Overrides:

remove in class AbstractInt2CharFunction

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 java.lang.Character put(java.lang.Integer ok,
                               java.lang.Character ov)

Description copied from class: AbstractInt2CharFunction

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<java.lang.Integer,java.lang.Character>

Specified by:

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

Overrides:

put in class AbstractInt2CharFunction

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 java.lang.Character remove(java.lang.Object ok)

Description copied from class: AbstractInt2CharFunction

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<java.lang.Integer,java.lang.Character>

Specified by:

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

Overrides:

remove in class AbstractInt2CharFunction

Returns:

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

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(char v)

Description copied from class: AbstractInt2CharMap

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

Specified by:

containsValue in interface Int2CharMap

Overrides:

containsValue in class AbstractInt2CharMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<java.lang.Integer,java.lang.Character>

Specified by:

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

Overrides:

clear in class AbstractInt2CharFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2CharMap

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

Specified by:

containsKey in interface Int2CharFunction

Overrides:

containsKey in class AbstractInt2CharMap

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<java.lang.Integer,java.lang.Character>

Specified by:

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

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 java.util.Map<java.lang.Integer,java.lang.Character>

Overrides:

isEmpty in class AbstractInt2CharMap

get

public char get(int k)

Description copied from interface: Int2CharFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2CharFunction

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)

firstIntKey

public int firstIntKey()

Specified by:

firstIntKey in interface Int2CharSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Specified by:

lastIntKey in interface Int2CharSortedMap

See Also:

SortedMap.lastKey()

int2CharEntrySet

public ObjectSortedSet<Int2CharMap.Entry> int2CharEntrySet()

Description copied from interface: Int2CharSortedMap

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:

int2CharEntrySet in interface Int2CharMap

Specified by:

int2CharEntrySet in interface Int2CharSortedMap

Returns:

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

See Also:

Int2CharSortedMap.entrySet()

keySet

public IntSortedSet 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 Int2CharMap

Specified by:

keySet in interface Int2CharSortedMap

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractInt2CharSortedMap

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 Int2CharMap

Specified by:

values in interface Int2CharSortedMap

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractInt2CharSortedMap

Returns:

a type-specific collection view of the values contained in this map.

See Also:

Map.values()

comparator

public IntComparator comparator()

Description copied from interface: Int2CharSortedMap

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 Int2CharSortedMap

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Int2CharSortedMap headMap(int to)

Description copied from interface: Int2CharSortedMap

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

Specified by:

headMap in interface Int2CharSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Int2CharSortedMap tailMap(int from)

Description copied from interface: Int2CharSortedMap

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

Specified by:

tailMap in interface Int2CharSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Int2CharSortedMap subMap(int from,
                                int to)

Description copied from interface: Int2CharSortedMap

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

Specified by:

subMap in interface Int2CharSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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