it.unimi.dsi.fastutil.floats
Class Float2FloatArrayMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.floats.AbstractFloat2FloatFunction
      extended by it.unimi.dsi.fastutil.floats.AbstractFloat2FloatMap
          extended by it.unimi.dsi.fastutil.floats.Float2FloatArrayMap
All Implemented Interfaces:
Float2FloatFunction, Float2FloatMap, Function<java.lang.Float,java.lang.Float>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Float,java.lang.Float>

public class Float2FloatArrayMap
extends AbstractFloat2FloatMap
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.floats.AbstractFloat2FloatMap
AbstractFloat2FloatMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.floats.Float2FloatMap
Float2FloatMap.Entry, Float2FloatMap.FastEntrySet
 
Constructor Summary
Float2FloatArrayMap()
          Creates a new empty array map.
Float2FloatArrayMap(float[] key, float[] value)
          Creates a new empty array map with given key and value backing arrays.
Float2FloatArrayMap(float[] key, float[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Float2FloatArrayMap(Float2FloatMap m)
          Creates a new empty array map copying the entries of a given map.
Float2FloatArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Float2FloatArrayMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> 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).
 Float2FloatArrayMap clone()
          Returns a deep copy of this map.
 boolean containsKey(float k)
          Checks whether the given value is contained in AbstractFloat2FloatMap.keySet().
 boolean containsValue(float v)
          Checks whether the given value is contained in AbstractFloat2FloatMap.values().
 Float2FloatMap.FastEntrySet float2FloatEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 float get(float k)
          Returns the value to which the given key is mapped.
 boolean isEmpty()
           
 FloatSet keySet()
          Returns a type-specific-set view of the keys of this map.
 float put(float k, float v)
          Adds a pair to the map.
 float remove(float 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.
 FloatCollection values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2FloatMap
containsValue, entrySet, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2FloatFunction
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.floats.Float2FloatFunction
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

Float2FloatArrayMap

public Float2FloatArrayMap(float[] key,
                           float[] 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).

Float2FloatArrayMap

public Float2FloatArrayMap()
Creates a new empty array map.


Float2FloatArrayMap

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

Parameters:
capacity - the initial capacity.

Float2FloatArrayMap

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

Parameters:
m - a map.

Float2FloatArrayMap

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

Parameters:
m - a map.

Float2FloatArrayMap

public Float2FloatArrayMap(float[] key,
                           float[] 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

float2FloatEntrySet

public Float2FloatMap.FastEntrySet float2FloatEntrySet()
Description copied from interface: Float2FloatMap
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 Float2FloatMap.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:
float2FloatEntrySet in interface Float2FloatMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Float2FloatMap.entrySet()

get

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

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

containsKey

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

Specified by:
containsKey in interface Float2FloatFunction
Overrides:
containsKey in class AbstractFloat2FloatMap
See Also:
Function.containsKey(Object)

containsValue

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

Specified by:
containsValue in interface Float2FloatMap
Overrides:
containsValue in class AbstractFloat2FloatMap
See Also:
Map.containsValue(Object)

isEmpty

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

put

public float put(float k,
                 float v)
Description copied from interface: Float2FloatFunction
Adds a pair to the map.

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

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

The view is backed by the set returned by AbstractFloat2FloatMap.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 Float2FloatMap
Specified by:
keySet in interface java.util.Map<java.lang.Float,java.lang.Float>
Overrides:
keySet in class AbstractFloat2FloatMap
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 FloatCollection values()
Description copied from class: AbstractFloat2FloatMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractFloat2FloatMap.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 Float2FloatMap
Specified by:
values in interface java.util.Map<java.lang.Float,java.lang.Float>
Overrides:
values in class AbstractFloat2FloatMap
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 Float2FloatArrayMap 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.