it.unimi.dsi.fastutil.shorts
Class Short2IntAVLTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.shorts.AbstractShort2IntMap
      extended byit.unimi.dsi.fastutil.shorts.AbstractShort2IntSortedMap
          extended byit.unimi.dsi.fastutil.shorts.Short2IntAVLTreeMap
All Implemented Interfaces:
Cloneable, Map, Serializable, Short2IntMap, Short2IntSortedMap, SortedMap

public class Short2IntAVLTreeMap
extends AbstractShort2IntSortedMap
implements Serializable, Cloneable, Short2IntSortedMap

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.shorts.AbstractShort2IntMap
AbstractShort2IntMap.BasicEntry
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Short2IntAVLTreeMap()
          Creates a new empty tree map.
Short2IntAVLTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Short2IntAVLTreeMap(Map m)
          Creates a new tree map copying a given map.
Short2IntAVLTreeMap(short[] k, int[] v)
          Creates a new tree map using the elements of two parallel arrays.
Short2IntAVLTreeMap(short[] k, int[] v, Comparator c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Short2IntAVLTreeMap(Short2IntMap m)
          Creates a new tree map copying a given map.
Short2IntAVLTreeMap(Short2IntSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Short2IntAVLTreeMap(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(short 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.
 short firstShortKey()
           
 Object get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int get(short k)
          Returns the value to which the given key is mapped.
 Short2IntSortedMap headMap(short to)
           
 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.
 short lastShortKey()
           
 Object put(Object ok, Object ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int put(short k, int v)
          Adds a pair to the map.
 Object remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int remove(short k)
          Removes the mapping with the given key.
 int size()
           
 Short2IntSortedMap subMap(short from, short to)
           
 Short2IntSortedMap tailMap(short from)
           
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntSortedMap
headMap, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap
containsKey, 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.shorts.Short2IntMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, hashCode, putAll
 
Methods inherited from interface java.util.SortedMap
headMap, subMap, tailMap
 

Field Detail

serialVersionUID

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

Short2IntAVLTreeMap

public Short2IntAVLTreeMap()
Creates a new empty tree map.


Short2IntAVLTreeMap

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

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

Short2IntAVLTreeMap

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

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

Short2IntAVLTreeMap

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

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(Short2IntMap m)
Creates a new tree map copying a given map.

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

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(Short2IntSortedMap 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.

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(short[] 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.

Short2IntAVLTreeMap

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

Specified by:
put in interface Short2IntMap
Overrides:
put in class AbstractShort2IntMap

remove

public int remove(short k)
Description copied from interface: Short2IntMap
Removes the mapping with the given key.

Specified by:
remove in interface Short2IntMap
Overrides:
remove in class AbstractShort2IntMap

put

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

remove

public Object remove(Object ok)
Description copied from class: AbstractShort2IntMap
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 AbstractShort2IntMap

containsValue

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

Specified by:
containsValue in interface Short2IntMap
Overrides:
containsValue in class AbstractShort2IntMap

clear

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

containsKey

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

Specified by:
containsKey in interface Short2IntMap
Overrides:
containsKey in class AbstractShort2IntMap

size

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

isEmpty

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

get

public int get(short k)
Description copied from interface: Short2IntMap
Returns the value to which the given key is mapped.

Specified by:
get in interface Short2IntMap
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: AbstractShort2IntMap
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 AbstractShort2IntMap

firstShortKey

public short firstShortKey()
Specified by:
firstShortKey in interface Short2IntSortedMap
See Also:
SortedMap.firstKey()

lastShortKey

public short lastShortKey()
Specified by:
lastShortKey in interface Short2IntSortedMap
See Also:
SortedMap.lastKey()

firstKey

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

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

lastKey

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

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

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 AbstractShort2IntSortedMap
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 AbstractShort2IntMap
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 Short2IntSortedMap headMap(short to)
Specified by:
headMap in interface Short2IntSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Short2IntSortedMap tailMap(short from)
Specified by:
tailMap in interface Short2IntSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Short2IntSortedMap subMap(short from,
                                 short to)
Specified by:
subMap in interface Short2IntSortedMap
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.

Returns:
a deep copy of this tree map.