Package it.unimi.dsi.fastutil.floats

Class Float2ObjectRBTreeMap<V>

java.lang.Object

it.unimi.dsi.fastutil.floats.AbstractFloat2ObjectFunction<V>

it.unimi.dsi.fastutil.floats.AbstractFloat2ObjectMap<V>

it.unimi.dsi.fastutil.floats.AbstractFloat2ObjectSortedMap<V>

it.unimi.dsi.fastutil.floats.Float2ObjectRBTreeMap<V>

All Implemented Interfaces:

Float2ObjectFunction<V>, Float2ObjectMap<V>, Float2ObjectSortedMap<V>, Function<java.lang.Float,V>, java.io.Serializable, java.lang.Cloneable, java.util.function.DoubleFunction<V>, java.util.function.Function<java.lang.Float,V>, java.util.Map<java.lang.Float,V>, java.util.SortedMap<java.lang.Float,V>

public class Float2ObjectRBTreeMap<V>
extends AbstractFloat2ObjectSortedMap<V>
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.AbstractFloat2ObjectMap

AbstractFloat2ObjectMap.BasicEntry<V>, AbstractFloat2ObjectMap.BasicEntrySet<V>

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

Float2ObjectMap.FastEntrySet<V>

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

Float2ObjectSortedMap.FastSortedEntrySet<V>

Constructor Summary

Constructors

Constructor	Description
Float2ObjectRBTreeMap()	Creates a new empty tree map.
Float2ObjectRBTreeMap(float[] k, V[] v)	Creates a new tree map using the elements of two parallel arrays.
Float2ObjectRBTreeMap(float[] k, V[] 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.
Float2ObjectRBTreeMap(Float2ObjectMap<? extends V> m)	Creates a new tree map copying a given map.
Float2ObjectRBTreeMap(Float2ObjectSortedMap<V> m)	Creates a new tree map copying a given sorted map (and its Comparator).
Float2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Float> c)	Creates a new empty tree map with the given comparator.
Float2ObjectRBTreeMap(java.util.Map<? extends java.lang.Float,? extends V> m)	Creates a new tree map copying a given map.
Float2ObjectRBTreeMap(java.util.SortedMap<java.lang.Float,V> m)	Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all of the mappings from this map (optional operation).
Float2ObjectRBTreeMap<V>	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)	Returns true if this function contains a mapping for the specified key.
boolean	containsValue(java.lang.Object v)
float	firstFloatKey()	Returns the first (lowest) key currently in this map.
ObjectSortedSet<Float2ObjectMap.Entry<V>>	float2ObjectEntrySet()	Returns a type-specific sorted-set view of the mappings contained in this map.
V	get(float k)	Returns the value to which the given key is mapped.
Float2ObjectSortedMap<V>	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()	Returns the last (highest) key currently in this map.
V	put(float k, V v)	Adds a pair to the map (optional operation).
V	remove(float k)	Removes the mapping with the given key (optional operation).
int	size()	Returns the number of key/value mappings in this map.
Float2ObjectSortedMap<V>	subMap(float from, float to)	Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Float2ObjectSortedMap<V>	tailMap(float from)	Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ObjectCollection<V>	values()	Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.floats.Float2ObjectFunction

andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

Methods inherited from interface it.unimi.dsi.fastutil.floats.Float2ObjectMap

compute, computeIfAbsent, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, containsKey, defaultReturnValue, defaultReturnValue, forEach, get, getOrDefault, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replace

Methods inherited from interface it.unimi.dsi.fastutil.floats.Float2ObjectSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.Function

andThen

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, get, getOrDefault, hashCode, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Constructor Detail

Float2ObjectRBTreeMap

public Float2ObjectRBTreeMap()

Creates a new empty tree map.

Float2ObjectRBTreeMap

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

Float2ObjectRBTreeMap

public Float2ObjectRBTreeMap(java.util.Map<? extends java.lang.Float,? extends V> m)

Creates a new tree map copying a given map.

Parameters:

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

Float2ObjectRBTreeMap

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

Float2ObjectRBTreeMap

public Float2ObjectRBTreeMap(Float2ObjectMap<? extends V> m)

Creates a new tree map copying a given map.

Parameters:

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

Float2ObjectRBTreeMap

public Float2ObjectRBTreeMap(Float2ObjectSortedMap<V> 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.

Float2ObjectRBTreeMap

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

Float2ObjectRBTreeMap

public Float2ObjectRBTreeMap(float[] k,
                             V[] 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 V put(float k,
             V v)

Description copied from interface: Float2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Float2ObjectFunction<V>

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

Description copied from interface: Float2ObjectFunction

Removes the mapping with the given key (optional operation).

Specified by:

remove in interface Float2ObjectFunction<V>

Parameters:

k - the key.

Returns:

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

See Also:

Function.remove(Object)

containsValue

public boolean containsValue(java.lang.Object v)

Description copied from class: AbstractFloat2ObjectMap

Specified by:

containsValue in interface java.util.Map<java.lang.Float,V>

Overrides:

containsValue in class AbstractFloat2ObjectMap<V>

clear

public void clear()

Description copied from interface: Float2ObjectMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Float2ObjectMap<V>

Specified by:

clear in interface Function<java.lang.Float,V>

Specified by:

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

See Also:

Map.clear()

containsKey

public boolean containsKey(float k)

Description copied from class: AbstractFloat2ObjectMap

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface Float2ObjectFunction<V>

Specified by:

containsKey in interface Float2ObjectMap<V>

Overrides:

containsKey in class AbstractFloat2ObjectMap<V>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

size

public int size()

Description copied from interface: Float2ObjectMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Float2ObjectMap<V>

Specified by:

size in interface Function<java.lang.Float,V>

Specified by:

size in interface java.util.Map<java.lang.Float,V>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Float,V>

Overrides:

isEmpty in class AbstractFloat2ObjectMap<V>

get

public V get(float k)

Description copied from interface: Float2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Float2ObjectFunction<V>

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

Description copied from interface: Float2ObjectSortedMap

Returns the first (lowest) key currently in this map.

Specified by:

firstFloatKey in interface Float2ObjectSortedMap<V>

See Also:

SortedMap.firstKey()

lastFloatKey

public float lastFloatKey()

Description copied from interface: Float2ObjectSortedMap

Returns the last (highest) key currently in this map.

Specified by:

lastFloatKey in interface Float2ObjectSortedMap<V>

See Also:

SortedMap.lastKey()

float2ObjectEntrySet

public ObjectSortedSet<Float2ObjectMap.Entry<V>> float2ObjectEntrySet()

Description copied from interface: Float2ObjectSortedMap

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

Specified by:

float2ObjectEntrySet in interface Float2ObjectMap<V>

Specified by:

float2ObjectEntrySet in interface Float2ObjectSortedMap<V>

Returns:

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

See Also:

Float2ObjectSortedMap.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 Float2ObjectMap<V>

Specified by:

keySet in interface Float2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractFloat2ObjectSortedMap<V>

Returns:

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

See Also:

Map.keySet()

values

public ObjectCollection<V> 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 Float2ObjectMap<V>

Specified by:

values in interface Float2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractFloat2ObjectSortedMap<V>

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

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Specified by:

comparator in interface Float2ObjectSortedMap<V>

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Float2ObjectSortedMap<V> headMap(float to)

Description copied from interface: Float2ObjectSortedMap

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

Specified by:

headMap in interface Float2ObjectSortedMap<V>

See Also:

SortedMap.headMap(Object)

tailMap

public Float2ObjectSortedMap<V> tailMap(float from)

Description copied from interface: Float2ObjectSortedMap

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

Specified by:

tailMap in interface Float2ObjectSortedMap<V>

See Also:

SortedMap.tailMap(Object)

subMap

public Float2ObjectSortedMap<V> subMap(float from,
                                       float to)

Description copied from interface: Float2ObjectSortedMap

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

Specified by:

subMap in interface Float2ObjectSortedMap<V>

See Also:

SortedMap.subMap(Object,Object)

clone

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