it.unimi.dsi.fastutil.floats
Class Float2IntArrayMap

java.lang.Object
  it.unimi.dsi.fastutil.floats.AbstractFloat2IntFunction
      it.unimi.dsi.fastutil.floats.AbstractFloat2IntMap
          it.unimi.dsi.fastutil.floats.Float2IntArrayMap

All Implemented Interfaces:

Float2IntFunction, Float2IntMap, Function<Float,Integer>, Serializable, Cloneable, Map<Float,Integer>

public class Float2IntArrayMap
extends AbstractFloat2IntMap
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.floats.AbstractFloat2IntMap

AbstractFloat2IntMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.floats.Float2IntMap

Float2IntMap.Entry, Float2IntMap.FastEntrySet

Constructor Summary

Float2IntArrayMap()
Creates a new empty array map.

Float2IntArrayMap(float[] key, int[] value)
Creates a new empty array map with given key and value backing arrays.

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

Float2IntArrayMap(Float2IntMap m)
Creates a new empty array map copying the entries of a given map.

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

Float2IntArrayMap(Map<? extends Float,? extends Integer> 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).
Float2IntArrayMap	clone() Returns a deep copy of this map.
boolean	containsKey(float k) Checks whether the given value is contained in AbstractFloat2IntMap.keySet().
boolean	containsValue(int v) Checks whether the given value is contained in AbstractFloat2IntMap.values().
Float2IntMap.FastEntrySet	float2IntEntrySet() Returns a type-specific set view of the mappings contained in this map.
int	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.
int	put(float k, int v) Adds a pair to the map.
int	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.
IntCollection	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2IntMap

containsValue, entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloat2IntFunction

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

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

Float2IntArrayMap

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

Float2IntArrayMap

public Float2IntArrayMap()

Creates a new empty array map.

Float2IntArrayMap

public Float2IntArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Float2IntArrayMap

public Float2IntArrayMap(Float2IntMap m)

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

Parameters:

m - a map.

Float2IntArrayMap

public Float2IntArrayMap(Map<? extends Float,? extends Integer> m)

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

Parameters:

m - a map.

Float2IntArrayMap

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

float2IntEntrySet

public Float2IntMap.FastEntrySet float2IntEntrySet()

Description copied from interface: Float2IntMap

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

Specified by:

float2IntEntrySet in interface Float2IntMap

Returns:

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

See Also:

Float2IntMap.entrySet()

get

public int get(float k)

Description copied from interface: Float2IntFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Float2IntFunction

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

Specified by:

size in interface Map<Float,Integer>

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

Specified by:

clear in interface Map<Float,Integer>

Overrides:

clear in class AbstractFloat2IntFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(float k)

Description copied from class: AbstractFloat2IntMap

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

Specified by:

containsKey in interface Float2IntFunction

Overrides:

containsKey in class AbstractFloat2IntMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(int v)

Description copied from class: AbstractFloat2IntMap

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

Specified by:

containsValue in interface Float2IntMap

Overrides:

containsValue in class AbstractFloat2IntMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Float,Integer>

Overrides:

isEmpty in class AbstractFloat2IntMap

put

public int put(float k,
               int v)

Description copied from interface: Float2IntFunction

Adds a pair to the map.

Specified by:

put in interface Float2IntFunction

Overrides:

put in class AbstractFloat2IntFunction

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

Description copied from interface: Float2IntFunction

Removes the mapping with the given key.

Specified by:

remove in interface Float2IntFunction

Overrides:

remove in class AbstractFloat2IntFunction

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

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

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

Specified by:

keySet in interface Map<Float,Integer>

Overrides:

keySet in class AbstractFloat2IntMap

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 IntCollection values()

Description copied from class: AbstractFloat2IntMap

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

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

Specified by:

values in interface Map<Float,Integer>

Overrides:

values in class AbstractFloat2IntMap

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