it.unimi.dsi.fastutil.bytes
Class Byte2DoubleArrayMap

java.lang.Object
  it.unimi.dsi.fastutil.bytes.AbstractByte2DoubleFunction
      it.unimi.dsi.fastutil.bytes.AbstractByte2DoubleMap
          it.unimi.dsi.fastutil.bytes.Byte2DoubleArrayMap

All Implemented Interfaces:

Byte2DoubleFunction, Byte2DoubleMap, Function<Byte,Double>, Serializable, Cloneable, Map<Byte,Double>

public class Byte2DoubleArrayMap
extends AbstractByte2DoubleMap
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.bytes.AbstractByte2DoubleMap

AbstractByte2DoubleMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2DoubleMap

Byte2DoubleMap.Entry, Byte2DoubleMap.FastEntrySet

Constructor Summary

Byte2DoubleArrayMap()
Creates a new empty array map.

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

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

Byte2DoubleArrayMap(Byte2DoubleMap m)
Creates a new empty array map copying the entries of a given map.

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

Byte2DoubleArrayMap(Map<? extends Byte,? extends Double> m)
Creates a new empty array map copying the entries of a given map.

Method Summary

Byte2DoubleMap.FastEntrySet	byte2DoubleEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
Byte2DoubleArrayMap	clone() Returns a deep copy of this map.
boolean	containsKey(byte k) Checks whether the given value is contained in AbstractByte2DoubleMap.keySet().
boolean	containsValue(double v) Checks whether the given value is contained in AbstractByte2DoubleMap.values().
double	get(byte k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ByteSet	keySet() Returns a type-specific-set view of the keys of this map.
double	put(byte k, double v) Adds a pair to the map.
double	remove(byte 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.bytes.AbstractByte2DoubleMap

containsValue, entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2DoubleFunction

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.bytes.Byte2DoubleFunction

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

Byte2DoubleArrayMap

public Byte2DoubleArrayMap(byte[] key,
                           double[] value)

Creates a new empty array map with given key and value backing arrays. The resulting map will have as many entries as the given arrays.

It is responsibility of the caller that the elements of key are distinct.

Parameters:

key - the key array.

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

Byte2DoubleArrayMap

public Byte2DoubleArrayMap()

Creates a new empty array map.

Byte2DoubleArrayMap

public Byte2DoubleArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Byte2DoubleArrayMap

public Byte2DoubleArrayMap(Byte2DoubleMap m)

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

Parameters:

m - a map.

Byte2DoubleArrayMap

public Byte2DoubleArrayMap(Map<? extends Byte,? extends Double> m)

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

Parameters:

m - a map.

Byte2DoubleArrayMap

public Byte2DoubleArrayMap(byte[] key,
                           double[] value,
                           int size)

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

It is responsibility of the caller that the first size elements of key are distinct.

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

byte2DoubleEntrySet

public Byte2DoubleMap.FastEntrySet byte2DoubleEntrySet()

Description copied from interface: Byte2DoubleMap

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 Byte2DoubleMap.entrySet() so that it returns an ObjectSet of objects of type Byte2DoubleMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

byte2DoubleEntrySet in interface Byte2DoubleMap

Returns:

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

See Also:

Byte2DoubleMap.entrySet()

get

public double get(byte k)

Description copied from interface: Byte2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2DoubleFunction

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

Specified by:

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

Specified by:

clear in interface Map<Byte,Double>

Overrides:

clear in class AbstractByte2DoubleFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(byte k)

Description copied from class: AbstractByte2DoubleMap

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

Specified by:

containsKey in interface Byte2DoubleFunction

Overrides:

containsKey in class AbstractByte2DoubleMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(double v)

Description copied from class: AbstractByte2DoubleMap

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

Specified by:

containsValue in interface Byte2DoubleMap

Overrides:

containsValue in class AbstractByte2DoubleMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Byte,Double>

Overrides:

isEmpty in class AbstractByte2DoubleMap

put

public double put(byte k,
                  double v)

Description copied from interface: Byte2DoubleFunction

Adds a pair to the map.

Specified by:

put in interface Byte2DoubleFunction

Overrides:

put in class AbstractByte2DoubleFunction

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

Description copied from interface: Byte2DoubleFunction

Removes the mapping with the given key.

Specified by:

remove in interface Byte2DoubleFunction

Overrides:

remove in class AbstractByte2DoubleFunction

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 ByteSet keySet()

Description copied from class: AbstractByte2DoubleMap

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

The view is backed by the set returned by AbstractByte2DoubleMap.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 Byte2DoubleMap

Specified by:

keySet in interface Map<Byte,Double>

Overrides:

keySet in class AbstractByte2DoubleMap

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

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

The view is backed by the set returned by AbstractByte2DoubleMap.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 Byte2DoubleMap

Specified by:

values in interface Map<Byte,Double>

Overrides:

values in class AbstractByte2DoubleMap

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