it.unimi.dsi.fastutil.shorts
Class Short2ReferenceArrayMap<V>

java.lang.Object
  it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceFunction<V>
      it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceMap<V>
          it.unimi.dsi.fastutil.shorts.Short2ReferenceArrayMap<V>

All Implemented Interfaces:

Function<java.lang.Short,V>, Short2ReferenceFunction<V>, Short2ReferenceMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Short,V>

public class Short2ReferenceArrayMap<V>
extends AbstractShort2ReferenceMap<V>
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.AbstractShort2ReferenceMap

AbstractShort2ReferenceMap.BasicEntry<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ReferenceMap

Short2ReferenceMap.Entry<V>, Short2ReferenceMap.FastEntrySet<V>

Constructor Summary

Short2ReferenceArrayMap()
Creates a new empty array map.

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

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

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

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

Short2ReferenceArrayMap(Short2ReferenceMap<V> 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).
Short2ReferenceArrayMap<V>	clone() Returns a deep copy of this map.
boolean	containsKey(short k) Checks whether the given value is contained in AbstractShort2ReferenceMap.keySet().
boolean	containsValue(java.lang.Object v) Checks whether the given value is contained in AbstractShort2ReferenceMap.values().
V	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.
V	put(short k, V v) Adds a pair to the map.
V	remove(short k) Removes the mapping with the given key.
Short2ReferenceMap.FastEntrySet<V>	short2ReferenceEntrySet() 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.
ReferenceCollection<V>	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceMap

entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceFunction

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

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

Short2ReferenceArrayMap

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

Short2ReferenceArrayMap

public Short2ReferenceArrayMap()

Creates a new empty array map.

Short2ReferenceArrayMap

public Short2ReferenceArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Short2ReferenceArrayMap

public Short2ReferenceArrayMap(Short2ReferenceMap<V> m)

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

Parameters:

m - a map.

Short2ReferenceArrayMap

public Short2ReferenceArrayMap(java.util.Map<? extends java.lang.Short,? extends V> m)

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

Parameters:

m - a map.

Short2ReferenceArrayMap

public Short2ReferenceArrayMap(short[] key,
                               java.lang.Object[] 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

short2ReferenceEntrySet

public Short2ReferenceMap.FastEntrySet<V> short2ReferenceEntrySet()

Description copied from interface: Short2ReferenceMap

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 Short2ReferenceMap.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:

short2ReferenceEntrySet in interface Short2ReferenceMap<V>

Returns:

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

See Also:

Short2ReferenceMap.entrySet()

get

public V get(short k)

Description copied from interface: Short2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Short2ReferenceFunction<V>

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,V>

Specified by:

size in interface java.util.Map<java.lang.Short,V>

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,V>

Specified by:

clear in interface java.util.Map<java.lang.Short,V>

Overrides:

clear in class AbstractShort2ReferenceFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(short k)

Description copied from class: AbstractShort2ReferenceMap

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

Specified by:

containsKey in interface Short2ReferenceFunction<V>

Overrides:

containsKey in class AbstractShort2ReferenceMap<V>

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object v)

Description copied from class: AbstractShort2ReferenceMap

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

Specified by:

containsValue in interface java.util.Map<java.lang.Short,V>

Overrides:

containsValue in class AbstractShort2ReferenceMap<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Short,V>

Overrides:

isEmpty in class AbstractShort2ReferenceMap<V>

put

public V put(short k,
             V v)

Description copied from interface: Short2ReferenceFunction

Adds a pair to the map.

Specified by:

put in interface Short2ReferenceFunction<V>

Overrides:

put in class AbstractShort2ReferenceFunction<V>

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 V remove(short k)

Description copied from interface: Short2ReferenceFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2ReferenceFunction<V>

Overrides:

remove in class AbstractShort2ReferenceFunction<V>

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

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

The view is backed by the set returned by AbstractShort2ReferenceMap.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 Short2ReferenceMap<V>

Specified by:

keySet in interface java.util.Map<java.lang.Short,V>

Overrides:

keySet in class AbstractShort2ReferenceMap<V>

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 ReferenceCollection<V> values()

Description copied from class: AbstractShort2ReferenceMap

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

The view is backed by the set returned by AbstractShort2ReferenceMap.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 Short2ReferenceMap<V>

Specified by:

values in interface java.util.Map<java.lang.Short,V>

Overrides:

values in class AbstractShort2ReferenceMap<V>

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 Short2ReferenceArrayMap<V> 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.