it.unimi.dsi.fastutil.objects
Class Object2ShortArrayMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2ShortFunction<K>
      it.unimi.dsi.fastutil.objects.AbstractObject2ShortMap<K>
          it.unimi.dsi.fastutil.objects.Object2ShortArrayMap<K>

All Implemented Interfaces:

Function<K,Short>, Object2ShortFunction<K>, Object2ShortMap<K>, Serializable, Cloneable, Map<K,Short>

public class Object2ShortArrayMap<K>
extends AbstractObject2ShortMap<K>
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.objects.AbstractObject2ShortMap

AbstractObject2ShortMap.BasicEntry<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ShortMap

Object2ShortMap.Entry<K>, Object2ShortMap.FastEntrySet<K>

Constructor Summary

Object2ShortArrayMap()
Creates a new empty array map.

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

Object2ShortArrayMap(Map<? extends K,? extends Short> m)
Creates a new empty array map copying the entries of a given map.

Object2ShortArrayMap(Object[] key, short[] value)
Creates a new empty array map with given key and value backing arrays.

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

Object2ShortArrayMap(Object2ShortMap<K> 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).
Object2ShortArrayMap<K>	clone() Returns a deep copy of this map.
boolean	containsKey(Object k) Checks whether the given value is contained in AbstractObject2ShortMap.keySet().
boolean	containsValue(short v) Checks whether the given value is contained in AbstractObject2ShortMap.values().
short	getShort(Object k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ObjectSet<K>	keySet() Returns a type-specific-set view of the keys of this map.
Object2ShortMap.FastEntrySet<K>	object2ShortEntrySet() Returns a type-specific set view of the mappings contained in this map.
short	put(K k, short v) Adds a pair to the map.
short	removeShort(Object 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.
ShortCollection	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ShortMap

containsValue, entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ShortFunction

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.objects.Object2ShortFunction

defaultReturnValue, defaultReturnValue

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

get, put, remove

Methods inherited from interface java.util.Map

get, put, remove

Constructor Detail

Object2ShortArrayMap

public Object2ShortArrayMap(Object[] key,
                            short[] 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).

Object2ShortArrayMap

public Object2ShortArrayMap()

Creates a new empty array map.

Object2ShortArrayMap

public Object2ShortArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Object2ShortArrayMap

public Object2ShortArrayMap(Object2ShortMap<K> m)

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

Parameters:

m - a map.

Object2ShortArrayMap

public Object2ShortArrayMap(Map<? extends K,? extends Short> m)

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

Parameters:

m - a map.

Object2ShortArrayMap

public Object2ShortArrayMap(Object[] key,
                            short[] 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

object2ShortEntrySet

public Object2ShortMap.FastEntrySet<K> object2ShortEntrySet()

Description copied from interface: Object2ShortMap

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

Specified by:

object2ShortEntrySet in interface Object2ShortMap<K>

Returns:

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

See Also:

Object2ShortMap.entrySet()

getShort

public short getShort(Object k)

Description copied from interface: Object2ShortFunction

Returns the value to which the given key is mapped.

Specified by:

getShort in interface Object2ShortFunction<K>

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<K,Short>

Specified by:

size in interface Map<K,Short>

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<K,Short>

Specified by:

clear in interface Map<K,Short>

Overrides:

clear in class AbstractObject2ShortFunction<K>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractObject2ShortMap

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

Specified by:

containsKey in interface Function<K,Short>

Specified by:

containsKey in interface Map<K,Short>

Overrides:

containsKey in class AbstractObject2ShortMap<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(short v)

Description copied from class: AbstractObject2ShortMap

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

Specified by:

containsValue in interface Object2ShortMap<K>

Overrides:

containsValue in class AbstractObject2ShortMap<K>

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Short>

Overrides:

isEmpty in class AbstractObject2ShortMap<K>

put

public short put(K k,
                 short v)

Description copied from interface: Object2ShortFunction

Adds a pair to the map.

Specified by:

put in interface Object2ShortFunction<K>

Overrides:

put in class AbstractObject2ShortFunction<K>

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)

removeShort

public short removeShort(Object k)

Description copied from interface: Object2ShortFunction

Removes the mapping with the given key.

Specified by:

removeShort in interface Object2ShortFunction<K>

Overrides:

removeShort in class AbstractObject2ShortFunction<K>

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 ObjectSet<K> keySet()

Description copied from class: AbstractObject2ShortMap

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

The view is backed by the set returned by AbstractObject2ShortMap.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 Object2ShortMap<K>

Specified by:

keySet in interface Map<K,Short>

Overrides:

keySet in class AbstractObject2ShortMap<K>

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

Description copied from class: AbstractObject2ShortMap

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

The view is backed by the set returned by AbstractObject2ShortMap.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 Object2ShortMap<K>

Specified by:

values in interface Map<K,Short>

Overrides:

values in class AbstractObject2ShortMap<K>

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 Object2ShortArrayMap<K> 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.