Package it.unimi.dsi.fastutil.objects

Class Object2LongRBTreeMap<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2LongFunction<K>

it.unimi.dsi.fastutil.objects.AbstractObject2LongMap<K>

it.unimi.dsi.fastutil.objects.AbstractObject2LongSortedMap<K>

it.unimi.dsi.fastutil.objects.Object2LongRBTreeMap<K>

All Implemented Interfaces:

Function<K,Long>, Object2LongFunction<K>, Object2LongMap<K>, Object2LongSortedMap<K>, Serializable, Cloneable, Function<K,Long>, ToLongFunction<K>, Map<K,Long>, SortedMap<K,Long>

public class Object2LongRBTreeMap<K>
extends AbstractObject2LongSortedMap<K>
implements Serializable, 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.AbstractObject2LongMap

AbstractObject2LongMap.BasicEntry<K>, AbstractObject2LongMap.BasicEntrySet<K>

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

Object2LongMap.FastEntrySet<K>

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

Object2LongSortedMap.FastSortedEntrySet<K>

Constructor Summary

Constructors

Constructor	Description
Object2LongRBTreeMap()	Creates a new empty tree map.
Object2LongRBTreeMap(Object2LongMap<? extends K> m)	Creates a new tree map copying a given map.
Object2LongRBTreeMap(Object2LongSortedMap<K> m)	Creates a new tree map copying a given sorted map (and its Comparator).
Object2LongRBTreeMap(Comparator<? super K> c)	Creates a new empty tree map with the given comparator.
Object2LongRBTreeMap(Map<? extends K,? extends Long> m)	Creates a new tree map copying a given map.
Object2LongRBTreeMap(SortedMap<K,Long> m)	Creates a new tree map copying a given sorted map (and its Comparator).
Object2LongRBTreeMap(K[] k, long[] v)	Creates a new tree map using the elements of two parallel arrays.
Object2LongRBTreeMap(K[] k, long[] v, Comparator<? super K> c)	Creates a new tree map using the elements of two parallel arrays and the given comparator.

Method Summary

Modifier and Type	Method	Description
long	addTo(K k, long incr)	Adds an increment to value currently associated with a key.
void	clear()	Removes all of the mappings from this map (optional operation).
Object2LongRBTreeMap<K>	clone()	Returns a deep copy of this tree map.
Comparator<? super K>	comparator()	Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(Object k)	Returns true if this function contains a mapping for the specified key.
boolean	containsValue(long v)	Returns true if this map maps one or more keys to the specified value.
K	firstKey()
long	getLong(Object k)	Returns the value to which the given key is mapped.
Object2LongSortedMap<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<Object2LongMap.Entry<K>>	object2LongEntrySet()	Returns a type-specific sorted-set view of the mappings contained in this map.
long	put(K k, long v)	Adds a pair to the map (optional operation).
long	removeLong(Object k)	Removes the mapping with the given key (optional operation).
int	size()	Returns the number of key/value mappings in this map.
Object2LongSortedMap<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.
Object2LongSortedMap<K>	tailMap(K from)	Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
LongCollection	values()	Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, get, hashCode, put, putAll, remove, replaceAll

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

applyAsLong

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

computeLong, computeLongIfAbsent, computeLongIfAbsentPartial, computeLongIfPresent, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, getOrDefault, merge, mergeLong, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

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

entrySet

Constructor Detail

Object2LongRBTreeMap

public Object2LongRBTreeMap()

Creates a new empty tree map.

Object2LongRBTreeMap

public Object2LongRBTreeMap(Comparator<? super K> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Object2LongRBTreeMap

public Object2LongRBTreeMap(Map<? extends K,? extends Long> m)

Creates a new tree map copying a given map.

Parameters:

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

Object2LongRBTreeMap

public Object2LongRBTreeMap(SortedMap<K,Long> 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.

Object2LongRBTreeMap

public Object2LongRBTreeMap(Object2LongMap<? 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.

Object2LongRBTreeMap

public Object2LongRBTreeMap(Object2LongSortedMap<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.

Object2LongRBTreeMap

public Object2LongRBTreeMap(K[] k,
                            long[] v,
                            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:

IllegalArgumentException - if k and v have different lengths.

Object2LongRBTreeMap

public Object2LongRBTreeMap(K[] k,
                            long[] 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:

IllegalArgumentException - if k and v have different lengths.

Method Detail

addTo

public long addTo(K k,
                  long 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 long put(K k,
                long v)

Description copied from interface: Object2LongFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Object2LongFunction<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)

removeLong

public long removeLong(Object k)

Description copied from interface: Object2LongFunction

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

Specified by:

removeLong in interface Object2LongFunction<K>

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

Description copied from interface: Object2LongMap

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

Specified by:

containsValue in interface Object2LongMap<K>

Overrides:

containsValue in class AbstractObject2LongMap<K>

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Object2LongMap

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

Specified by:

clear in interface Function<K,Long>

Specified by:

clear in interface Map<K,Long>

Specified by:

clear in interface Object2LongMap<K>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from interface: Object2LongMap

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

Specified by:

containsKey in interface Function<K,Long>

Specified by:

containsKey in interface Map<K,Long>

Specified by:

containsKey in interface Object2LongMap<K>

Overrides:

containsKey in class AbstractObject2LongMap<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: Object2LongMap

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 Function<K,Long>

Specified by:

size in interface Map<K,Long>

Specified by:

size in interface Object2LongMap<K>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Long>

Overrides:

isEmpty in class AbstractObject2LongMap<K>

getLong

public long getLong(Object k)

Description copied from interface: Object2LongFunction

Returns the value to which the given key is mapped.

Specified by:

getLong in interface Object2LongFunction<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)

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,Long>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,Long>

object2LongEntrySet

public ObjectSortedSet<Object2LongMap.Entry<K>> object2LongEntrySet()

Description copied from interface: Object2LongSortedMap

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:

object2LongEntrySet in interface Object2LongMap<K>

Specified by:

object2LongEntrySet in interface Object2LongSortedMap<K>

Returns:

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

See Also:

Object2LongSortedMap.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 Map<K,Long>

Specified by:

keySet in interface Object2LongMap<K>

Specified by:

keySet in interface Object2LongSortedMap<K>

Specified by:

keySet in interface SortedMap<K,Long>

Overrides:

keySet in class AbstractObject2LongSortedMap<K>

Returns:

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

See Also:

Map.keySet()

values

public LongCollection 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 Map<K,Long>

Specified by:

values in interface Object2LongMap<K>

Specified by:

values in interface Object2LongSortedMap<K>

Specified by:

values in interface SortedMap<K,Long>

Overrides:

values in class AbstractObject2LongSortedMap<K>

Returns:

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

See Also:

Map.values()

comparator

public Comparator<? super K> comparator()

Description copied from interface: Object2LongSortedMap

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

Specified by:

comparator in interface SortedMap<K,Long>

See Also:

SortedMap.comparator()

headMap

public Object2LongSortedMap<K> headMap(K to)

Description copied from interface: Object2LongSortedMap

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

Specified by:

headMap in interface SortedMap<K,Long>

See Also:

SortedMap.headMap(Object)

tailMap

public Object2LongSortedMap<K> tailMap(K from)

Description copied from interface: Object2LongSortedMap

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

Specified by:

tailMap in interface SortedMap<K,Long>

See Also:

SortedMap.tailMap(Object)

subMap

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

Description copied from interface: Object2LongSortedMap

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

Specified by:

subMap in interface SortedMap<K,Long>

See Also:

SortedMap.subMap(Object,Object)

clone

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

Returns:

a deep copy of this tree map.