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:

Function<Long,V>, Long2ObjectFunction<V>, Long2ObjectMap<V>, Long2ObjectSortedMap<V>, Serializable, Cloneable, Map<Long,V>, SortedMap<Long,V>

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

AbstractLong2ObjectMap.BasicEntry<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>

Field Summary

static long

serialVersionUID

Constructor Summary

Long2ObjectRBTreeMap()
Creates a new empty tree map.

Long2ObjectRBTreeMap(Comparator<? super 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, Comparator<? super 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(Map<? extends Long,? extends V> m)
Creates a new tree map copying a given map.

Long2ObjectRBTreeMap(SortedMap<Long,V> 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).
Object	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) Checks whether the given value is contained in AbstractLong2ObjectMap.keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in AbstractLong2ObjectMap.values().
long	firstLongKey()
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()
ObjectSortedSet<Long2ObjectMap.Entry<V>>	long2ObjectEntrySet() Returns a type-specific set view of the mappings contained in this map.
V	put(long k, V v) Adds a pair to the map.
V	put(Long ok, V ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
V	remove(long k) Removes the mapping with the given key.
V	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
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.AbstractLong2ObjectSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

defaultReturnValue, defaultReturnValue

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

containsKey, get

Methods inherited from interface java.util.Map

containsKey, equals, get, hashCode, putAll

Methods inherited from interface java.util.Map

containsKey, equals, get, hashCode, putAll

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap()

Creates a new empty tree map.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(Comparator<? super Long> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Long2ObjectRBTreeMap

public Long2ObjectRBTreeMap(Map<? extends 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(SortedMap<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,
                            Comparator<? super 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:

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:

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.

Specified by:

put in interface Long2ObjectFunction<V>

Overrides:

put in class AbstractLong2ObjectFunction<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.

Specified by:

remove in interface Long2ObjectFunction<V>

Overrides:

remove in class AbstractLong2ObjectFunction<V>

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 V put(Long ok,
             V ov)

Description copied from class: AbstractLong2ObjectFunction

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<Long,V>

Specified by:

put in interface Map<Long,V>

Overrides:

put in class AbstractLong2ObjectFunction<V>

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 V remove(Object ok)

Description copied from class: AbstractLong2ObjectFunction

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<Long,V>

Specified by:

remove in interface Map<Long,V>

Overrides:

remove in class AbstractLong2ObjectFunction<V>

Returns:

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

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractLong2ObjectMap

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

Specified by:

containsValue in interface Map<Long,V>

Overrides:

containsValue in class AbstractLong2ObjectMap<V>

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<Long,V>

Specified by:

clear in interface Map<Long,V>

Overrides:

clear in class AbstractLong2ObjectFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(long k)

Description copied from class: AbstractLong2ObjectMap

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

Specified by:

containsKey in interface Long2ObjectFunction<V>

Overrides:

containsKey in class AbstractLong2ObjectMap<V>

See Also:

Function.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<Long,V>

Specified by:

size in interface Map<Long,V>

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

Specified by:

firstLongKey in interface Long2ObjectSortedMap<V>

See Also:

SortedMap.firstKey()

lastLongKey

public long lastLongKey()

Specified by:

lastLongKey in interface Long2ObjectSortedMap<V>

See Also:

SortedMap.lastKey()

long2ObjectEntrySet

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

Description copied from interface: Long2ObjectMap

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

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Long2ObjectMap.entrySet() so that it returns an ObjectSet of objects of type Long2ObjectMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

long2ObjectEntrySet in interface Long2ObjectMap<V>

Specified by:

long2ObjectEntrySet in interface Long2ObjectSortedMap<V>

Returns:

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

See Also:

Long2ObjectMap.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 Map<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 Map<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 SortedMap<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.

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.

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.

Specified by:

subMap in interface Long2ObjectSortedMap<V>

See Also:

SortedMap.subMap(Object,Object)

clone

public Object 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 Object

Returns:

a deep copy of this tree map.