it.unimi.dsi.fastutil.floats
Class Float2DoubleRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.floats.AbstractFloat2DoubleFunction
      it.unimi.dsi.fastutil.floats.AbstractFloat2DoubleMap
          it.unimi.dsi.fastutil.floats.AbstractFloat2DoubleSortedMap
              it.unimi.dsi.fastutil.floats.Float2DoubleRBTreeMap

All Implemented Interfaces:

Float2DoubleFunction, Float2DoubleMap, Float2DoubleSortedMap, Function<java.lang.Float,java.lang.Double>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Float,java.lang.Double>, java.util.SortedMap<java.lang.Float,java.lang.Double>

public class Float2DoubleRBTreeMap
extends AbstractFloat2DoubleSortedMap
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.floats.AbstractFloat2DoubleMap

AbstractFloat2DoubleMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.floats.Float2DoubleSortedMap

Float2DoubleSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.floats.Float2DoubleMap

Float2DoubleMap.FastEntrySet

Constructor Summary

Float2DoubleRBTreeMap()
Creates a new empty tree map.

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

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

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

Float2DoubleRBTreeMap(Float2DoubleMap m)
Creates a new tree map copying a given map.

Float2DoubleRBTreeMap(Float2DoubleSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

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

Float2DoubleRBTreeMap(java.util.SortedMap<java.lang.Float,java.lang.Double> 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).
Float2DoubleRBTreeMap	clone() Returns a deep copy of this tree map.
FloatComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(float k) Checks whether the given value is contained in AbstractFloat2DoubleMap.keySet().
boolean	containsValue(double v) Checks whether the given value is contained in AbstractFloat2DoubleMap.values().
float	firstFloatKey()
ObjectSortedSet<Float2DoubleMap.Entry>	float2DoubleEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
double	get(float k) Returns the value to which the given key is mapped.
Float2DoubleSortedMap	headMap(float to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
FloatSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
float	lastFloatKey()
double	put(float k, double v) Adds a pair to the map.
java.lang.Double	put(java.lang.Float ok, java.lang.Double ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	remove(float 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.
Float2DoubleSortedMap	subMap(float from, float to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Float2DoubleSortedMap	tailMap(float 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.floats.AbstractFloat2DoubleSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2DoubleMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2DoubleFunction

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.floats.Float2DoubleFunction

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

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap()

Creates a new empty tree map.

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap(java.util.Comparator<? super java.lang.Float> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap(java.util.Map<? extends java.lang.Float,? 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.

Float2DoubleRBTreeMap

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

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap(Float2DoubleMap m)

Creates a new tree map copying a given map.

Parameters:

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

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap(Float2DoubleSortedMap 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.

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap(float[] k,
                             double[] v,
                             java.util.Comparator<? super java.lang.Float> 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.

Float2DoubleRBTreeMap

public Float2DoubleRBTreeMap(float[] 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(float k,
                  double v)

Description copied from interface: Float2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Float2DoubleFunction

Overrides:

put in class AbstractFloat2DoubleFunction

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

Description copied from interface: Float2DoubleFunction

Removes the mapping with the given key.

Specified by:

remove in interface Float2DoubleFunction

Overrides:

remove in class AbstractFloat2DoubleFunction

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

Description copied from class: AbstractFloat2DoubleFunction

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

Specified by:

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

Overrides:

put in class AbstractFloat2DoubleFunction

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

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

Specified by:

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

Overrides:

remove in class AbstractFloat2DoubleFunction

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

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

Specified by:

containsValue in interface Float2DoubleMap

Overrides:

containsValue in class AbstractFloat2DoubleMap

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

Specified by:

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

Overrides:

clear in class AbstractFloat2DoubleFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(float k)

Description copied from class: AbstractFloat2DoubleMap

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

Specified by:

containsKey in interface Float2DoubleFunction

Overrides:

containsKey in class AbstractFloat2DoubleMap

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

Specified by:

size in interface java.util.Map<java.lang.Float,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.Float,java.lang.Double>

Overrides:

isEmpty in class AbstractFloat2DoubleMap

get

public double get(float k)

Description copied from interface: Float2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Float2DoubleFunction

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)

firstFloatKey

public float firstFloatKey()

Specified by:

firstFloatKey in interface Float2DoubleSortedMap

See Also:

SortedMap.firstKey()

lastFloatKey

public float lastFloatKey()

Specified by:

lastFloatKey in interface Float2DoubleSortedMap

See Also:

SortedMap.lastKey()

float2DoubleEntrySet

public ObjectSortedSet<Float2DoubleMap.Entry> float2DoubleEntrySet()

Description copied from interface: Float2DoubleSortedMap

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:

float2DoubleEntrySet in interface Float2DoubleMap

Specified by:

float2DoubleEntrySet in interface Float2DoubleSortedMap

Returns:

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

See Also:

Float2DoubleSortedMap.entrySet()

keySet

public FloatSortedSet 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 Float2DoubleMap

Specified by:

keySet in interface Float2DoubleSortedMap

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractFloat2DoubleSortedMap

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 Float2DoubleMap

Specified by:

values in interface Float2DoubleSortedMap

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractFloat2DoubleSortedMap

Returns:

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

See Also:

Map.values()

comparator

public FloatComparator comparator()

Description copied from interface: Float2DoubleSortedMap

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 Float2DoubleSortedMap

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Float2DoubleSortedMap headMap(float to)

Description copied from interface: Float2DoubleSortedMap

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

Specified by:

headMap in interface Float2DoubleSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Float2DoubleSortedMap tailMap(float from)

Description copied from interface: Float2DoubleSortedMap

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

Specified by:

tailMap in interface Float2DoubleSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Float2DoubleSortedMap subMap(float from,
                                    float to)

Description copied from interface: Float2DoubleSortedMap

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

Specified by:

subMap in interface Float2DoubleSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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