it.unimi.dsi.fastutil.chars
Class Char2LongRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2LongFunction
      extended by it.unimi.dsi.fastutil.chars.AbstractChar2LongMap
          extended by it.unimi.dsi.fastutil.chars.AbstractChar2LongSortedMap
              extended by it.unimi.dsi.fastutil.chars.Char2LongRBTreeMap
All Implemented Interfaces:
Char2LongFunction, Char2LongMap, Char2LongSortedMap, Function<java.lang.Character,java.lang.Long>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Character,java.lang.Long>, java.util.SortedMap<java.lang.Character,java.lang.Long>

public class Char2LongRBTreeMap
extends AbstractChar2LongSortedMap
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.AbstractChar2LongMap
AbstractChar2LongMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2LongSortedMap
Char2LongSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2LongMap
Char2LongMap.FastEntrySet
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Char2LongRBTreeMap()
          Creates a new empty tree map.
Char2LongRBTreeMap(char[] k, long[] v)
          Creates a new tree map using the elements of two parallel arrays.
Char2LongRBTreeMap(char[] k, long[] 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.
Char2LongRBTreeMap(Char2LongMap m)
          Creates a new tree map copying a given map.
Char2LongRBTreeMap(Char2LongSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Char2LongRBTreeMap(java.util.Comparator<? super java.lang.Character> c)
          Creates a new empty tree map with the given comparator.
Char2LongRBTreeMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Long> m)
          Creates a new tree map copying a given map.
Char2LongRBTreeMap(java.util.SortedMap<java.lang.Character,java.lang.Long> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 ObjectSortedSet<Char2LongMap.Entry> char2LongEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 java.lang.Object 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 AbstractChar2LongMap.keySet().
 boolean containsValue(long v)
          Checks whether the given value is contained in AbstractChar2LongMap.values().
 char firstCharKey()
           
 long get(char k)
          Returns the value to which the given key is mapped.
 Char2LongSortedMap 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.Long put(java.lang.Character ok, java.lang.Long ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 long put(char k, long v)
          Adds a pair to the map.
 long remove(char k)
          Removes the mapping with the given key.
 java.lang.Long 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.
 Char2LongSortedMap subMap(char from, char to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Char2LongSortedMap tailMap(char from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 LongCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2LongSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2LongMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2LongFunction
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.Char2LongFunction
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
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Char2LongRBTreeMap

public Char2LongRBTreeMap()
Creates a new empty tree map.


Char2LongRBTreeMap

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

Char2LongRBTreeMap

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

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

Char2LongRBTreeMap

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

Char2LongRBTreeMap

public Char2LongRBTreeMap(Char2LongMap m)
Creates a new tree map copying a given map.

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

Char2LongRBTreeMap

public Char2LongRBTreeMap(Char2LongSortedMap 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.

Char2LongRBTreeMap

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

Char2LongRBTreeMap

public Char2LongRBTreeMap(char[] k,
                          long[] 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 long put(char k,
                long v)
Description copied from interface: Char2LongFunction
Adds a pair to the map.

Specified by:
put in interface Char2LongFunction
Overrides:
put in class AbstractChar2LongFunction
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 long remove(char k)
Description copied from interface: Char2LongFunction
Removes the mapping with the given key.

Specified by:
remove in interface Char2LongFunction
Overrides:
remove in class AbstractChar2LongFunction
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.Long put(java.lang.Character ok,
                          java.lang.Long ov)
Description copied from class: AbstractChar2LongFunction
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.Long>
Specified by:
put in interface java.util.Map<java.lang.Character,java.lang.Long>
Overrides:
put in class AbstractChar2LongFunction
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.Long remove(java.lang.Object ok)
Description copied from class: AbstractChar2LongFunction
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.Long>
Specified by:
remove in interface java.util.Map<java.lang.Character,java.lang.Long>
Overrides:
remove in class AbstractChar2LongFunction
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

containsValue

public boolean containsValue(long v)
Description copied from class: AbstractChar2LongMap
Checks whether the given value is contained in AbstractChar2LongMap.values().

Specified by:
containsValue in interface Char2LongMap
Overrides:
containsValue in class AbstractChar2LongMap
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.Long>
Specified by:
clear in interface java.util.Map<java.lang.Character,java.lang.Long>
Overrides:
clear in class AbstractChar2LongFunction
See Also:
Map.clear()

containsKey

public boolean containsKey(char k)
Description copied from class: AbstractChar2LongMap
Checks whether the given value is contained in AbstractChar2LongMap.keySet().

Specified by:
containsKey in interface Char2LongFunction
Overrides:
containsKey in class AbstractChar2LongMap
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.Long>
Specified by:
size in interface java.util.Map<java.lang.Character,java.lang.Long>
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.Long>
Overrides:
isEmpty in class AbstractChar2LongMap

get

public long get(char k)
Description copied from interface: Char2LongFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Char2LongFunction
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 Char2LongSortedMap
See Also:
SortedMap.firstKey()

lastCharKey

public char lastCharKey()
Specified by:
lastCharKey in interface Char2LongSortedMap
See Also:
SortedMap.lastKey()

char2LongEntrySet

public ObjectSortedSet<Char2LongMap.Entry> char2LongEntrySet()
Description copied from interface: Char2LongMap
Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Char2LongMap.entrySet() so that it returns an ObjectSet of objects of type Char2LongMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
char2LongEntrySet in interface Char2LongMap
Specified by:
char2LongEntrySet in interface Char2LongSortedMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Char2LongMap.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 Char2LongMap
Specified by:
keySet in interface Char2LongSortedMap
Specified by:
keySet in interface java.util.Map<java.lang.Character,java.lang.Long>
Overrides:
keySet in class AbstractChar2LongSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public LongCollection 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 Char2LongMap
Specified by:
values in interface Char2LongSortedMap
Specified by:
values in interface java.util.Map<java.lang.Character,java.lang.Long>
Overrides:
values in class AbstractChar2LongSortedMap
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: Char2LongSortedMap
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 Char2LongSortedMap
Specified by:
comparator in interface java.util.SortedMap<java.lang.Character,java.lang.Long>
See Also:
SortedMap.comparator()

headMap

public Char2LongSortedMap headMap(char to)
Description copied from interface: Char2LongSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Char2LongSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Char2LongSortedMap tailMap(char from)
Description copied from interface: Char2LongSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:
tailMap in interface Char2LongSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Char2LongSortedMap subMap(char from,
                                 char to)
Description copied from interface: Char2LongSortedMap
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:
subMap in interface Char2LongSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

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