it.unimi.dsi.fastutil.shorts
Class Short2DoubleArrayMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleFunction
      extended by it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleMap
          extended by it.unimi.dsi.fastutil.shorts.Short2DoubleArrayMap
All Implemented Interfaces:
Function<java.lang.Short,java.lang.Double>, Short2DoubleFunction, Short2DoubleMap, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Short,java.lang.Double>

public class Short2DoubleArrayMap
extends AbstractShort2DoubleMap
implements java.io.Serializable, java.lang.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.shorts.AbstractShort2DoubleMap
AbstractShort2DoubleMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2DoubleMap
Short2DoubleMap.Entry, Short2DoubleMap.FastEntrySet
 
Constructor Summary
Short2DoubleArrayMap()
          Creates a new empty array map.
Short2DoubleArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Short2DoubleArrayMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Double> m)
          Creates a new empty array map copying the entries of a given map.
Short2DoubleArrayMap(short[] key, double[] value)
          Creates a new empty array map with given key and value backing arrays.
Short2DoubleArrayMap(short[] key, double[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Short2DoubleArrayMap(Short2DoubleMap m)
          Creates a new empty array map copying the entries of a given map.
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 Short2DoubleArrayMap clone()
          Returns a deep copy of this map.
 boolean containsKey(short k)
          Checks whether the given value is contained in AbstractShort2DoubleMap.keySet().
 boolean containsValue(double v)
          Checks whether the given value is contained in AbstractShort2DoubleMap.values().
 double get(short k)
          Returns the value to which the given key is mapped.
 boolean isEmpty()
           
 ShortSet keySet()
          Returns a type-specific-set view of the keys of this map.
 double put(short k, double v)
          Adds a pair to the map.
 double remove(short k)
          Removes the mapping with the given key.
 Short2DoubleMap.FastEntrySet short2DoubleEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 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.shorts.AbstractShort2DoubleMap
containsValue, entrySet, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2DoubleFunction
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.shorts.Short2DoubleFunction
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

Short2DoubleArrayMap

public Short2DoubleArrayMap(short[] 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).

Short2DoubleArrayMap

public Short2DoubleArrayMap()
Creates a new empty array map.


Short2DoubleArrayMap

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

Parameters:
capacity - the initial capacity.

Short2DoubleArrayMap

public Short2DoubleArrayMap(Short2DoubleMap m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Short2DoubleArrayMap

public Short2DoubleArrayMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Double> m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Short2DoubleArrayMap

public Short2DoubleArrayMap(short[] 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

short2DoubleEntrySet

public Short2DoubleMap.FastEntrySet short2DoubleEntrySet()
Description copied from interface: Short2DoubleMap
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 Short2DoubleMap.entrySet() so that it returns an ObjectSet of objects of type Map.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
short2DoubleEntrySet in interface Short2DoubleMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Short2DoubleMap.entrySet()

get

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

Specified by:
get in interface Short2DoubleFunction
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<java.lang.Short,java.lang.Double>
Specified by:
size in interface java.util.Map<java.lang.Short,java.lang.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<java.lang.Short,java.lang.Double>
Specified by:
clear in interface java.util.Map<java.lang.Short,java.lang.Double>
Overrides:
clear in class AbstractShort2DoubleFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Short2DoubleFunction
Overrides:
containsKey in class AbstractShort2DoubleMap
See Also:
Function.containsKey(Object)

containsValue

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

Specified by:
containsValue in interface Short2DoubleMap
Overrides:
containsValue in class AbstractShort2DoubleMap
See Also:
Map.containsValue(Object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.Short,java.lang.Double>
Overrides:
isEmpty in class AbstractShort2DoubleMap

put

public double put(short k,
                  double v)
Description copied from interface: Short2DoubleFunction
Adds a pair to the map.

Specified by:
put in interface Short2DoubleFunction
Overrides:
put in class AbstractShort2DoubleFunction
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(short k)
Description copied from interface: Short2DoubleFunction
Removes the mapping with the given key.

Specified by:
remove in interface Short2DoubleFunction
Overrides:
remove in class AbstractShort2DoubleFunction
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 ShortSet keySet()
Description copied from class: AbstractShort2DoubleMap
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractShort2DoubleMap.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 Short2DoubleMap
Specified by:
keySet in interface java.util.Map<java.lang.Short,java.lang.Double>
Overrides:
keySet in class AbstractShort2DoubleMap
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: AbstractShort2DoubleMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractShort2DoubleMap.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 Short2DoubleMap
Specified by:
values in interface java.util.Map<java.lang.Short,java.lang.Double>
Overrides:
values in class AbstractShort2DoubleMap
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 Short2DoubleArrayMap 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 java.lang.Object
Returns:
a deep copy of this map.