it.unimi.dsi.fastutil.objects
Class Object2LongAVLTreeMap<K>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2LongFunction<K>
      extended by it.unimi.dsi.fastutil.objects.AbstractObject2LongMap<K>
          extended by it.unimi.dsi.fastutil.objects.AbstractObject2LongSortedMap<K>
              extended by it.unimi.dsi.fastutil.objects.Object2LongAVLTreeMap<K>
All Implemented Interfaces:
Function<K,Long>, Object2LongFunction<K>, Object2LongMap<K>, Object2LongSortedMap<K>, Serializable, Cloneable, Map<K,Long>, SortedMap<K,Long>

public class Object2LongAVLTreeMap<K>
extends AbstractObject2LongSortedMap<K>
implements Serializable, 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.objects.AbstractObject2LongMap
AbstractObject2LongMap.BasicEntry<K>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2LongSortedMap
Object2LongSortedMap.FastSortedEntrySet<K>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2LongMap
Object2LongMap.FastEntrySet<K>
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Object2LongAVLTreeMap()
          Creates a new empty tree map.
Object2LongAVLTreeMap(Comparator<? super K> c)
          Creates a new empty tree map with the given comparator.
Object2LongAVLTreeMap(K[] k, long[] v)
          Creates a new tree map using the elements of two parallel arrays.
Object2LongAVLTreeMap(K[] k, long[] v, Comparator<? super K> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Object2LongAVLTreeMap(Map<? extends K,? extends Long> m)
          Creates a new tree map copying a given map.
Object2LongAVLTreeMap(Object2LongMap<? extends K> m)
          Creates a new tree map copying a given map.
Object2LongAVLTreeMap(Object2LongSortedMap<K> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Object2LongAVLTreeMap(SortedMap<K,Long> 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.
 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)
          Checks whether the given value is contained in AbstractObject2LongMap.keySet().
 boolean containsValue(long v)
          Checks whether the given value is contained in AbstractObject2LongMap.values().
 K firstKey()
           
 Long get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 long getLong(Object k)
          Returns the value to which the given key is mapped.
 Object2LongSortedMap<K> headMap(K to)
          Delegates to the corresponding type-specific method.
 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 set view of the mappings contained in this map.
 long put(K k, long v)
          Adds a pair to the map.
 Long put(K ok, Long ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Long remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 long removeLong(Object k)
          Removes the mapping with the given key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 Object2LongSortedMap<K> subMap(K from, K to)
          Delegates to the corresponding type-specific method.
 Object2LongSortedMap<K> tailMap(K from)
          Delegates to the corresponding type-specific method.
 LongCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2LongSortedMap
entrySet
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2LongMap
containsValue, 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.objects.Object2LongFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface java.util.Map
containsValue, equals, hashCode, putAll
 
Methods inherited from interface java.util.Map
containsValue, equals, hashCode, putAll
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Object2LongAVLTreeMap

public Object2LongAVLTreeMap()
Creates a new empty tree map.


Object2LongAVLTreeMap

public Object2LongAVLTreeMap(Comparator<? super K> c)
Creates a new empty tree map with the given comparator.

Parameters:
c - a (possibly type-specific) comparator.

Object2LongAVLTreeMap

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

Object2LongAVLTreeMap

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

Object2LongAVLTreeMap

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

Object2LongAVLTreeMap

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

Object2LongAVLTreeMap

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

Object2LongAVLTreeMap

public Object2LongAVLTreeMap(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

put

public long put(K k,
                long v)
Description copied from interface: Object2LongFunction
Adds a pair to the map.

Specified by:
put in interface Object2LongFunction<K>
Overrides:
put in class AbstractObject2LongFunction<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.

Specified by:
removeLong in interface Object2LongFunction<K>
Overrides:
removeLong in class AbstractObject2LongFunction<K>
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 Long put(K ok,
                Long ov)
Description copied from class: AbstractObject2LongFunction
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<K,Long>
Specified by:
put in interface Map<K,Long>
Overrides:
put in class AbstractObject2LongFunction<K>
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 Long remove(Object ok)
Description copied from class: AbstractObject2LongFunction
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<K,Long>
Specified by:
remove in interface Map<K,Long>
Overrides:
remove in class AbstractObject2LongFunction<K>
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

containsValue

public boolean containsValue(long v)
Description copied from class: AbstractObject2LongMap
Checks whether the given value is contained in AbstractObject2LongMap.values().

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: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<K,Long>
Specified by:
clear in interface Map<K,Long>
Overrides:
clear in class AbstractObject2LongFunction<K>
See Also:
Map.clear()

containsKey

public boolean containsKey(Object k)
Description copied from class: AbstractObject2LongMap
Checks whether the given value is contained in AbstractObject2LongMap.keySet().

Specified by:
containsKey in interface Function<K,Long>
Specified by:
containsKey in interface Map<K,Long>
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: 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<K,Long>
Specified by:
size in interface Map<K,Long>
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<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)

get

public Long get(Object ok)
Description copied from class: AbstractObject2LongFunction
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:
get in interface Function<K,Long>
Specified by:
get in interface Map<K,Long>
Overrides:
get in class AbstractObject2LongFunction<K>
Parameters:
ok - the key.
Returns:
the corresponding value, or null if no value was present for the given key.
See Also:
Map.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: Object2LongMap
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 Object2LongMap.entrySet() so that it returns an ObjectSet of objects of type Object2LongMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
object2LongEntrySet in interface Object2LongMap<K>
Specified by:
object2LongEntrySet in interface Object2LongSortedMap<K>
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Object2LongMap.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 Object2LongMap<K>
Specified by:
keySet in interface Object2LongSortedMap<K>
Specified by:
keySet in interface Map<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 Object2LongMap<K>
Specified by:
values in interface Object2LongSortedMap<K>
Specified by:
values in interface Map<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 class: AbstractObject2LongSortedMap
Delegates to the corresponding type-specific method.

Specified by:
headMap in interface Object2LongSortedMap<K>
Specified by:
headMap in interface SortedMap<K,Long>
Overrides:
headMap in class AbstractObject2LongSortedMap<K>
See Also:
SortedMap.headMap(Object)

tailMap

public Object2LongSortedMap<K> tailMap(K from)
Description copied from class: AbstractObject2LongSortedMap
Delegates to the corresponding type-specific method.

Specified by:
tailMap in interface Object2LongSortedMap<K>
Specified by:
tailMap in interface SortedMap<K,Long>
Overrides:
tailMap in class AbstractObject2LongSortedMap<K>
See Also:
SortedMap.tailMap(Object)

subMap

public Object2LongSortedMap<K> subMap(K from,
                                      K to)
Description copied from class: AbstractObject2LongSortedMap
Delegates to the corresponding type-specific method.

Specified by:
subMap in interface Object2LongSortedMap<K>
Specified by:
subMap in interface SortedMap<K,Long>
Overrides:
subMap in class AbstractObject2LongSortedMap<K>
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.