it.unimi.dsi.fastutil.shorts
Class Short2DoubleRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleFunction
      extended by it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleMap
          extended by it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleSortedMap
              extended by it.unimi.dsi.fastutil.shorts.Short2DoubleRBTreeMap
All Implemented Interfaces:
Function<java.lang.Short,java.lang.Double>, Short2DoubleFunction, Short2DoubleMap, Short2DoubleSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Short,java.lang.Double>, java.util.SortedMap<java.lang.Short,java.lang.Double>

public class Short2DoubleRBTreeMap
extends AbstractShort2DoubleSortedMap
implements java.io.Serializable, java.lang.Cloneable

A type-specific red-black 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.AbstractShort2DoubleMap
AbstractShort2DoubleMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2DoubleSortedMap
Short2DoubleSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2DoubleMap
Short2DoubleMap.FastEntrySet
 
Constructor Summary
Short2DoubleRBTreeMap()
          Creates a new empty tree map.
Short2DoubleRBTreeMap(java.util.Comparator<? super java.lang.Short> c)
          Creates a new empty tree map with the given comparator.
Short2DoubleRBTreeMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Double> m)
          Creates a new tree map copying a given map.
Short2DoubleRBTreeMap(short[] k, double[] v)
          Creates a new tree map using the elements of two parallel arrays.
Short2DoubleRBTreeMap(short[] k, double[] v, java.util.Comparator<? super java.lang.Short> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Short2DoubleRBTreeMap(Short2DoubleMap m)
          Creates a new tree map copying a given map.
Short2DoubleRBTreeMap(Short2DoubleSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Short2DoubleRBTreeMap(java.util.SortedMap<java.lang.Short,java.lang.Double> 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).
 Short2DoubleRBTreeMap 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 AbstractShort2DoubleMap.keySet().
 boolean containsValue(double v)
          Checks whether the given value is contained in AbstractShort2DoubleMap.values().
 short firstShortKey()
           
 double get(short k)
          Returns the value to which the given key is mapped.
 Short2DoubleSortedMap 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()
           
 double put(short k, double v)
          Adds a pair to the map.
 java.lang.Double put(java.lang.Short ok, java.lang.Double ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 java.lang.Double remove(java.lang.Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 double remove(short k)
          Removes the mapping with the given key.
 ObjectSortedSet<Short2DoubleMap.Entry> short2DoubleEntrySet()
          Returns a type-specific sorted-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.
 Short2DoubleSortedMap subMap(short from, short to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Short2DoubleSortedMap tailMap(short from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 DoubleCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleFunction
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.Short2DoubleFunction
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
 

Constructor Detail

Short2DoubleRBTreeMap

public Short2DoubleRBTreeMap()
Creates a new empty tree map.


Short2DoubleRBTreeMap

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

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

Short2DoubleRBTreeMap

public Short2DoubleRBTreeMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Double> m)
Creates a new tree map copying a given map.

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

Short2DoubleRBTreeMap

public Short2DoubleRBTreeMap(java.util.SortedMap<java.lang.Short,java.lang.Double> 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.

Short2DoubleRBTreeMap

public Short2DoubleRBTreeMap(Short2DoubleMap m)
Creates a new tree map copying a given map.

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

Short2DoubleRBTreeMap

public Short2DoubleRBTreeMap(Short2DoubleSortedMap 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.

Short2DoubleRBTreeMap

public Short2DoubleRBTreeMap(short[] k,
                             double[] v,
                             java.util.Comparator<? super java.lang.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:
java.lang.IllegalArgumentException - if k and v have different lengths.

Short2DoubleRBTreeMap

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

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

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

containsValue

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

Specified by:
containsValue in interface Short2DoubleMap
Overrides:
containsValue in class AbstractShort2DoubleMap
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<java.lang.Short,java.lang.Double>
Specified by:
clear in interface java.util.Map<java.lang.Short,java.lang.Double>
Overrides:
clear in class AbstractShort2DoubleFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Short2DoubleFunction
Overrides:
containsKey in class AbstractShort2DoubleMap
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<java.lang.Short,java.lang.Double>
Specified by:
size in interface java.util.Map<java.lang.Short,java.lang.Double>
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<java.lang.Short,java.lang.Double>
Overrides:
isEmpty in class AbstractShort2DoubleMap

get

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

Specified by:
get in interface Short2DoubleFunction
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 Short2DoubleSortedMap
See Also:
SortedMap.firstKey()

lastShortKey

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

short2DoubleEntrySet

public ObjectSortedSet<Short2DoubleMap.Entry> short2DoubleEntrySet()
Description copied from interface: Short2DoubleSortedMap
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:
short2DoubleEntrySet in interface Short2DoubleMap
Specified by:
short2DoubleEntrySet in interface Short2DoubleSortedMap
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Short2DoubleSortedMap.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 Short2DoubleMap
Specified by:
keySet in interface Short2DoubleSortedMap
Specified by:
keySet in interface java.util.Map<java.lang.Short,java.lang.Double>
Specified by:
keySet in interface java.util.SortedMap<java.lang.Short,java.lang.Double>
Overrides:
keySet in class AbstractShort2DoubleSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public DoubleCollection 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 Short2DoubleMap
Specified by:
values in interface Short2DoubleSortedMap
Specified by:
values in interface java.util.Map<java.lang.Short,java.lang.Double>
Specified by:
values in interface java.util.SortedMap<java.lang.Short,java.lang.Double>
Overrides:
values in class AbstractShort2DoubleSortedMap
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: Short2DoubleSortedMap
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 Short2DoubleSortedMap
Specified by:
comparator in interface java.util.SortedMap<java.lang.Short,java.lang.Double>
See Also:
SortedMap.comparator()

headMap

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

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

tailMap

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

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

subMap

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

Specified by:
subMap in interface Short2DoubleSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

public Short2DoubleRBTreeMap 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.