it.unimi.dsi.fastutil.floats
Class Float2ReferenceRBTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.floats.AbstractFloat2ReferenceMap
      extended byit.unimi.dsi.fastutil.floats.AbstractFloat2ReferenceSortedMap
          extended byit.unimi.dsi.fastutil.floats.Float2ReferenceRBTreeMap
All Implemented Interfaces:
Cloneable, Float2ReferenceMap, Float2ReferenceSortedMap, Map, Serializable, SortedMap

public class Float2ReferenceRBTreeMap
extends AbstractFloat2ReferenceSortedMap
implements Serializable, Cloneable, Float2ReferenceSortedMap

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.floats.AbstractFloat2ReferenceMap
AbstractFloat2ReferenceMap.BasicEntry
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Float2ReferenceRBTreeMap()
          Creates a new empty tree map.
Float2ReferenceRBTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Float2ReferenceRBTreeMap(float[] k, Object[] v)
          Creates a new tree map using the elements of two parallel arrays.
Float2ReferenceRBTreeMap(float[] k, Object[] v, Comparator c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Float2ReferenceRBTreeMap(Float2ReferenceMap m)
          Creates a new tree map copying a given map.
Float2ReferenceRBTreeMap(Float2ReferenceSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Float2ReferenceRBTreeMap(Map m)
          Creates a new tree map copying a given map.
Float2ReferenceRBTreeMap(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(float k)
          Checks whether the given value is contained in keySet().
 boolean containsValue(Object v)
          Checks whether the given value is contained in values().
 Set entrySet()
           
 float firstFloatKey()
           
 Object firstKey()
          Delegates to the corresponding type-specific method.
 Object get(float 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.
 Float2ReferenceSortedMap headMap(float to)
           
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 float lastFloatKey()
           
 Object lastKey()
          Delegates to the corresponding type-specific method.
 Object put(float k, Object 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.
 Object remove(float 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()
           
 Float2ReferenceSortedMap subMap(float from, float to)
           
 Float2ReferenceSortedMap tailMap(float from)
           
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2ReferenceSortedMap
headMap, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2ReferenceMap
containsKey, 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.floats.Float2ReferenceMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
containsKey, 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

Float2ReferenceRBTreeMap

public Float2ReferenceRBTreeMap()
Creates a new empty tree map.


Float2ReferenceRBTreeMap

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

Parameters:
c - a Comparator.

Float2ReferenceRBTreeMap

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

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

Float2ReferenceRBTreeMap

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

Float2ReferenceRBTreeMap

public Float2ReferenceRBTreeMap(Float2ReferenceMap m)
Creates a new tree map copying a given map.

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

Float2ReferenceRBTreeMap

public Float2ReferenceRBTreeMap(Float2ReferenceSortedMap 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.

Float2ReferenceRBTreeMap

public Float2ReferenceRBTreeMap(float[] k,
                                Object[] 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.

Float2ReferenceRBTreeMap

public Float2ReferenceRBTreeMap(float[] k,
                                Object[] 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 Object put(float k,
                  Object v)
Description copied from interface: Float2ReferenceMap
Adds a pair to the map.

Specified by:
put in interface Float2ReferenceMap
Overrides:
put in class AbstractFloat2ReferenceMap

remove

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

Specified by:
remove in interface Float2ReferenceMap
Overrides:
remove in class AbstractFloat2ReferenceMap

put

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

remove

public Object remove(Object ok)
Description copied from class: AbstractFloat2ReferenceMap
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 AbstractFloat2ReferenceMap

containsValue

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

Specified by:
containsValue in interface Map
Overrides:
containsValue in class AbstractFloat2ReferenceMap

clear

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

containsKey

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

Specified by:
containsKey in interface Float2ReferenceMap
Overrides:
containsKey in class AbstractFloat2ReferenceMap

size

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

isEmpty

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

get

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

Specified by:
get in interface Float2ReferenceMap
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: AbstractFloat2ReferenceMap
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 AbstractFloat2ReferenceMap

firstFloatKey

public float firstFloatKey()
Specified by:
firstFloatKey in interface Float2ReferenceSortedMap
See Also:
SortedMap.firstKey()

lastFloatKey

public float lastFloatKey()
Specified by:
lastFloatKey in interface Float2ReferenceSortedMap
See Also:
SortedMap.lastKey()

firstKey

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

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

lastKey

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

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

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 AbstractFloat2ReferenceSortedMap
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 AbstractFloat2ReferenceMap
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 Float2ReferenceSortedMap headMap(float to)
Specified by:
headMap in interface Float2ReferenceSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Float2ReferenceSortedMap tailMap(float from)
Specified by:
tailMap in interface Float2ReferenceSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Float2ReferenceSortedMap subMap(float from,
                                       float to)
Specified by:
subMap in interface Float2ReferenceSortedMap
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.