it.unimi.dsi.fastutil.doubles
Class Double2ShortRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortFunction
      extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortMap
          extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortSortedMap
              extended by it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap
All Implemented Interfaces:
Double2ShortFunction, Double2ShortMap, Double2ShortSortedMap, Function<Double,Short>, Serializable, Cloneable, Map<Double,Short>, SortedMap<Double,Short>

public class Double2ShortRBTreeMap
extends AbstractDouble2ShortSortedMap
implements Serializable, 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.doubles.AbstractDouble2ShortSortedMap
AbstractDouble2ShortSortedMap.KeySetIterator, AbstractDouble2ShortSortedMap.ValuesCollection, AbstractDouble2ShortSortedMap.ValuesIterator
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortMap
AbstractDouble2ShortMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ShortSortedMap
Double2ShortSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ShortMap
Double2ShortMap.FastEntrySet
 
Field Summary
protected  DoubleComparator actualComparator
          This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
protected  int count
          Number of entries in this map.
protected  ObjectSortedSet<Double2ShortMap.Entry> entries
          Cached set of entries.
protected  it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap.Entry firstEntry
          The first key in this map.
protected  DoubleSortedSet keys
          Cached set of keys.
protected  it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap.Entry lastEntry
          The last key in this map.
protected  boolean modified
          The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.
static long serialVersionUID
           
protected  Comparator<? super Double> storedComparator
          This map's comparator, as provided in the constructor.
protected  it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap.Entry tree
          A reference to the root entry.
protected  ShortCollection values
          Cached collection of values.
 
Fields inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortFunction
defRetValue
 
Constructor Summary
Double2ShortRBTreeMap()
          Creates a new empty tree map.
Double2ShortRBTreeMap(Comparator<? super Double> c)
          Creates a new empty tree map with the given comparator.
Double2ShortRBTreeMap(double[] k, short[] v)
          Creates a new tree map using the elements of two parallel arrays.
Double2ShortRBTreeMap(double[] k, short[] v, Comparator<? super Double> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Double2ShortRBTreeMap(Double2ShortMap m)
          Creates a new tree map copying a given map.
Double2ShortRBTreeMap(Double2ShortSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Double2ShortRBTreeMap(Map<? extends Double,? extends Short> m)
          Creates a new tree map copying a given map.
Double2ShortRBTreeMap(SortedMap<Double,Short> 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).
 Double2ShortRBTreeMap clone()
          Returns a deep copy of this tree map.
 DoubleComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(double k)
          Checks whether the given value is contained in AbstractDouble2ShortMap.keySet().
 boolean containsValue(short v)
          Checks whether the given value is contained in AbstractDouble2ShortMap.values().
 ObjectSortedSet<Double2ShortMap.Entry> double2ShortEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 double firstDoubleKey()
           
 short get(double k)
          Returns the value to which the given key is mapped.
 Double2ShortSortedMap headMap(double to)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 boolean isEmpty()
           
 DoubleSortedSet keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 double lastDoubleKey()
           
 short put(double k, short v)
          Adds a pair to the map.
 Short put(Double ok, Short ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 short remove(double k)
          Removes the mapping with the given key.
 Short remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 Double2ShortSortedMap subMap(double from, double to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Double2ShortSortedMap tailMap(double from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ShortCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ShortFunction
containsKey, defaultReturnValue, defaultReturnValue, get
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2ShortFunction
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
 

Field Detail

tree

protected transient it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap.Entry tree
A reference to the root entry.


count

protected int count
Number of entries in this map.


firstEntry

protected transient it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap.Entry firstEntry
The first key in this map.


lastEntry

protected transient it.unimi.dsi.fastutil.doubles.Double2ShortRBTreeMap.Entry lastEntry
The last key in this map.


entries

protected transient volatile ObjectSortedSet<Double2ShortMap.Entry> entries
Cached set of entries.


keys

protected transient volatile DoubleSortedSet keys
Cached set of keys.


values

protected transient volatile ShortCollection values
Cached collection of values.


modified

protected transient boolean modified
The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.


storedComparator

protected Comparator<? super Double> storedComparator
This map's comparator, as provided in the constructor.


actualComparator

protected transient DoubleComparator actualComparator
This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.


serialVersionUID

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

Double2ShortRBTreeMap

public Double2ShortRBTreeMap()
Creates a new empty tree map.


Double2ShortRBTreeMap

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

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

Double2ShortRBTreeMap

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

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

Double2ShortRBTreeMap

public Double2ShortRBTreeMap(SortedMap<Double,Short> 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.

Double2ShortRBTreeMap

public Double2ShortRBTreeMap(Double2ShortMap m)
Creates a new tree map copying a given map.

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

Double2ShortRBTreeMap

public Double2ShortRBTreeMap(Double2ShortSortedMap 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.

Double2ShortRBTreeMap

public Double2ShortRBTreeMap(double[] k,
                             short[] v,
                             Comparator<? super Double> 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.

Double2ShortRBTreeMap

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

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

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

containsValue

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

Specified by:
containsValue in interface Double2ShortMap
Overrides:
containsValue in class AbstractDouble2ShortMap
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<Double,Short>
Specified by:
clear in interface Map<Double,Short>
Overrides:
clear in class AbstractDouble2ShortFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Double2ShortFunction
Overrides:
containsKey in class AbstractDouble2ShortMap
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<Double,Short>
Specified by:
size in interface Map<Double,Short>
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<Double,Short>
Overrides:
isEmpty in class AbstractDouble2ShortMap

get

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

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

firstDoubleKey

public double firstDoubleKey()
Specified by:
firstDoubleKey in interface Double2ShortSortedMap
See Also:
SortedMap.firstKey()

lastDoubleKey

public double lastDoubleKey()
Specified by:
lastDoubleKey in interface Double2ShortSortedMap
See Also:
SortedMap.lastKey()

double2ShortEntrySet

public ObjectSortedSet<Double2ShortMap.Entry> double2ShortEntrySet()
Description copied from interface: Double2ShortSortedMap
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:
double2ShortEntrySet in interface Double2ShortMap
Specified by:
double2ShortEntrySet in interface Double2ShortSortedMap
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Double2ShortSortedMap.entrySet()

keySet

public DoubleSortedSet 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 Double2ShortMap
Specified by:
keySet in interface Double2ShortSortedMap
Specified by:
keySet in interface Map<Double,Short>
Specified by:
keySet in interface SortedMap<Double,Short>
Overrides:
keySet in class AbstractDouble2ShortSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ShortCollection 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 Double2ShortMap
Specified by:
values in interface Double2ShortSortedMap
Specified by:
values in interface Map<Double,Short>
Specified by:
values in interface SortedMap<Double,Short>
Overrides:
values in class AbstractDouble2ShortSortedMap
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

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

headMap

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

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

tailMap

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

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

subMap

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

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

clone

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


Copyright © 2011. All Rights Reserved.