it.unimi.dsi.fastutil.objects
Class Object2FloatRBTreeMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2FloatFunction<K>
      it.unimi.dsi.fastutil.objects.AbstractObject2FloatMap<K>
          it.unimi.dsi.fastutil.objects.AbstractObject2FloatSortedMap<K>
              it.unimi.dsi.fastutil.objects.Object2FloatRBTreeMap<K>

All Implemented Interfaces:

Function<K,java.lang.Float>, Object2FloatFunction<K>, Object2FloatMap<K>, Object2FloatSortedMap<K>, java.io.Serializable, java.lang.Cloneable, java.util.Map<K,java.lang.Float>, java.util.SortedMap<K,java.lang.Float>

public class Object2FloatRBTreeMap<K>
extends AbstractObject2FloatSortedMap<K>
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.objects.AbstractObject2FloatMap

AbstractObject2FloatMap.BasicEntry<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2FloatSortedMap

Object2FloatSortedMap.FastSortedEntrySet<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2FloatMap

Object2FloatMap.FastEntrySet<K>

Constructor Summary

Object2FloatRBTreeMap()
Creates a new empty tree map.

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

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

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

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

Object2FloatRBTreeMap(Object2FloatMap<? extends K> m)
Creates a new tree map copying a given map.

Object2FloatRBTreeMap(Object2FloatSortedMap<K> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Object2FloatRBTreeMap(java.util.SortedMap<K,java.lang.Float> 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).
Object2FloatRBTreeMap<K>	clone() Returns a deep copy of this tree map.
java.util.Comparator<? super K>	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(java.lang.Object k) Checks whether the given value is contained in AbstractObject2FloatMap.keySet().
boolean	containsValue(float v) Checks whether the given value is contained in AbstractObject2FloatMap.values().
K	firstKey()
java.lang.Float	get(java.lang.Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
float	getFloat(java.lang.Object k) Returns the value to which the given key is mapped.
Object2FloatSortedMap<K>	headMap(K to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
ObjectSortedSet<K>	keySet() Returns a type-specific sorted set view of the keys contained in this map.
K	lastKey()
ObjectSortedSet<Object2FloatMap.Entry<K>>	object2FloatEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
float	put(K k, float v) Adds a pair to the map.
java.lang.Float	put(K ok, java.lang.Float ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
java.lang.Float	remove(java.lang.Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
float	removeFloat(java.lang.Object k) Removes the mapping with the given key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
Object2FloatSortedMap<K>	subMap(K from, K to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Object2FloatSortedMap<K>	tailMap(K from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
FloatCollection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2FloatSortedMap

entrySet

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2FloatMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2FloatFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2FloatFunction

defaultReturnValue, defaultReturnValue

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, putAll

Constructor Detail

Object2FloatRBTreeMap

public Object2FloatRBTreeMap()

Creates a new empty tree map.

Object2FloatRBTreeMap

public Object2FloatRBTreeMap(java.util.Comparator<? super K> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Object2FloatRBTreeMap

public Object2FloatRBTreeMap(java.util.Map<? extends K,? extends java.lang.Float> m)

Creates a new tree map copying a given map.

Parameters:

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

Object2FloatRBTreeMap

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

Object2FloatRBTreeMap

public Object2FloatRBTreeMap(Object2FloatMap<? extends K> m)

Creates a new tree map copying a given map.

Parameters:

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

Object2FloatRBTreeMap

public Object2FloatRBTreeMap(Object2FloatSortedMap<K> 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.

Object2FloatRBTreeMap

public Object2FloatRBTreeMap(K[] k,
                             float[] v,
                             java.util.Comparator<? super K> 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.

Object2FloatRBTreeMap

public Object2FloatRBTreeMap(K[] 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:

java.lang.IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public float put(K k,
                 float v)

Description copied from interface: Object2FloatFunction

Adds a pair to the map.

Specified by:

put in interface Object2FloatFunction<K>

Overrides:

put in class AbstractObject2FloatFunction<K>

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)

removeFloat

public float removeFloat(java.lang.Object k)

Description copied from interface: Object2FloatFunction

Removes the mapping with the given key.

Specified by:

removeFloat in interface Object2FloatFunction<K>

Overrides:

removeFloat in class AbstractObject2FloatFunction<K>

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

Description copied from class: AbstractObject2FloatFunction

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

Specified by:

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

Overrides:

put in class AbstractObject2FloatFunction<K>

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.Float remove(java.lang.Object ok)

Description copied from class: AbstractObject2FloatFunction

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

Specified by:

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

Overrides:

remove in class AbstractObject2FloatFunction<K>

Returns:

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

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(float v)

Description copied from class: AbstractObject2FloatMap

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

Specified by:

containsValue in interface Object2FloatMap<K>

Overrides:

containsValue in class AbstractObject2FloatMap<K>

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

Specified by:

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

Overrides:

clear in class AbstractObject2FloatFunction<K>

See Also:

Map.clear()

containsKey

public boolean containsKey(java.lang.Object k)

Description copied from class: AbstractObject2FloatMap

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

Specified by:

containsKey in interface Function<K,java.lang.Float>

Specified by:

containsKey in interface java.util.Map<K,java.lang.Float>

Overrides:

containsKey in class AbstractObject2FloatMap<K>

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

Specified by:

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

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

Overrides:

isEmpty in class AbstractObject2FloatMap<K>

getFloat

public float getFloat(java.lang.Object k)

Description copied from interface: Object2FloatFunction

Returns the value to which the given key is mapped.

Specified by:

getFloat in interface Object2FloatFunction<K>

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)

get

public java.lang.Float get(java.lang.Object ok)

Description copied from class: AbstractObject2FloatFunction

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

Specified by:

get in interface java.util.Map<K,java.lang.Float>

Overrides:

get in class AbstractObject2FloatFunction<K>

Parameters:

ok - the key.

Returns:

the corresponding value, or null if no value was present for the given key.

See Also:

Map.get(Object)

firstKey

public K firstKey()

Specified by:

firstKey in interface java.util.SortedMap<K,java.lang.Float>

lastKey

public K lastKey()

Specified by:

lastKey in interface java.util.SortedMap<K,java.lang.Float>

object2FloatEntrySet

public ObjectSortedSet<Object2FloatMap.Entry<K>> object2FloatEntrySet()

Description copied from interface: Object2FloatSortedMap

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:

object2FloatEntrySet in interface Object2FloatMap<K>

Specified by:

object2FloatEntrySet in interface Object2FloatSortedMap<K>

Returns:

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

See Also:

Object2FloatSortedMap.entrySet()

keySet

public ObjectSortedSet<K> 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 Object2FloatMap<K>

Specified by:

keySet in interface Object2FloatSortedMap<K>

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractObject2FloatSortedMap<K>

Returns:

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

See Also:

Map.keySet()

values

public FloatCollection 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 Object2FloatMap<K>

Specified by:

values in interface Object2FloatSortedMap<K>

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractObject2FloatSortedMap<K>

Returns:

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

See Also:

Map.values()

comparator

public java.util.Comparator<? super K> comparator()

Description copied from interface: Object2FloatSortedMap

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 Object2FloatSortedMap<K>

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Object2FloatSortedMap<K> headMap(K to)

Description copied from interface: Object2FloatSortedMap

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

Note that this specification strengthens the one given in SortedMap.headMap(Object).

Specified by:

headMap in interface Object2FloatSortedMap<K>

Specified by:

headMap in interface java.util.SortedMap<K,java.lang.Float>

See Also:

SortedMap.headMap(Object)

tailMap

public Object2FloatSortedMap<K> tailMap(K from)

Description copied from interface: Object2FloatSortedMap

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

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

Specified by:

tailMap in interface Object2FloatSortedMap<K>

Specified by:

tailMap in interface java.util.SortedMap<K,java.lang.Float>

See Also:

SortedMap.tailMap(Object)

subMap

public Object2FloatSortedMap<K> subMap(K from,
                                       K to)

Description copied from interface: Object2FloatSortedMap

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

Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).

Specified by:

subMap in interface Object2FloatSortedMap<K>

Specified by:

subMap in interface java.util.SortedMap<K,java.lang.Float>

See Also:

SortedMap.subMap(Object,Object)

clone

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