it.unimi.dsi.fastutil.ints

Class Int2DoubleAVLTreeMap

java.lang.Object

it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction

it.unimi.dsi.fastutil.ints.AbstractInt2DoubleMap

it.unimi.dsi.fastutil.ints.AbstractInt2DoubleSortedMap

it.unimi.dsi.fastutil.ints.Int2DoubleAVLTreeMap

All Implemented Interfaces:

Function<Integer,Double>, Int2DoubleFunction, Int2DoubleMap, Int2DoubleSortedMap, Serializable, Cloneable, Map<Integer,Double>, SortedMap<Integer,Double>

public class Int2DoubleAVLTreeMap
extends AbstractInt2DoubleSortedMap
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.ints.AbstractInt2DoubleSortedMap

AbstractInt2DoubleSortedMap.KeySetIterator, AbstractInt2DoubleSortedMap.ValuesCollection, AbstractInt2DoubleSortedMap.ValuesIterator

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2DoubleMap

AbstractInt2DoubleMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2DoubleSortedMap

Int2DoubleSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2DoubleMap

Int2DoubleMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected IntComparator	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<Int2DoubleMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.ints.Int2DoubleAVLTreeMap.Entry	firstEntry The first key in this map.
protected IntSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.ints.Int2DoubleAVLTreeMap.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 Integer>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.ints.Int2DoubleAVLTreeMap.Entry	tree A reference to the root entry.
protected DoubleCollection	values Cached collection of values.

Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction

defRetValue

Constructor Summary

Constructors

Constructor and Description
Int2DoubleAVLTreeMap() Creates a new empty tree map.
Int2DoubleAVLTreeMap(Comparator<? super Integer> c) Creates a new empty tree map with the given comparator.
Int2DoubleAVLTreeMap(int[] k, double[] v) Creates a new tree map using the elements of two parallel arrays.
Int2DoubleAVLTreeMap(int[] k, double[] v, Comparator<? super Integer> c) Creates a new tree map using the elements of two parallel arrays and the given comparator.
Int2DoubleAVLTreeMap(Int2DoubleMap m) Creates a new tree map copying a given map.
Int2DoubleAVLTreeMap(Int2DoubleSortedMap m) Creates a new tree map copying a given sorted map (and its Comparator).
Int2DoubleAVLTreeMap(Map<? extends Integer,? extends Double> m) Creates a new tree map copying a given map.
Int2DoubleAVLTreeMap(SortedMap<Integer,Double> 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).
Int2DoubleAVLTreeMap	clone() Returns a deep copy of this tree map.
IntComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(int k) Checks whether the given value is contained in AbstractInt2DoubleMap.keySet().
boolean	containsValue(double v) Checks whether the given value is contained in AbstractInt2DoubleMap.values().
int	firstIntKey()
double	get(int k) Returns the value to which the given key is mapped.
Int2DoubleSortedMap	headMap(int to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2DoubleMap.Entry>	int2DoubleEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
boolean	isEmpty()
IntSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
int	lastIntKey()
double	put(int k, double v) Adds a pair to the map.
Double	put(Integer ok, Double ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
double	remove(int k) Removes the mapping with the given key.
Double	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.
Int2DoubleSortedMap	subMap(int from, int to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Int2DoubleSortedMap	tailMap(int 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.ints.AbstractInt2DoubleSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2DoubleMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2DoubleFunction

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.ints.Int2DoubleFunction

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.ints.Int2DoubleAVLTreeMap.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.ints.Int2DoubleAVLTreeMap.Entry firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.ints.Int2DoubleAVLTreeMap.Entry lastEntry

The last key in this map.

entries

protected transient volatile ObjectSortedSet<Int2DoubleMap.Entry> entries

Cached set of entries.

keys

protected transient volatile IntSortedSet keys

Cached set of keys.

values

protected transient volatile DoubleCollection 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 Integer> storedComparator

This map's comparator, as provided in the constructor.

actualComparator

protected transient IntComparator 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

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap()

Creates a new empty tree map.

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(Comparator<? super Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(Map<? extends Integer,? extends Double> m)

Creates a new tree map copying a given map.

Parameters:

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

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(SortedMap<Integer,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.

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(Int2DoubleMap m)

Creates a new tree map copying a given map.

Parameters:

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

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(Int2DoubleSortedMap 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.

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(int[] k,
                    double[] v,
                    Comparator<? super Integer> 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.

Int2DoubleAVLTreeMap

public Int2DoubleAVLTreeMap(int[] 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:

IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public double put(int k,
         double v)

Description copied from interface: Int2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Int2DoubleFunction

Overrides:

put in class AbstractInt2DoubleFunction

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(int k)

Description copied from interface: Int2DoubleFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2DoubleFunction

Overrides:

remove in class AbstractInt2DoubleFunction

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

Description copied from class: AbstractInt2DoubleFunction

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<Integer,Double>

Specified by:

put in interface Map<Integer,Double>

Overrides:

put in class AbstractInt2DoubleFunction

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

Description copied from class: AbstractInt2DoubleFunction

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<Integer,Double>

Specified by:

remove in interface Map<Integer,Double>

Overrides:

remove in class AbstractInt2DoubleFunction

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

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

Specified by:

containsValue in interface Int2DoubleMap

Overrides:

containsValue in class AbstractInt2DoubleMap

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<Integer,Double>

Specified by:

clear in interface Map<Integer,Double>

Overrides:

clear in class AbstractInt2DoubleFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2DoubleMap

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

Specified by:

containsKey in interface Int2DoubleFunction

Overrides:

containsKey in class AbstractInt2DoubleMap

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<Integer,Double>

Specified by:

size in interface Map<Integer,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 Map<Integer,Double>

Overrides:

isEmpty in class AbstractInt2DoubleMap

get

public double get(int k)

Description copied from interface: Int2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2DoubleFunction

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)

firstIntKey

public int firstIntKey()

Specified by:

firstIntKey in interface Int2DoubleSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Specified by:

lastIntKey in interface Int2DoubleSortedMap

See Also:

SortedMap.lastKey()

int2DoubleEntrySet

public ObjectSortedSet<Int2DoubleMap.Entry> int2DoubleEntrySet()

Description copied from interface: Int2DoubleSortedMap

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:

int2DoubleEntrySet in interface Int2DoubleMap

Specified by:

int2DoubleEntrySet in interface Int2DoubleSortedMap

Returns:

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

See Also:

Int2DoubleSortedMap.entrySet()

keySet

public IntSortedSet 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 Int2DoubleMap

Specified by:

keySet in interface Int2DoubleSortedMap

Specified by:

keySet in interface Map<Integer,Double>

Specified by:

keySet in interface SortedMap<Integer,Double>

Overrides:

keySet in class AbstractInt2DoubleSortedMap

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 Int2DoubleMap

Specified by:

values in interface Int2DoubleSortedMap

Specified by:

values in interface Map<Integer,Double>

Specified by:

values in interface SortedMap<Integer,Double>

Overrides:

values in class AbstractInt2DoubleSortedMap

Returns:

a type-specific collection view of the values contained in this map.

See Also:

Map.values()

comparator

public IntComparator comparator()

Description copied from interface: Int2DoubleSortedMap

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 Int2DoubleSortedMap

Specified by:

comparator in interface SortedMap<Integer,Double>

See Also:

SortedMap.comparator()

headMap

public Int2DoubleSortedMap headMap(int to)

Description copied from interface: Int2DoubleSortedMap

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

Specified by:

headMap in interface Int2DoubleSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Int2DoubleSortedMap tailMap(int from)

Description copied from interface: Int2DoubleSortedMap

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

Specified by:

tailMap in interface Int2DoubleSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Int2DoubleSortedMap subMap(int from,
                         int to)

Description copied from interface: Int2DoubleSortedMap

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

Specified by:

subMap in interface Int2DoubleSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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