it.unimi.dsi.fastutil.floats

Class Float2ByteRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.floats.AbstractFloat2ByteFunction

it.unimi.dsi.fastutil.floats.AbstractFloat2ByteMap

it.unimi.dsi.fastutil.floats.AbstractFloat2ByteSortedMap

it.unimi.dsi.fastutil.floats.Float2ByteRBTreeMap

All Implemented Interfaces:

Float2ByteFunction, Float2ByteMap, Float2ByteSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.function.DoubleToIntFunction, java.util.function.Function<java.lang.Float,java.lang.Byte>, java.util.Map<java.lang.Float,java.lang.Byte>, java.util.SortedMap<java.lang.Float,java.lang.Byte>

public class Float2ByteRBTreeMap
extends AbstractFloat2ByteSortedMap
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.AbstractFloat2ByteMap

AbstractFloat2ByteMap.BasicEntry, AbstractFloat2ByteMap.BasicEntrySet

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

Float2ByteSortedMap.FastSortedEntrySet

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

Float2ByteMap.FastEntrySet

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
byte	addTo(float k, byte incr) Adds an increment to value currently associated with a key.
void	clear() Removes all of the mappings from this map (optional operation).
Float2ByteRBTreeMap	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(byte v) Returns true if this map maps one or more keys to the specified value.
float	firstFloatKey() Returns the first (lowest) key currently in this map.
ObjectSortedSet<Float2ByteMap.Entry>	float2ByteEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
byte	get(float k) Returns the value to which the given key is mapped.
Float2ByteSortedMap	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.
byte	put(float k, byte v) Adds a pair to the map (optional operation).
byte	remove(float k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Float2ByteSortedMap	subMap(float from, float to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Float2ByteSortedMap	tailMap(float from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ByteCollection	values() Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

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

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

applyAsInt

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, putAll, replaceAll

Constructor Detail

Float2ByteRBTreeMap

public Float2ByteRBTreeMap()

Creates a new empty tree map.

Float2ByteRBTreeMap

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

Float2ByteRBTreeMap

public Float2ByteRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Byte> m)

Creates a new tree map copying a given map.

Parameters:

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

Float2ByteRBTreeMap

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

Float2ByteRBTreeMap

public Float2ByteRBTreeMap(Float2ByteMap m)

Creates a new tree map copying a given map.

Parameters:

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

Float2ByteRBTreeMap

public Float2ByteRBTreeMap(Float2ByteSortedMap 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.

Float2ByteRBTreeMap

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

Float2ByteRBTreeMap

public Float2ByteRBTreeMap(float[] k,
                           byte[] 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

addTo

public byte addTo(float k,
                  byte incr)

Adds an increment to value currently associated with a key.

Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.

Parameters:

k - the key.

incr - the increment.

Returns:

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

put

public byte put(float k,
                byte v)

Description copied from interface: Float2ByteFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Float2ByteFunction

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

Description copied from interface: Float2ByteFunction

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

Specified by:

remove in interface Float2ByteFunction

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

Description copied from interface: Float2ByteMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Float2ByteMap

Overrides:

containsValue in class AbstractFloat2ByteMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Float2ByteMap

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

Specified by:

clear in interface Float2ByteMap

Specified by:

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

See Also:

Map.clear()

containsKey

public boolean containsKey(float k)

Description copied from interface: Float2ByteMap

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

Specified by:

containsKey in interface Float2ByteFunction

Specified by:

containsKey in interface Float2ByteMap

Overrides:

containsKey in class AbstractFloat2ByteMap

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

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 Float2ByteMap

Specified by:

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

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

Overrides:

isEmpty in class AbstractFloat2ByteMap

get

public byte get(float k)

Description copied from interface: Float2ByteFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Float2ByteFunction

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

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

Specified by:

firstFloatKey in interface Float2ByteSortedMap

See Also:

SortedMap.firstKey()

lastFloatKey

public float lastFloatKey()

Description copied from interface: Float2ByteSortedMap

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

Specified by:

lastFloatKey in interface Float2ByteSortedMap

See Also:

SortedMap.lastKey()

float2ByteEntrySet

public ObjectSortedSet<Float2ByteMap.Entry> float2ByteEntrySet()

Description copied from interface: Float2ByteSortedMap

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:

float2ByteEntrySet in interface Float2ByteMap

Specified by:

float2ByteEntrySet in interface Float2ByteSortedMap

Returns:

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

See Also:

Float2ByteSortedMap.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 Float2ByteMap

Specified by:

keySet in interface Float2ByteSortedMap

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractFloat2ByteSortedMap

Returns:

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

See Also:

Map.keySet()

values

public ByteCollection 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 Float2ByteMap

Specified by:

values in interface Float2ByteSortedMap

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractFloat2ByteSortedMap

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

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 Float2ByteSortedMap

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Float2ByteSortedMap headMap(float to)

Description copied from interface: Float2ByteSortedMap

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 Float2ByteSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Float2ByteSortedMap tailMap(float from)

Description copied from interface: Float2ByteSortedMap

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 Float2ByteSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Float2ByteSortedMap subMap(float from,
                                  float to)

Description copied from interface: Float2ByteSortedMap

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 Float2ByteSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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