it.unimi.dsi.fastutil.bytes
Class Byte2ShortArrayMap

java.lang.Object
  it.unimi.dsi.fastutil.bytes.AbstractByte2ShortFunction
      it.unimi.dsi.fastutil.bytes.AbstractByte2ShortMap
          it.unimi.dsi.fastutil.bytes.Byte2ShortArrayMap

All Implemented Interfaces:

Byte2ShortFunction, Byte2ShortMap, Function<Byte,Short>, Serializable, Cloneable, Map<Byte,Short>

public class Byte2ShortArrayMap
extends AbstractByte2ShortMap
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.bytes.AbstractByte2ShortMap

AbstractByte2ShortMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ShortMap

Byte2ShortMap.Entry, Byte2ShortMap.FastEntrySet

Constructor Summary

Byte2ShortArrayMap()
Creates a new empty array map.

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

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

Byte2ShortArrayMap(Byte2ShortMap m)
Creates a new empty array map copying the entries of a given map.

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

Method Summary

Byte2ShortMap.FastEntrySet	byte2ShortEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
Object	clone() Returns a deep copy of this map.
boolean	containsKey(byte k) Checks whether the given value is contained in AbstractByte2ShortMap.keySet().
boolean	containsValue(short v) Checks whether the given value is contained in AbstractByte2ShortMap.values().
short	get(byte k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ByteSet	keySet() Returns a type-specific-set view of the keys of this map.
short	put(byte k, short v) Adds a pair to the map.
short	remove(byte 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.bytes.AbstractByte2ShortMap

containsValue, entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ShortFunction

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.bytes.Byte2ShortFunction

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

Byte2ShortArrayMap

public Byte2ShortArrayMap(byte[] key,
                          short[] value)

Creates a new empty array map with given key and value backing arrays.

Parameters:

key - the key array.

value - the value array (it must have the same length as key).

Byte2ShortArrayMap

public Byte2ShortArrayMap()

Creates a new empty array map.

Byte2ShortArrayMap

public Byte2ShortArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Byte2ShortArrayMap

public Byte2ShortArrayMap(Byte2ShortMap m)

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

Parameters:

m - a map.

Byte2ShortArrayMap

public Byte2ShortArrayMap(byte[] key,
                          short[] value,
                          int size)

Creates a new array map with given key and value backing arrays, using the given number of elements.

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

byte2ShortEntrySet

public Byte2ShortMap.FastEntrySet byte2ShortEntrySet()

Description copied from interface: Byte2ShortMap

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

Specified by:

byte2ShortEntrySet in interface Byte2ShortMap

Returns:

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

See Also:

Byte2ShortMap.entrySet()

get

public short get(byte k)

Description copied from interface: Byte2ShortFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2ShortFunction

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

Specified by:

size in interface Map<Byte,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<Byte,Short>

Specified by:

clear in interface Map<Byte,Short>

Overrides:

clear in class AbstractByte2ShortFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(byte k)

Description copied from class: AbstractByte2ShortMap

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

Specified by:

containsKey in interface Byte2ShortFunction

Overrides:

containsKey in class AbstractByte2ShortMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(short v)

Description copied from class: AbstractByte2ShortMap

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

Specified by:

containsValue in interface Byte2ShortMap

Overrides:

containsValue in class AbstractByte2ShortMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Byte,Short>

Overrides:

isEmpty in class AbstractByte2ShortMap

put

public short put(byte k,
                 short v)

Description copied from interface: Byte2ShortFunction

Adds a pair to the map.

Specified by:

put in interface Byte2ShortFunction

Overrides:

put in class AbstractByte2ShortFunction

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

Description copied from interface: Byte2ShortFunction

Removes the mapping with the given key.

Specified by:

remove in interface Byte2ShortFunction

Overrides:

remove in class AbstractByte2ShortFunction

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 ByteSet keySet()

Description copied from class: AbstractByte2ShortMap

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

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

Specified by:

keySet in interface Map<Byte,Short>

Overrides:

keySet in class AbstractByte2ShortMap

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

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

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

Specified by:

values in interface Map<Byte,Short>

Overrides:

values in class AbstractByte2ShortMap

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