it.unimi.dsi.fastutil.doubles
Class Double2ByteRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ByteFunction
      extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ByteMap
          extended by it.unimi.dsi.fastutil.doubles.AbstractDouble2ByteSortedMap
              extended by it.unimi.dsi.fastutil.doubles.Double2ByteRBTreeMap
All Implemented Interfaces:
Double2ByteFunction, Double2ByteMap, Double2ByteSortedMap, Function<Double,Byte>, Serializable, Cloneable, Map<Double,Byte>, SortedMap<Double,Byte>

public class Double2ByteRBTreeMap
extends AbstractDouble2ByteSortedMap
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.AbstractDouble2ByteMap
AbstractDouble2ByteMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ByteSortedMap
Double2ByteSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ByteMap
Double2ByteMap.FastEntrySet
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Double2ByteRBTreeMap()
          Creates a new empty tree map.
Double2ByteRBTreeMap(Comparator<? super Double> c)
          Creates a new empty tree map with the given comparator.
Double2ByteRBTreeMap(double[] k, byte[] v)
          Creates a new tree map using the elements of two parallel arrays.
Double2ByteRBTreeMap(double[] k, byte[] v, Comparator<? super Double> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Double2ByteRBTreeMap(Double2ByteMap m)
          Creates a new tree map copying a given map.
Double2ByteRBTreeMap(Double2ByteSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Double2ByteRBTreeMap(Map<? extends Double,? extends Byte> m)
          Creates a new tree map copying a given map.
Double2ByteRBTreeMap(SortedMap<Double,Byte> 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.
 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 AbstractDouble2ByteMap.keySet().
 boolean containsValue(byte v)
          Checks whether the given value is contained in AbstractDouble2ByteMap.values().
 ObjectSortedSet<Double2ByteMap.Entry> double2ByteEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 double firstDoubleKey()
           
 byte get(double k)
          Returns the value to which the given key is mapped.
 Double2ByteSortedMap 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()
           
 byte put(double k, byte v)
          Adds a pair to the map.
 Byte put(Double ok, Byte ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 byte remove(double k)
          Removes the mapping with the given key.
 Byte 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.
 Double2ByteSortedMap subMap(double from, double to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Double2ByteSortedMap tailMap(double from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ByteCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ByteSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ByteMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ByteFunction
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.doubles.Double2ByteFunction
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

serialVersionUID

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

Double2ByteRBTreeMap

public Double2ByteRBTreeMap()
Creates a new empty tree map.


Double2ByteRBTreeMap

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

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

Double2ByteRBTreeMap

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

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

Double2ByteRBTreeMap

public Double2ByteRBTreeMap(SortedMap<Double,Byte> 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.

Double2ByteRBTreeMap

public Double2ByteRBTreeMap(Double2ByteMap m)
Creates a new tree map copying a given map.

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

Double2ByteRBTreeMap

public Double2ByteRBTreeMap(Double2ByteSortedMap 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.

Double2ByteRBTreeMap

public Double2ByteRBTreeMap(double[] k,
                            byte[] 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.

Double2ByteRBTreeMap

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

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

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

containsValue

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

Specified by:
containsValue in interface Double2ByteMap
Overrides:
containsValue in class AbstractDouble2ByteMap
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,Byte>
Specified by:
clear in interface Map<Double,Byte>
Overrides:
clear in class AbstractDouble2ByteFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Double2ByteFunction
Overrides:
containsKey in class AbstractDouble2ByteMap
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,Byte>
Specified by:
size in interface Map<Double,Byte>
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,Byte>
Overrides:
isEmpty in class AbstractDouble2ByteMap

get

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

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

lastDoubleKey

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

double2ByteEntrySet

public ObjectSortedSet<Double2ByteMap.Entry> double2ByteEntrySet()
Description copied from interface: Double2ByteSortedMap
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:
double2ByteEntrySet in interface Double2ByteMap
Specified by:
double2ByteEntrySet in interface Double2ByteSortedMap
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Double2ByteSortedMap.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 Double2ByteMap
Specified by:
keySet in interface Double2ByteSortedMap
Specified by:
keySet in interface Map<Double,Byte>
Specified by:
keySet in interface SortedMap<Double,Byte>
Overrides:
keySet in class AbstractDouble2ByteSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ByteCollection 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 Double2ByteMap
Specified by:
values in interface Double2ByteSortedMap
Specified by:
values in interface Map<Double,Byte>
Specified by:
values in interface SortedMap<Double,Byte>
Overrides:
values in class AbstractDouble2ByteSortedMap
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: Double2ByteSortedMap
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 Double2ByteSortedMap
Specified by:
comparator in interface SortedMap<Double,Byte>
See Also:
SortedMap.comparator()

headMap

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

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

tailMap

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

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

subMap

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

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