it.unimi.dsi.fastutil.shorts
Class Short2CharAVLTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction
      extended by it.unimi.dsi.fastutil.shorts.AbstractShort2CharMap
          extended by it.unimi.dsi.fastutil.shorts.AbstractShort2CharSortedMap
              extended by it.unimi.dsi.fastutil.shorts.Short2CharAVLTreeMap
All Implemented Interfaces:
Function<Short,Character>, Short2CharFunction, Short2CharMap, Short2CharSortedMap, Serializable, Cloneable, Map<Short,Character>, SortedMap<Short,Character>

public class Short2CharAVLTreeMap
extends AbstractShort2CharSortedMap
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.shorts.AbstractShort2CharMap
AbstractShort2CharMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharSortedMap
Short2CharSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharMap
Short2CharMap.FastEntrySet
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Short2CharAVLTreeMap()
          Creates a new empty tree map.
Short2CharAVLTreeMap(Comparator<? super Short> c)
          Creates a new empty tree map with the given comparator.
Short2CharAVLTreeMap(Map<? extends Short,? extends Character> m)
          Creates a new tree map copying a given map.
Short2CharAVLTreeMap(short[] k, char[] v)
          Creates a new tree map using the elements of two parallel arrays.
Short2CharAVLTreeMap(short[] k, char[] v, Comparator<? super Short> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Short2CharAVLTreeMap(Short2CharMap m)
          Creates a new tree map copying a given map.
Short2CharAVLTreeMap(Short2CharSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Short2CharAVLTreeMap(SortedMap<Short,Character> 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.
 ShortComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(short k)
          Checks whether the given value is contained in AbstractShort2CharMap.keySet().
 boolean containsValue(char v)
          Checks whether the given value is contained in AbstractShort2CharMap.values().
 short firstShortKey()
           
 char get(short k)
          Returns the value to which the given key is mapped.
 Short2CharSortedMap headMap(short to)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 boolean isEmpty()
           
 ShortSortedSet keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 short lastShortKey()
           
 char put(short k, char v)
          Adds a pair to the map.
 Character put(Short ok, Character ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Character remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 char remove(short k)
          Removes the mapping with the given key.
 ObjectSortedSet<Short2CharMap.Entry> short2CharEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 Short2CharSortedMap subMap(short from, short to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Short2CharSortedMap tailMap(short from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 CharCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction
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.shorts.Short2CharFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 

Field Detail

serialVersionUID

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

Short2CharAVLTreeMap

public Short2CharAVLTreeMap()
Creates a new empty tree map.


Short2CharAVLTreeMap

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

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

Short2CharAVLTreeMap

public Short2CharAVLTreeMap(Map<? extends Short,? extends Character> m)
Creates a new tree map copying a given map.

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

Short2CharAVLTreeMap

public Short2CharAVLTreeMap(SortedMap<Short,Character> 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.

Short2CharAVLTreeMap

public Short2CharAVLTreeMap(Short2CharMap m)
Creates a new tree map copying a given map.

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

Short2CharAVLTreeMap

public Short2CharAVLTreeMap(Short2CharSortedMap 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.

Short2CharAVLTreeMap

public Short2CharAVLTreeMap(short[] k,
                            char[] v,
                            Comparator<? super Short> 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.

Short2CharAVLTreeMap

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

Specified by:
put in interface Short2CharFunction
Overrides:
put in class AbstractShort2CharFunction
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 char remove(short k)
Description copied from interface: Short2CharFunction
Removes the mapping with the given key.

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

containsValue

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

Specified by:
containsValue in interface Short2CharMap
Overrides:
containsValue in class AbstractShort2CharMap
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<Short,Character>
Specified by:
clear in interface Map<Short,Character>
Overrides:
clear in class AbstractShort2CharFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Short2CharFunction
Overrides:
containsKey in class AbstractShort2CharMap
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<Short,Character>
Specified by:
size in interface Map<Short,Character>
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<Short,Character>
Overrides:
isEmpty in class AbstractShort2CharMap

get

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

Specified by:
get in interface Short2CharFunction
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)

firstShortKey

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

lastShortKey

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

short2CharEntrySet

public ObjectSortedSet<Short2CharMap.Entry> short2CharEntrySet()
Description copied from interface: Short2CharMap
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 Short2CharMap.entrySet() so that it returns an ObjectSet of objects of type Short2CharMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
short2CharEntrySet in interface Short2CharMap
Specified by:
short2CharEntrySet in interface Short2CharSortedMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Short2CharMap.entrySet()

keySet

public ShortSortedSet 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 Short2CharMap
Specified by:
keySet in interface Short2CharSortedMap
Specified by:
keySet in interface Map<Short,Character>
Overrides:
keySet in class AbstractShort2CharSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public CharCollection 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 Short2CharMap
Specified by:
values in interface Short2CharSortedMap
Specified by:
values in interface Map<Short,Character>
Overrides:
values in class AbstractShort2CharSortedMap
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

public ShortComparator comparator()
Description copied from interface: Short2CharSortedMap
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 Short2CharSortedMap
Specified by:
comparator in interface SortedMap<Short,Character>
See Also:
SortedMap.comparator()

headMap

public Short2CharSortedMap headMap(short to)
Description copied from interface: Short2CharSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Short2CharSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Short2CharSortedMap tailMap(short from)
Description copied from interface: Short2CharSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:
tailMap in interface Short2CharSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Short2CharSortedMap subMap(short from,
                                  short to)
Description copied from interface: Short2CharSortedMap
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:
subMap in interface Short2CharSortedMap
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.