it.unimi.dsi.fastutil.longs

Class Long2ObjectRBTreeMap<V>

java.lang.Object

it.unimi.dsi.fastutil.longs.AbstractLong2ObjectFunction<V>

it.unimi.dsi.fastutil.longs.AbstractLong2ObjectMap<V>

it.unimi.dsi.fastutil.longs.AbstractLong2ObjectSortedMap<V>

it.unimi.dsi.fastutil.longs.Long2ObjectRBTreeMap<V>

All Implemented Interfaces:

Long2ObjectFunction<V>, Long2ObjectMap<V>, Long2ObjectSortedMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Long,V>, java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, java.util.SortedMap<java.lang.Long,V>

public class Long2ObjectRBTreeMap<V>
extends AbstractLong2ObjectSortedMap<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.longs.AbstractLong2ObjectMap

AbstractLong2ObjectMap.BasicEntry<V>, AbstractLong2ObjectMap.BasicEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectSortedMap

Long2ObjectSortedMap.FastSortedEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectMap

Long2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors

Constructor and Description
Long2ObjectRBTreeMap() Creates a new empty tree map.
Long2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Long> c) Creates a new empty tree map with the given comparator.
Long2ObjectRBTreeMap(long[] k, V[] v) Creates a new tree map using the elements of two parallel arrays.
Long2ObjectRBTreeMap(long[] k, V[] v, java.util.Comparator<? super java.lang.Long> c) Creates a new tree map using the elements of two parallel arrays and the given comparator.
Long2ObjectRBTreeMap(Long2ObjectMap<? extends V> m) Creates a new tree map copying a given map.
Long2ObjectRBTreeMap(Long2ObjectSortedMap<V> m) Creates a new tree map copying a given sorted map (and its Comparator).
Long2ObjectRBTreeMap(java.util.Map<? extends java.lang.Long,? extends V> m) Creates a new tree map copying a given map.
Long2ObjectRBTreeMap(java.util.SortedMap<java.lang.Long,V> m) Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
Long2ObjectRBTreeMap<V>	clone() Returns a deep copy of this tree map.
LongComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(long k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(java.lang.Object v)
long	firstLongKey() Returns the first (lowest) key currently in this map.
V	get(long k) Returns the value to which the given key is mapped.
Long2ObjectSortedMap<V>	headMap(long to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
LongSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
long	lastLongKey() Returns the last (highest) key currently in this map.
ObjectSortedSet<Long2ObjectMap.Entry<V>>	long2ObjectEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
V	put(long k, V v) Adds a pair to the map (optional operation).
V	remove(long k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Long2ObjectSortedMap<V>	subMap(long from, long to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Long2ObjectSortedMap<V>	tailMap(long 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.longs.AbstractLong2ObjectMap

equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ObjectFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2ObjectMap

compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, 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.longs.Long2ObjectFunction

apply

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

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap()

Creates a new empty tree map.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Long> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(java.util.Map<? extends java.lang.Long,? extends V> m)

Creates a new tree map copying a given map.

Parameters:

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

Long2ObjectRBTreeMap

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

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(Long2ObjectMap<? 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.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(Long2ObjectSortedMap<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.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(long[] k,
                            V[] v,
                            java.util.Comparator<? super java.lang.Long> 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.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(long[] 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(long k,
             V v)

Description copied from interface: Long2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Long2ObjectFunction<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(long k)

Description copied from interface: Long2ObjectFunction

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

Specified by:

remove in interface Long2ObjectFunction<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)

Specified by:

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

Overrides:

containsValue in class AbstractLong2ObjectMap<V>

clear

public void clear()

Description copied from interface: Long2ObjectMap

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

Specified by:

clear in interface Long2ObjectMap<V>

Specified by:

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

See Also:

Map.clear()

containsKey

public boolean containsKey(long k)

Description copied from interface: Long2ObjectMap

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

Specified by:

containsKey in interface Long2ObjectFunction<V>

Specified by:

containsKey in interface Long2ObjectMap<V>

Overrides:

containsKey in class AbstractLong2ObjectMap<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: Long2ObjectMap

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 Long2ObjectMap<V>

Specified by:

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

Overrides:

isEmpty in class AbstractLong2ObjectMap<V>

get

public V get(long k)

Description copied from interface: Long2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Long2ObjectFunction<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)

firstLongKey

public long firstLongKey()

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

firstLongKey in interface Long2ObjectSortedMap<V>

See Also:

SortedMap.firstKey()

lastLongKey

public long lastLongKey()

Description copied from interface: Long2ObjectSortedMap

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

Specified by:

lastLongKey in interface Long2ObjectSortedMap<V>

See Also:

SortedMap.lastKey()

long2ObjectEntrySet

public ObjectSortedSet<Long2ObjectMap.Entry<V>> long2ObjectEntrySet()

Description copied from interface: Long2ObjectSortedMap

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:

long2ObjectEntrySet in interface Long2ObjectMap<V>

Specified by:

long2ObjectEntrySet in interface Long2ObjectSortedMap<V>

Returns:

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

See Also:

Long2ObjectSortedMap.entrySet()

keySet

public LongSortedSet 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 Long2ObjectMap<V>

Specified by:

keySet in interface Long2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractLong2ObjectSortedMap<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 Long2ObjectMap<V>

Specified by:

values in interface Long2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractLong2ObjectSortedMap<V>

Returns:

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

See Also:

Map.values()

comparator

public LongComparator comparator()

Description copied from interface: Long2ObjectSortedMap

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 Long2ObjectSortedMap<V>

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Long2ObjectSortedMap<V> headMap(long to)

Description copied from interface: Long2ObjectSortedMap

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 Long2ObjectSortedMap<V>

See Also:

SortedMap.headMap(Object)

tailMap

public Long2ObjectSortedMap<V> tailMap(long from)

Description copied from interface: Long2ObjectSortedMap

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 Long2ObjectSortedMap<V>

See Also:

SortedMap.tailMap(Object)

subMap

public Long2ObjectSortedMap<V> subMap(long from,
                                      long to)

Description copied from interface: Long2ObjectSortedMap

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 Long2ObjectSortedMap<V>

See Also:

SortedMap.subMap(Object,Object)

clone

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

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of this tree map.