it.unimi.dsi.fastutil.doubles
Class Double2DoubleArrayMap

java.lang.Object
  it.unimi.dsi.fastutil.doubles.AbstractDouble2DoubleFunction
      it.unimi.dsi.fastutil.doubles.AbstractDouble2DoubleMap
          it.unimi.dsi.fastutil.doubles.Double2DoubleArrayMap

All Implemented Interfaces:

Double2DoubleFunction, Double2DoubleMap, Function<Double,Double>, Serializable, Cloneable, Map<Double,Double>

public class Double2DoubleArrayMap
extends AbstractDouble2DoubleMap
implements Serializable, Cloneable

A simple, brute-force implementation of a map based on two parallel backing arrays.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of pairs: just put them into two parallel arrays and scan linearly to find an item.

See Also:

Serialized Form

Nested Class Summary

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

AbstractDouble2DoubleMap.BasicEntry

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

Double2DoubleMap.Entry, Double2DoubleMap.FastEntrySet

Constructor Summary

Double2DoubleArrayMap()
Creates a new empty array map.

Double2DoubleArrayMap(double[] key, double[] value)
Creates a new empty array map with given key and value backing arrays.

Double2DoubleArrayMap(double[] key, double[] value, int size)
Creates a new array map with given key and value backing arrays, using the given number of elements.

Double2DoubleArrayMap(Double2DoubleMap m)
Creates a new empty array map copying the entries of a given map.

Double2DoubleArrayMap(int capacity)
Creates a new empty array map of given capacity.

Method Summary

void	clear() Removes all associations from this function (optional operation).
Object	clone() Returns a deep copy of this map.
boolean	containsKey(double k) Checks whether the given value is contained in AbstractDouble2DoubleMap.keySet().
boolean	containsValue(double v) Checks whether the given value is contained in AbstractDouble2DoubleMap.values().
Double2DoubleMap.FastEntrySet	double2DoubleEntrySet() Returns a type-specific set view of the mappings contained in this map.
double	get(double k) Returns the value to which the given key is mapped.
boolean	isEmpty()
DoubleSet	keySet() Returns a type-specific-set view of the keys of this map.
double	put(double k, double v) Adds a pair to the map.
double	remove(double k) Removes the mapping with the given key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
DoubleCollection	values() Returns a type-specific-set view of the values of this map.

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

containsValue, entrySet, equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get, put, remove

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2DoubleFunction

defaultReturnValue, defaultReturnValue

Methods inherited from interface it.unimi.dsi.fastutil.Function

containsKey, get, put, remove

Methods inherited from interface java.util.Map

containsKey, get, put, remove

Constructor Detail

Double2DoubleArrayMap

public Double2DoubleArrayMap(double[] key,
                             double[] value)

Creates a new empty array map with given key and value backing arrays.

Parameters:

key - the key array.

value - the value array (it must have the same length as key).

Double2DoubleArrayMap

public Double2DoubleArrayMap()

Creates a new empty array map.

Double2DoubleArrayMap

public Double2DoubleArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Double2DoubleArrayMap

public Double2DoubleArrayMap(Double2DoubleMap m)

Creates a new empty array map copying the entries of a given map.

Parameters:

m - a map.

Double2DoubleArrayMap

public Double2DoubleArrayMap(double[] key,
                             double[] value,
                             int size)

Creates a new array map with given key and value backing arrays, using the given number of elements.

Parameters:

key - the key array.

value - the value array (it must have the same length as key).

size - the number of valid elements in key and value.

Method Detail

double2DoubleEntrySet

public Double2DoubleMap.FastEntrySet double2DoubleEntrySet()

Description copied from interface: Double2DoubleMap

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

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Double2DoubleMap.entrySet() so that it returns an ObjectSet of objects of type Double2DoubleMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

double2DoubleEntrySet in interface Double2DoubleMap

Returns:

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

See Also:

Double2DoubleMap.entrySet()

get

public double get(double k)

Description copied from interface: Double2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Double2DoubleFunction

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)

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

Specified by:

size in interface Map<Double,Double>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<Double,Double>

Specified by:

clear in interface Map<Double,Double>

Overrides:

clear in class AbstractDouble2DoubleFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(double k)

Description copied from class: AbstractDouble2DoubleMap

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

Specified by:

containsKey in interface Double2DoubleFunction

Overrides:

containsKey in class AbstractDouble2DoubleMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(double v)

Description copied from class: AbstractDouble2DoubleMap

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

Specified by:

containsValue in interface Double2DoubleMap

Overrides:

containsValue in class AbstractDouble2DoubleMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Double,Double>

Overrides:

isEmpty in class AbstractDouble2DoubleMap

put

public double put(double k,
                  double v)

Description copied from interface: Double2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Double2DoubleFunction

Overrides:

put in class AbstractDouble2DoubleFunction

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

Description copied from interface: Double2DoubleFunction

Removes the mapping with the given key.

Specified by:

remove in interface Double2DoubleFunction

Overrides:

remove in class AbstractDouble2DoubleFunction

Returns:

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

See Also:

Function.remove(Object)

keySet

public DoubleSet keySet()

Description copied from class: AbstractDouble2DoubleMap

Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractDouble2DoubleMap.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

keySet in interface Double2DoubleMap

Specified by:

keySet in interface Map<Double,Double>

Overrides:

keySet in class AbstractDouble2DoubleMap

Returns:

a set view of the keys of this map; it may be safely cast to a type-specific interface.

See Also:

Map.keySet()

values

public DoubleCollection values()

Description copied from class: AbstractDouble2DoubleMap

Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractDouble2DoubleMap.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

values in interface Double2DoubleMap

Specified by:

values in interface Map<Double,Double>

Overrides:

values in class AbstractDouble2DoubleMap

Returns:

a set view of the values of this map; it may be safely cast to a type-specific interface.

See Also:

Map.values()

clone

public Object clone()

Returns a deep copy of this map.

This method performs a deep copy of this hash map; the data stored in the map, 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 map.