it.unimi.dsi.fastutil.objects
Class Object2ReferenceAVLTreeMap<K,V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction<K,V>
      extended by it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceMap<K,V>
          extended by it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceSortedMap<K,V>
              extended by it.unimi.dsi.fastutil.objects.Object2ReferenceAVLTreeMap<K,V>
All Implemented Interfaces:
Function<K,V>, Object2ReferenceFunction<K,V>, Object2ReferenceMap<K,V>, Object2ReferenceSortedMap<K,V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<K,V>, java.util.SortedMap<K,V>

public class Object2ReferenceAVLTreeMap<K,V>
extends AbstractObject2ReferenceSortedMap<K,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.objects.AbstractObject2ReferenceMap
AbstractObject2ReferenceMap.BasicEntry<K,V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceSortedMap
Object2ReferenceSortedMap.FastSortedEntrySet<K,V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceMap
Object2ReferenceMap.FastEntrySet<K,V>
 
Constructor Summary
Object2ReferenceAVLTreeMap()
          Creates a new empty tree map.
Object2ReferenceAVLTreeMap(java.util.Comparator<? super K> c)
          Creates a new empty tree map with the given comparator.
Object2ReferenceAVLTreeMap(K[] k, V[] v)
          Creates a new tree map using the elements of two parallel arrays.
Object2ReferenceAVLTreeMap(K[] k, V[] v, java.util.Comparator<? super K> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Object2ReferenceAVLTreeMap(java.util.Map<? extends K,? extends V> m)
          Creates a new tree map copying a given map.
Object2ReferenceAVLTreeMap(Object2ReferenceMap<? extends K,? extends V> m)
          Creates a new tree map copying a given map.
Object2ReferenceAVLTreeMap(Object2ReferenceSortedMap<K,V> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Object2ReferenceAVLTreeMap(java.util.SortedMap<K,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).
 Object2ReferenceAVLTreeMap<K,V> clone()
          Returns a deep copy of this tree map.
 java.util.Comparator<? super K> comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(java.lang.Object k)
          Checks whether the given value is contained in AbstractObject2ReferenceMap.keySet().
 boolean containsValue(java.lang.Object v)
          Checks whether the given value is contained in AbstractObject2ReferenceMap.values().
 K firstKey()
           
 V get(java.lang.Object k)
          Returns the value associated by this function to the specified key.
 Object2ReferenceSortedMap<K,V> 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<Object2ReferenceMap.Entry<K,V>> object2ReferenceEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 V put(K k, V v)
          Associates the specified value with the specified key in this function (optional operation).
 V remove(java.lang.Object k)
          Removes this key and the associated value from this function if it is present (optional operation).
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 Object2ReferenceSortedMap<K,V> subMap(K from, K to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Object2ReferenceSortedMap<K,V> tailMap(K 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.objects.AbstractObject2ReferenceSortedMap
entrySet
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceMap
equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface java.util.Map
equals, hashCode, putAll
 

Constructor Detail

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap()
Creates a new empty tree map.


Object2ReferenceAVLTreeMap

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

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

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap(java.util.Map<? extends K,? extends V> m)
Creates a new tree map copying a given map.

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

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap(java.util.SortedMap<K,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.

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap(Object2ReferenceMap<? extends K,? 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.

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap(Object2ReferenceSortedMap<K,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.

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap(K[] k,
                                  V[] v,
                                  java.util.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:
java.lang.IllegalArgumentException - if k and v have different lengths.

Object2ReferenceAVLTreeMap

public Object2ReferenceAVLTreeMap(K[] 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(K k,
             V v)
Description copied from interface: Function
Associates the specified value with the specified key in this function (optional operation).

Specified by:
put in interface Function<K,V>
Specified by:
put in interface java.util.Map<K,V>
Overrides:
put in class AbstractObject2ReferenceFunction<K,V>
Parameters:
k - the key.
v - 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 k)
Description copied from interface: Function
Removes this key and the associated value from this function if it is present (optional operation).

Specified by:
remove in interface Function<K,V>
Specified by:
remove in interface java.util.Map<K,V>
Overrides:
remove in class AbstractObject2ReferenceFunction<K,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: AbstractObject2ReferenceMap
Checks whether the given value is contained in AbstractObject2ReferenceMap.values().

Specified by:
containsValue in interface java.util.Map<K,V>
Overrides:
containsValue in class AbstractObject2ReferenceMap<K,V>

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<K,V>
Specified by:
clear in interface java.util.Map<K,V>
Overrides:
clear in class AbstractObject2ReferenceFunction<K,V>
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Function<K,V>
Specified by:
containsKey in interface java.util.Map<K,V>
Overrides:
containsKey in class AbstractObject2ReferenceMap<K,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: 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,V>
Specified by:
size in interface java.util.Map<K,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<K,V>
Overrides:
isEmpty in class AbstractObject2ReferenceMap<K,V>

get

public V get(java.lang.Object k)
Description copied from interface: Function
Returns the value associated by this function to the specified key.

Specified by:
get in interface Function<K,V>
Specified by:
get in interface java.util.Map<K,V>
Parameters:
k - 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 java.util.SortedMap<K,V>

lastKey

public K lastKey()
Specified by:
lastKey in interface java.util.SortedMap<K,V>

object2ReferenceEntrySet

public ObjectSortedSet<Object2ReferenceMap.Entry<K,V>> object2ReferenceEntrySet()
Description copied from interface: Object2ReferenceSortedMap
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:
object2ReferenceEntrySet in interface Object2ReferenceMap<K,V>
Specified by:
object2ReferenceEntrySet in interface Object2ReferenceSortedMap<K,V>
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Object2ReferenceSortedMap.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 Object2ReferenceMap<K,V>
Specified by:
keySet in interface Object2ReferenceSortedMap<K,V>
Specified by:
keySet in interface java.util.Map<K,V>
Specified by:
keySet in interface java.util.SortedMap<K,V>
Overrides:
keySet in class AbstractObject2ReferenceSortedMap<K,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 Object2ReferenceMap<K,V>
Specified by:
values in interface Object2ReferenceSortedMap<K,V>
Specified by:
values in interface java.util.Map<K,V>
Specified by:
values in interface java.util.SortedMap<K,V>
Overrides:
values in class AbstractObject2ReferenceSortedMap<K,V>
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

public java.util.Comparator<? super K> comparator()
Description copied from interface: Object2ReferenceSortedMap
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 Object2ReferenceSortedMap<K,V>
Specified by:
comparator in interface java.util.SortedMap<K,V>
See Also:
SortedMap.comparator()

headMap

public Object2ReferenceSortedMap<K,V> headMap(K to)
Description copied from interface: Object2ReferenceSortedMap
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 Object2ReferenceSortedMap<K,V>
Specified by:
headMap in interface java.util.SortedMap<K,V>
See Also:
SortedMap.headMap(Object)

tailMap

public Object2ReferenceSortedMap<K,V> tailMap(K from)
Description copied from interface: Object2ReferenceSortedMap
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 Object2ReferenceSortedMap<K,V>
Specified by:
tailMap in interface java.util.SortedMap<K,V>
See Also:
SortedMap.tailMap(Object)

subMap

public Object2ReferenceSortedMap<K,V> subMap(K from,
                                             K to)
Description copied from interface: Object2ReferenceSortedMap
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 Object2ReferenceSortedMap<K,V>
Specified by:
subMap in interface java.util.SortedMap<K,V>
See Also:
SortedMap.subMap(Object,Object)

clone

public Object2ReferenceAVLTreeMap<K,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.