it.unimi.dsi.fastutil.chars
Class Char2DoubleRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.chars.AbstractChar2DoubleFunction
      it.unimi.dsi.fastutil.chars.AbstractChar2DoubleMap
          it.unimi.dsi.fastutil.chars.AbstractChar2DoubleSortedMap
              it.unimi.dsi.fastutil.chars.Char2DoubleRBTreeMap

All Implemented Interfaces:

Char2DoubleFunction, Char2DoubleMap, Char2DoubleSortedMap, Function<java.lang.Character,java.lang.Double>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Character,java.lang.Double>, java.util.SortedMap<java.lang.Character,java.lang.Double>

public class Char2DoubleRBTreeMap
extends AbstractChar2DoubleSortedMap
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.AbstractChar2DoubleMap

AbstractChar2DoubleMap.BasicEntry

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

Char2DoubleSortedMap.FastSortedEntrySet

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

Char2DoubleMap.FastEntrySet

Constructor Summary

Char2DoubleRBTreeMap()
Creates a new empty tree map.

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

Char2DoubleRBTreeMap(char[] k, double[] 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.

Char2DoubleRBTreeMap(Char2DoubleMap m)
Creates a new tree map copying a given map.

Char2DoubleRBTreeMap(Char2DoubleSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

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

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

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

Method Summary

ObjectSortedSet<Char2DoubleMap.Entry>	char2DoubleEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
Char2DoubleRBTreeMap	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 AbstractChar2DoubleMap.keySet().
boolean	containsValue(double v) Checks whether the given value is contained in AbstractChar2DoubleMap.values().
char	firstCharKey()
double	get(char k) Returns the value to which the given key is mapped.
Char2DoubleSortedMap	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()
java.lang.Double	put(java.lang.Character ok, java.lang.Double ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	put(char k, double v) Adds a pair to the map.
double	remove(char k) Removes the mapping with the given key.
java.lang.Double	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.
Char2DoubleSortedMap	subMap(char from, char to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Char2DoubleSortedMap	tailMap(char from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
DoubleCollection	values() Returns a type-specific collection view of the values contained in this map.

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

containsValue, equals, hashCode, putAll, toString

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

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

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

Char2DoubleRBTreeMap

public Char2DoubleRBTreeMap()

Creates a new empty tree map.

Char2DoubleRBTreeMap

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

Char2DoubleRBTreeMap

public Char2DoubleRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Double> m)

Creates a new tree map copying a given map.

Parameters:

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

Char2DoubleRBTreeMap

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

Char2DoubleRBTreeMap

public Char2DoubleRBTreeMap(Char2DoubleMap m)

Creates a new tree map copying a given map.

Parameters:

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

Char2DoubleRBTreeMap

public Char2DoubleRBTreeMap(Char2DoubleSortedMap 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.

Char2DoubleRBTreeMap

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

Char2DoubleRBTreeMap

public Char2DoubleRBTreeMap(char[] k,
                            double[] 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 double put(char k,
                  double v)

Description copied from interface: Char2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Char2DoubleFunction

Overrides:

put in class AbstractChar2DoubleFunction

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

Description copied from interface: Char2DoubleFunction

Removes the mapping with the given key.

Specified by:

remove in interface Char2DoubleFunction

Overrides:

remove in class AbstractChar2DoubleFunction

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

Description copied from class: AbstractChar2DoubleFunction

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

Specified by:

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

Overrides:

put in class AbstractChar2DoubleFunction

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

Description copied from class: AbstractChar2DoubleFunction

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

Specified by:

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

Overrides:

remove in class AbstractChar2DoubleFunction

Returns:

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

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(double v)

Description copied from class: AbstractChar2DoubleMap

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

Specified by:

containsValue in interface Char2DoubleMap

Overrides:

containsValue in class AbstractChar2DoubleMap

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

Specified by:

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

Overrides:

clear in class AbstractChar2DoubleFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(char k)

Description copied from class: AbstractChar2DoubleMap

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

Specified by:

containsKey in interface Char2DoubleFunction

Overrides:

containsKey in class AbstractChar2DoubleMap

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

Specified by:

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

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

Overrides:

isEmpty in class AbstractChar2DoubleMap

get

public double get(char k)

Description copied from interface: Char2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2DoubleFunction

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 Char2DoubleSortedMap

See Also:

SortedMap.firstKey()

lastCharKey

public char lastCharKey()

Specified by:

lastCharKey in interface Char2DoubleSortedMap

See Also:

SortedMap.lastKey()

char2DoubleEntrySet

public ObjectSortedSet<Char2DoubleMap.Entry> char2DoubleEntrySet()

Description copied from interface: Char2DoubleSortedMap

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:

char2DoubleEntrySet in interface Char2DoubleMap

Specified by:

char2DoubleEntrySet in interface Char2DoubleSortedMap

Returns:

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

See Also:

Char2DoubleSortedMap.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 Char2DoubleMap

Specified by:

keySet in interface Char2DoubleSortedMap

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractChar2DoubleSortedMap

Returns:

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

See Also:

Map.keySet()

values

public DoubleCollection 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 Char2DoubleMap

Specified by:

values in interface Char2DoubleSortedMap

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractChar2DoubleSortedMap

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

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 Char2DoubleSortedMap

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Char2DoubleSortedMap headMap(char to)

Description copied from interface: Char2DoubleSortedMap

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

Specified by:

headMap in interface Char2DoubleSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Char2DoubleSortedMap tailMap(char from)

Description copied from interface: Char2DoubleSortedMap

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

Specified by:

tailMap in interface Char2DoubleSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Char2DoubleSortedMap subMap(char from,
                                   char to)

Description copied from interface: Char2DoubleSortedMap

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

Specified by:

subMap in interface Char2DoubleSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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