it.unimi.dsi.fastutil.longs
Class Long2ReferenceAVLTreeMap<V>

java.lang.Object
  it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceFunction<V>
      it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceMap<V>
          it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceSortedMap<V>
              it.unimi.dsi.fastutil.longs.Long2ReferenceAVLTreeMap<V>

All Implemented Interfaces:

Function<java.lang.Long,V>, Long2ReferenceFunction<V>, Long2ReferenceMap<V>, Long2ReferenceSortedMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Long,V>, java.util.SortedMap<java.lang.Long,V>

public class Long2ReferenceAVLTreeMap<V>
extends AbstractLong2ReferenceSortedMap<V>
implements java.io.Serializable, java.lang.Cloneable

A type-specific AVL 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.AbstractLong2ReferenceMap

AbstractLong2ReferenceMap.BasicEntry<V>

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

Long2ReferenceSortedMap.FastSortedEntrySet<V>

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

Long2ReferenceMap.FastEntrySet<V>

Constructor Summary

Long2ReferenceAVLTreeMap()
Creates a new empty tree map.

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

Long2ReferenceAVLTreeMap(long[] k, V[] v)
Creates a new tree map using the elements of two parallel arrays.

Long2ReferenceAVLTreeMap(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.

Long2ReferenceAVLTreeMap(Long2ReferenceMap<? extends V> m)
Creates a new tree map copying a given map.

Long2ReferenceAVLTreeMap(Long2ReferenceSortedMap<V> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Long2ReferenceAVLTreeMap(java.util.Map<? extends java.lang.Long,? extends V> m)
Creates a new tree map copying a given map.

Long2ReferenceAVLTreeMap(java.util.SortedMap<java.lang.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).
Long2ReferenceAVLTreeMap<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) Checks whether the given value is contained in AbstractLong2ReferenceMap.keySet().
boolean	containsValue(java.lang.Object v) Checks whether the given value is contained in AbstractLong2ReferenceMap.values().
long	firstLongKey()
V	get(long k) Returns the value to which the given key is mapped.
Long2ReferenceSortedMap<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<Long2ReferenceMap.Entry<V>>	long2ReferenceEntrySet() 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.
V	put(java.lang.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(java.lang.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.
Long2ReferenceSortedMap<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.
Long2ReferenceSortedMap<V>	tailMap(long from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ReferenceCollection<V>	values() Returns a type-specific collection view of the values contained in this map.

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

equals, hashCode, putAll, toString

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

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.Long2ReferenceFunction

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

Constructor Detail

Long2ReferenceAVLTreeMap

public Long2ReferenceAVLTreeMap()

Creates a new empty tree map.

Long2ReferenceAVLTreeMap

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

Long2ReferenceAVLTreeMap

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

Long2ReferenceAVLTreeMap

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

Long2ReferenceAVLTreeMap

public Long2ReferenceAVLTreeMap(Long2ReferenceMap<? 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.

Long2ReferenceAVLTreeMap

public Long2ReferenceAVLTreeMap(Long2ReferenceSortedMap<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.

Long2ReferenceAVLTreeMap

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

Long2ReferenceAVLTreeMap

public Long2ReferenceAVLTreeMap(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: Long2ReferenceFunction

Adds a pair to the map.

Specified by:

put in interface Long2ReferenceFunction<V>

Overrides:

put in class AbstractLong2ReferenceFunction<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: Long2ReferenceFunction

Removes the mapping with the given key.

Specified by:

remove in interface Long2ReferenceFunction<V>

Overrides:

remove in class AbstractLong2ReferenceFunction<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(java.lang.Long ok,
             V ov)

Description copied from class: AbstractLong2ReferenceFunction

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

Specified by:

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

Overrides:

put in class AbstractLong2ReferenceFunction<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(java.lang.Object ok)

Description copied from class: AbstractLong2ReferenceFunction

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

Specified by:

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

Overrides:

remove in class AbstractLong2ReferenceFunction<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(java.lang.Object v)

Description copied from class: AbstractLong2ReferenceMap

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

Specified by:

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

Overrides:

containsValue in class AbstractLong2ReferenceMap<V>

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<java.lang.Long,V>

Specified by:

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

Overrides:

clear in class AbstractLong2ReferenceFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(long k)

Description copied from class: AbstractLong2ReferenceMap

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

Specified by:

containsKey in interface Long2ReferenceFunction<V>

Overrides:

containsKey in class AbstractLong2ReferenceMap<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<java.lang.Long,V>

Specified by:

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

Overrides:

isEmpty in class AbstractLong2ReferenceMap<V>

get

public V get(long k)

Description copied from interface: Long2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Long2ReferenceFunction<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 Long2ReferenceSortedMap<V>

See Also:

SortedMap.firstKey()

lastLongKey

public long lastLongKey()

Specified by:

lastLongKey in interface Long2ReferenceSortedMap<V>

See Also:

SortedMap.lastKey()

long2ReferenceEntrySet

public ObjectSortedSet<Long2ReferenceMap.Entry<V>> long2ReferenceEntrySet()

Description copied from interface: Long2ReferenceSortedMap

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:

long2ReferenceEntrySet in interface Long2ReferenceMap<V>

Specified by:

long2ReferenceEntrySet in interface Long2ReferenceSortedMap<V>

Returns:

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

See Also:

Long2ReferenceSortedMap.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 Long2ReferenceMap<V>

Specified by:

keySet in interface Long2ReferenceSortedMap<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 AbstractLong2ReferenceSortedMap<V>

Returns:

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

See Also:

Map.keySet()

values

public ReferenceCollection<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 Long2ReferenceMap<V>

Specified by:

values in interface Long2ReferenceSortedMap<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 AbstractLong2ReferenceSortedMap<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: Long2ReferenceSortedMap

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

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Long2ReferenceSortedMap<V> headMap(long to)

Description copied from interface: Long2ReferenceSortedMap

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

Specified by:

headMap in interface Long2ReferenceSortedMap<V>

See Also:

SortedMap.headMap(Object)

tailMap

public Long2ReferenceSortedMap<V> tailMap(long from)

Description copied from interface: Long2ReferenceSortedMap

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

Specified by:

tailMap in interface Long2ReferenceSortedMap<V>

See Also:

SortedMap.tailMap(Object)

subMap

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

Description copied from interface: Long2ReferenceSortedMap

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

Specified by:

subMap in interface Long2ReferenceSortedMap<V>

See Also:

SortedMap.subMap(Object,Object)

clone

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