it.unimi.dsi.fastutil.chars
Class Char2FloatRBTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.chars.AbstractChar2FloatMap
      extended byit.unimi.dsi.fastutil.chars.AbstractChar2FloatSortedMap
          extended byit.unimi.dsi.fastutil.chars.Char2FloatRBTreeMap
All Implemented Interfaces:
Char2FloatMap, Char2FloatSortedMap, Cloneable, Map, Serializable, SortedMap

public class Char2FloatRBTreeMap
extends AbstractChar2FloatSortedMap
implements Serializable, Cloneable, Char2FloatSortedMap

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 inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2FloatMap
AbstractChar2FloatMap.BasicEntry
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Char2FloatRBTreeMap()
          Creates a new empty tree map.
Char2FloatRBTreeMap(char[] k, float[] v)
          Creates a new tree map using the elements of two parallel arrays.
Char2FloatRBTreeMap(char[] k, float[] v, Comparator c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Char2FloatRBTreeMap(Char2FloatMap m)
          Creates a new tree map copying a given map.
Char2FloatRBTreeMap(Char2FloatSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Char2FloatRBTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Char2FloatRBTreeMap(Map m)
          Creates a new tree map copying a given map.
Char2FloatRBTreeMap(SortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 void clear()
           
 Object clone()
          Returns a deep copy of this tree map.
 Comparator comparator()
           
 boolean containsKey(char k)
          Checks whether the given value is contained in keySet().
 boolean containsValue(float v)
          Checks whether the given value is contained in values().
 Set entrySet()
           
 char firstCharKey()
           
 Object firstKey()
          Delegates to the corresponding type-specific method.
 float get(char k)
          Returns the value to which the given key is mapped.
 Object get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Char2FloatSortedMap headMap(char to)
           
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 char lastCharKey()
           
 Object lastKey()
          Delegates to the corresponding type-specific method.
 float put(char k, float v)
          Adds a pair to the map.
 Object put(Object ok, Object ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 float remove(char k)
          Removes the mapping with the given key.
 Object remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int size()
           
 Char2FloatSortedMap subMap(char from, char to)
           
 Char2FloatSortedMap tailMap(char from)
           
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2FloatSortedMap
headMap, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2FloatMap
containsKey, containsValue, defaultReturnValue, defaultReturnValue, equals, getDefRetValue, hashCode, putAll, setDefRetValue, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2FloatMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, hashCode, putAll
 
Methods inherited from interface java.util.SortedMap
headMap, subMap, tailMap
 

Field Detail

serialVersionUID

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

Char2FloatRBTreeMap

public Char2FloatRBTreeMap()
Creates a new empty tree map.


Char2FloatRBTreeMap

public Char2FloatRBTreeMap(Comparator c)
Creates a new empty tree map with the given comparator.

Parameters:
c - a Comparator.

Char2FloatRBTreeMap

public Char2FloatRBTreeMap(Map m)
Creates a new tree map copying a given map.

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

Char2FloatRBTreeMap

public Char2FloatRBTreeMap(SortedMap 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.

Char2FloatRBTreeMap

public Char2FloatRBTreeMap(Char2FloatMap m)
Creates a new tree map copying a given map.

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

Char2FloatRBTreeMap

public Char2FloatRBTreeMap(Char2FloatSortedMap 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.

Char2FloatRBTreeMap

public Char2FloatRBTreeMap(char[] k,
                           float[] v,
                           Comparator 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.

Char2FloatRBTreeMap

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

put

public float put(char k,
                 float v)
Description copied from interface: Char2FloatMap
Adds a pair to the map.

Specified by:
put in interface Char2FloatMap
Overrides:
put in class AbstractChar2FloatMap

remove

public float remove(char k)
Description copied from interface: Char2FloatMap
Removes the mapping with the given key.

Specified by:
remove in interface Char2FloatMap
Overrides:
remove in class AbstractChar2FloatMap

put

public Object put(Object ok,
                  Object ov)
Description copied from class: AbstractChar2FloatMap
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 Map
Overrides:
put in class AbstractChar2FloatMap

remove

public Object remove(Object ok)
Description copied from class: AbstractChar2FloatMap
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 Map
Overrides:
remove in class AbstractChar2FloatMap

containsValue

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

Specified by:
containsValue in interface Char2FloatMap
Overrides:
containsValue in class AbstractChar2FloatMap

clear

public void clear()
Specified by:
clear in interface Map
Overrides:
clear in class AbstractChar2FloatMap

containsKey

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

Specified by:
containsKey in interface Char2FloatMap
Overrides:
containsKey in class AbstractChar2FloatMap

size

public int size()
Specified by:
size in interface Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map
Overrides:
isEmpty in class AbstractChar2FloatMap

get

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

Specified by:
get in interface Char2FloatMap
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

get

public Object get(Object ok)
Description copied from class: AbstractChar2FloatMap
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:
get in interface Map
Overrides:
get in class AbstractChar2FloatMap

firstCharKey

public char firstCharKey()
Specified by:
firstCharKey in interface Char2FloatSortedMap
See Also:
SortedMap.firstKey()

lastCharKey

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

firstKey

public Object firstKey()
Description copied from class: AbstractChar2FloatSortedMap
Delegates to the corresponding type-specific method.

Specified by:
firstKey in interface SortedMap
Overrides:
firstKey in class AbstractChar2FloatSortedMap

lastKey

public Object lastKey()
Description copied from class: AbstractChar2FloatSortedMap
Delegates to the corresponding type-specific method.

Specified by:
lastKey in interface SortedMap
Overrides:
lastKey in class AbstractChar2FloatSortedMap

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

keySet

public Set 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 Map
Overrides:
keySet in class AbstractChar2FloatSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.

values

public Collection 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 Map
Overrides:
values in class AbstractChar2FloatMap
Returns:
a type-specific collection view of the values contained in this map.

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedMap

headMap

public Char2FloatSortedMap headMap(char to)
Specified by:
headMap in interface Char2FloatSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Char2FloatSortedMap tailMap(char from)
Specified by:
tailMap in interface Char2FloatSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Char2FloatSortedMap subMap(char from,
                                  char to)
Specified by:
subMap in interface Char2FloatSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

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

Returns:
a deep copy of this tree map.