it.unimi.dsi.fastutil.objects
Class Object2IntAVLTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.objects.AbstractObject2IntMap
      extended byit.unimi.dsi.fastutil.objects.AbstractObject2IntSortedMap
          extended byit.unimi.dsi.fastutil.objects.Object2IntAVLTreeMap
All Implemented Interfaces:
Cloneable, Map, Object2IntMap, Object2IntSortedMap, Serializable, SortedMap

public class Object2IntAVLTreeMap
extends AbstractObject2IntSortedMap
implements Serializable, Cloneable, Object2IntSortedMap

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 inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2IntMap
AbstractObject2IntMap.BasicEntry
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Object2IntAVLTreeMap()
          Creates a new empty tree map.
Object2IntAVLTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Object2IntAVLTreeMap(Map m)
          Creates a new tree map copying a given map.
Object2IntAVLTreeMap(Object[] k, int[] v)
          Creates a new tree map using the elements of two parallel arrays.
Object2IntAVLTreeMap(Object[] k, int[] v, Comparator c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Object2IntAVLTreeMap(Object2IntMap m)
          Creates a new tree map copying a given map.
Object2IntAVLTreeMap(Object2IntSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Object2IntAVLTreeMap(SortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 void clear()
           
 Object clone()
          Returns a deep copy of this tree map.
 Comparator comparator()
           
 boolean containsKey(Object k)
          Checks whether the given value is contained in keySet().
 boolean containsValue(int v)
          Checks whether the given value is contained in values().
 Set entrySet()
           
 Object firstKey()
          Delegates to the corresponding type-specific method.
 Object get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int getInt(Object k)
          Returns the value to which the given key is mapped.
 SortedMap headMap(Object to)
          Delegates to the corresponding type-specific method.
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 Object lastKey()
          Delegates to the corresponding type-specific method.
 int put(Object k, int v)
          Adds a pair to the map.
 Object put(Object ok, Object ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Object remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int removeInt(Object k)
          Removes the mapping with the given key.
 int size()
           
 SortedMap subMap(Object from, Object to)
          Delegates to the corresponding type-specific method.
 SortedMap tailMap(Object from)
          Delegates to the corresponding type-specific method.
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2IntMap
containsValue, defaultReturnValue, defaultReturnValue, equals, getDefRetValue, hashCode, putAll, setDefRetValue, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2IntMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
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

Object2IntAVLTreeMap

public Object2IntAVLTreeMap()
Creates a new empty tree map.


Object2IntAVLTreeMap

public Object2IntAVLTreeMap(Comparator c)
Creates a new empty tree map with the given comparator.

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

Object2IntAVLTreeMap

public Object2IntAVLTreeMap(Map m)
Creates a new tree map copying a given map.

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

Object2IntAVLTreeMap

public Object2IntAVLTreeMap(SortedMap 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.

Object2IntAVLTreeMap

public Object2IntAVLTreeMap(Object2IntMap m)
Creates a new tree map copying a given map.

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

Object2IntAVLTreeMap

public Object2IntAVLTreeMap(Object2IntSortedMap 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.

Object2IntAVLTreeMap

public Object2IntAVLTreeMap(Object[] k,
                            int[] v,
                            Comparator 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.

Object2IntAVLTreeMap

public Object2IntAVLTreeMap(Object[] k,
                            int[] 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 int put(Object k,
               int v)
Description copied from interface: Object2IntMap
Adds a pair to the map.

Specified by:
put in interface Object2IntMap
Overrides:
put in class AbstractObject2IntMap

removeInt

public int removeInt(Object k)
Description copied from interface: Object2IntMap
Removes the mapping with the given key.

Specified by:
removeInt in interface Object2IntMap
Overrides:
removeInt in class AbstractObject2IntMap

put

public Object put(Object ok,
                  Object ov)
Description copied from class: AbstractObject2IntMap
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 Map
Overrides:
put in class AbstractObject2IntMap

remove

public Object remove(Object ok)
Description copied from class: AbstractObject2IntMap
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 Map
Overrides:
remove in class AbstractObject2IntMap

containsValue

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

Specified by:
containsValue in interface Object2IntMap
Overrides:
containsValue in class AbstractObject2IntMap

clear

public void clear()
Specified by:
clear in interface Map
Overrides:
clear in class AbstractObject2IntMap

containsKey

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

Specified by:
containsKey in interface Map
Overrides:
containsKey in class AbstractObject2IntMap

size

public int size()
Specified by:
size in interface Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map
Overrides:
isEmpty in class AbstractObject2IntMap

getInt

public int getInt(Object k)
Description copied from interface: Object2IntMap
Returns the value to which the given key is mapped.

Specified by:
getInt in interface Object2IntMap
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

get

public Object get(Object ok)
Description copied from class: AbstractObject2IntMap
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 Map
Overrides:
get in class AbstractObject2IntMap

firstKey

public Object firstKey()
Description copied from class: AbstractObject2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
firstKey in interface SortedMap
Overrides:
firstKey in class AbstractObject2IntSortedMap

lastKey

public Object lastKey()
Description copied from class: AbstractObject2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
lastKey in interface SortedMap
Overrides:
lastKey in class AbstractObject2IntSortedMap

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

keySet

public Set 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
Overrides:
keySet in class AbstractObject2IntSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.

values

public Collection 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
Overrides:
values in class AbstractObject2IntMap
Returns:
a type-specific collection view of the values contained in this map.

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedMap

headMap

public SortedMap headMap(Object to)
Description copied from class: AbstractObject2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
headMap in interface SortedMap
Overrides:
headMap in class AbstractObject2IntSortedMap

tailMap

public SortedMap tailMap(Object from)
Description copied from class: AbstractObject2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
tailMap in interface SortedMap
Overrides:
tailMap in class AbstractObject2IntSortedMap

subMap

public SortedMap subMap(Object from,
                        Object to)
Description copied from class: AbstractObject2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
subMap in interface SortedMap
Overrides:
subMap in class AbstractObject2IntSortedMap

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.

Returns:
a deep copy of this tree map.