it.unimi.dsi.fastutil.doubles

Class Double2FloatRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatFunction

it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatMap

it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatSortedMap

it.unimi.dsi.fastutil.doubles.Double2FloatRBTreeMap

All Implemented Interfaces:

Double2FloatFunction, Double2FloatMap, Double2FloatSortedMap, Function<Double,Float>, Serializable, Cloneable, Map<Double,Float>, SortedMap<Double,Float>

public class Double2FloatRBTreeMap
extends AbstractDouble2FloatSortedMap
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.AbstractDouble2FloatSortedMap

AbstractDouble2FloatSortedMap.KeySetIterator, AbstractDouble2FloatSortedMap.ValuesCollection, AbstractDouble2FloatSortedMap.ValuesIterator

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatMap

AbstractDouble2FloatMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2FloatSortedMap

Double2FloatSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2FloatMap

Double2FloatMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
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<Double2FloatMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.doubles.Double2FloatRBTreeMap.Entry	firstEntry The first key in this map.
protected DoubleSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.doubles.Double2FloatRBTreeMap.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.Double2FloatRBTreeMap.Entry	tree A reference to the root entry.
protected FloatCollection	values Cached collection of values.

Fields inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatFunction

defRetValue

Constructor Summary

Constructors

Constructor and Description
Double2FloatRBTreeMap() Creates a new empty tree map.
Double2FloatRBTreeMap(Comparator<? super Double> c) Creates a new empty tree map with the given comparator.
Double2FloatRBTreeMap(double[] k, float[] v) Creates a new tree map using the elements of two parallel arrays.
Double2FloatRBTreeMap(double[] k, float[] v, Comparator<? super Double> c) Creates a new tree map using the elements of two parallel arrays and the given comparator.
Double2FloatRBTreeMap(Double2FloatMap m) Creates a new tree map copying a given map.
Double2FloatRBTreeMap(Double2FloatSortedMap m) Creates a new tree map copying a given sorted map (and its Comparator).
Double2FloatRBTreeMap(Map<? extends Double,? extends Float> m) Creates a new tree map copying a given map.
Double2FloatRBTreeMap(SortedMap<Double,Float> m) Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
Double2FloatRBTreeMap	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 AbstractDouble2FloatMap.keySet().
boolean	containsValue(float v) Checks whether the given value is contained in AbstractDouble2FloatMap.values().
ObjectSortedSet<Double2FloatMap.Entry>	double2FloatEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
double	firstDoubleKey()
float	get(double k) Returns the value to which the given key is mapped.
Double2FloatSortedMap	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()
float	put(double k, float v) Adds a pair to the map.
Float	put(Double ok, Float ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
float	remove(double k) Removes the mapping with the given key.
Float	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.
Double2FloatSortedMap	subMap(double from, double to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Double2FloatSortedMap	tailMap(double from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
FloatCollection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2FloatFunction

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.Double2FloatFunction

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.Double2FloatRBTreeMap.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.Double2FloatRBTreeMap.Entry firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.doubles.Double2FloatRBTreeMap.Entry lastEntry

The last key in this map.

entries

protected transient volatile ObjectSortedSet<Double2FloatMap.Entry> entries

Cached set of entries.

keys

protected transient volatile DoubleSortedSet keys

Cached set of keys.

values

protected transient volatile FloatCollection 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

Double2FloatRBTreeMap

public Double2FloatRBTreeMap()

Creates a new empty tree map.

Double2FloatRBTreeMap

public Double2FloatRBTreeMap(Comparator<? super Double> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Double2FloatRBTreeMap

public Double2FloatRBTreeMap(Map<? extends Double,? extends Float> m)

Creates a new tree map copying a given map.

Parameters:

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

Double2FloatRBTreeMap

public Double2FloatRBTreeMap(SortedMap<Double,Float> 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.

Double2FloatRBTreeMap

public Double2FloatRBTreeMap(Double2FloatMap m)

Creates a new tree map copying a given map.

Parameters:

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

Double2FloatRBTreeMap

public Double2FloatRBTreeMap(Double2FloatSortedMap 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.

Double2FloatRBTreeMap

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

Double2FloatRBTreeMap

public Double2FloatRBTreeMap(double[] k,
                     float[] 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 float put(double k,
        float v)

Description copied from interface: Double2FloatFunction

Adds a pair to the map.

Specified by:

put in interface Double2FloatFunction

Overrides:

put in class AbstractDouble2FloatFunction

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 float remove(double k)

Description copied from interface: Double2FloatFunction

Removes the mapping with the given key.

Specified by:

remove in interface Double2FloatFunction

Overrides:

remove in class AbstractDouble2FloatFunction

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 Float put(Double ok,
        Float ov)

Description copied from class: AbstractDouble2FloatFunction

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,Float>

Specified by:

put in interface Map<Double,Float>

Overrides:

put in class AbstractDouble2FloatFunction

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 Float remove(Object ok)

Description copied from class: AbstractDouble2FloatFunction

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,Float>

Specified by:

remove in interface Map<Double,Float>

Overrides:

remove in class AbstractDouble2FloatFunction

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(float v)

Description copied from class: AbstractDouble2FloatMap

Checks whether the given value is contained in AbstractDouble2FloatMap.values().

Specified by:

containsValue in interface Double2FloatMap

Overrides:

containsValue in class AbstractDouble2FloatMap

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,Float>

Specified by:

clear in interface Map<Double,Float>

Overrides:

clear in class AbstractDouble2FloatFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(double k)

Description copied from class: AbstractDouble2FloatMap

Checks whether the given value is contained in AbstractDouble2FloatMap.keySet().

Specified by:

containsKey in interface Double2FloatFunction

Overrides:

containsKey in class AbstractDouble2FloatMap

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,Float>

Specified by:

size in interface Map<Double,Float>

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,Float>

Overrides:

isEmpty in class AbstractDouble2FloatMap

get

public float get(double k)

Description copied from interface: Double2FloatFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Double2FloatFunction

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 Double2FloatSortedMap

See Also:

SortedMap.firstKey()

lastDoubleKey

public double lastDoubleKey()

Specified by:

lastDoubleKey in interface Double2FloatSortedMap

See Also:

SortedMap.lastKey()

double2FloatEntrySet

public ObjectSortedSet<Double2FloatMap.Entry> double2FloatEntrySet()

Description copied from interface: Double2FloatSortedMap

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:

double2FloatEntrySet in interface Double2FloatMap

Specified by:

double2FloatEntrySet in interface Double2FloatSortedMap

Returns:

a type-specific sorted-set view of the mappings contained in this map.

See Also:

Double2FloatSortedMap.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 Double2FloatMap

Specified by:

keySet in interface Double2FloatSortedMap

Specified by:

keySet in interface Map<Double,Float>

Specified by:

keySet in interface SortedMap<Double,Float>

Overrides:

keySet in class AbstractDouble2FloatSortedMap

Returns:

a type-specific sorted set view of the keys contained in this map.

See Also:

Map.keySet()

values

public FloatCollection 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 Double2FloatMap

Specified by:

values in interface Double2FloatSortedMap

Specified by:

values in interface Map<Double,Float>

Specified by:

values in interface SortedMap<Double,Float>

Overrides:

values in class AbstractDouble2FloatSortedMap

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: Double2FloatSortedMap

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 Double2FloatSortedMap

Specified by:

comparator in interface SortedMap<Double,Float>

See Also:

SortedMap.comparator()

headMap

public Double2FloatSortedMap headMap(double to)

Description copied from interface: Double2FloatSortedMap

Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:

headMap in interface Double2FloatSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Double2FloatSortedMap tailMap(double from)

Description copied from interface: Double2FloatSortedMap

Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:

tailMap in interface Double2FloatSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Double2FloatSortedMap subMap(double from,
                           double to)

Description copied from interface: Double2FloatSortedMap

Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:

subMap in interface Double2FloatSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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