it.unimi.dsi.fastutil.shorts
Class Short2ByteArrayMap

java.lang.Object
  it.unimi.dsi.fastutil.shorts.AbstractShort2ByteFunction
      it.unimi.dsi.fastutil.shorts.AbstractShort2ByteMap
          it.unimi.dsi.fastutil.shorts.Short2ByteArrayMap

All Implemented Interfaces:

Function<Short,Byte>, Short2ByteFunction, Short2ByteMap, Serializable, Cloneable, Map<Short,Byte>

public class Short2ByteArrayMap
extends AbstractShort2ByteMap
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.shorts.AbstractShort2ByteMap

AbstractShort2ByteMap.BasicEntry

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

Short2ByteMap.Entry, Short2ByteMap.FastEntrySet

Constructor Summary

Short2ByteArrayMap()
Creates a new empty array map.

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

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

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

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

Short2ByteArrayMap(Short2ByteMap 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).
Short2ByteArrayMap	clone() Returns a deep copy of this map.
boolean	containsKey(short k) Checks whether the given value is contained in AbstractShort2ByteMap.keySet().
boolean	containsValue(byte v) Checks whether the given value is contained in AbstractShort2ByteMap.values().
byte	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.
byte	put(short k, byte v) Adds a pair to the map.
byte	remove(short k) Removes the mapping with the given key.
Short2ByteMap.FastEntrySet	short2ByteEntrySet() 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.
ByteCollection	values() Returns a type-specific-set view of the values of this map.

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

containsValue, entrySet, equals, hashCode, putAll, toString

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

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

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

Short2ByteArrayMap

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

Short2ByteArrayMap

public Short2ByteArrayMap()

Creates a new empty array map.

Short2ByteArrayMap

public Short2ByteArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Short2ByteArrayMap

public Short2ByteArrayMap(Short2ByteMap m)

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

Parameters:

m - a map.

Short2ByteArrayMap

public Short2ByteArrayMap(Map<? extends Short,? extends Byte> m)

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

Parameters:

m - a map.

Short2ByteArrayMap

public Short2ByteArrayMap(short[] key,
                          byte[] 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

short2ByteEntrySet

public Short2ByteMap.FastEntrySet short2ByteEntrySet()

Description copied from interface: Short2ByteMap

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

Specified by:

short2ByteEntrySet in interface Short2ByteMap

Returns:

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

See Also:

Short2ByteMap.entrySet()

get

public byte get(short k)

Description copied from interface: Short2ByteFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Short2ByteFunction

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

Specified by:

size in interface Map<Short,Byte>

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

Specified by:

clear in interface Map<Short,Byte>

Overrides:

clear in class AbstractShort2ByteFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(short k)

Description copied from class: AbstractShort2ByteMap

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

Specified by:

containsKey in interface Short2ByteFunction

Overrides:

containsKey in class AbstractShort2ByteMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(byte v)

Description copied from class: AbstractShort2ByteMap

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

Specified by:

containsValue in interface Short2ByteMap

Overrides:

containsValue in class AbstractShort2ByteMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Short,Byte>

Overrides:

isEmpty in class AbstractShort2ByteMap

put

public byte put(short k,
                byte v)

Description copied from interface: Short2ByteFunction

Adds a pair to the map.

Specified by:

put in interface Short2ByteFunction

Overrides:

put in class AbstractShort2ByteFunction

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

Description copied from interface: Short2ByteFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2ByteFunction

Overrides:

remove in class AbstractShort2ByteFunction

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

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

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

Specified by:

keySet in interface Map<Short,Byte>

Overrides:

keySet in class AbstractShort2ByteMap

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

Description copied from class: AbstractShort2ByteMap

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

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

Specified by:

values in interface Map<Short,Byte>

Overrides:

values in class AbstractShort2ByteMap

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