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

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2ByteFunction<K>
      it.unimi.dsi.fastutil.objects.AbstractObject2ByteMap<K>
          it.unimi.dsi.fastutil.objects.Object2ByteArrayMap<K>

All Implemented Interfaces:

Function<K,Byte>, Object2ByteFunction<K>, Object2ByteMap<K>, Serializable, Cloneable, Map<K,Byte>

public class Object2ByteArrayMap<K>
extends AbstractObject2ByteMap<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.AbstractObject2ByteMap

AbstractObject2ByteMap.BasicEntry<K>

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

Object2ByteMap.Entry<K>, Object2ByteMap.FastEntrySet<K>

Constructor Summary

Object2ByteArrayMap()
Creates a new empty array map.

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

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

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

Object2ByteArrayMap(Object2ByteMap<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).
Object	clone() Returns a deep copy of this map.
boolean	containsKey(Object k) Checks whether the given value is contained in AbstractObject2ByteMap.keySet().
boolean	containsValue(byte v) Checks whether the given value is contained in AbstractObject2ByteMap.values().
byte	getByte(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.
Object2ByteMap.FastEntrySet<K>	object2ByteEntrySet() Returns a type-specific set view of the mappings contained in this map.
byte	put(K k, byte v) Adds a pair to the map.
byte	removeByte(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.
ByteCollection	values() Returns a type-specific-set view of the values of this map.

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

containsValue, entrySet, equals, hashCode, putAll, toString

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

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

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

Object2ByteArrayMap

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

Object2ByteArrayMap

public Object2ByteArrayMap()

Creates a new empty array map.

Object2ByteArrayMap

public Object2ByteArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Object2ByteArrayMap

public Object2ByteArrayMap(Object2ByteMap<K> m)

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

Parameters:

m - a map.

Object2ByteArrayMap

public Object2ByteArrayMap(Object[] key,
                           byte[] 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

object2ByteEntrySet

public Object2ByteMap.FastEntrySet<K> object2ByteEntrySet()

Description copied from interface: Object2ByteMap

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

Specified by:

object2ByteEntrySet in interface Object2ByteMap<K>

Returns:

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

See Also:

Object2ByteMap.entrySet()

getByte

public byte getByte(Object k)

Description copied from interface: Object2ByteFunction

Returns the value to which the given key is mapped.

Specified by:

getByte in interface Object2ByteFunction<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,Byte>

Specified by:

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

Specified by:

clear in interface Map<K,Byte>

Overrides:

clear in class AbstractObject2ByteFunction<K>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractObject2ByteMap

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

Specified by:

containsKey in interface Function<K,Byte>

Specified by:

containsKey in interface Map<K,Byte>

Overrides:

containsKey in class AbstractObject2ByteMap<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(byte v)

Description copied from class: AbstractObject2ByteMap

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

Specified by:

containsValue in interface Object2ByteMap<K>

Overrides:

containsValue in class AbstractObject2ByteMap<K>

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Byte>

Overrides:

isEmpty in class AbstractObject2ByteMap<K>

put

public byte put(K k,
                byte v)

Description copied from interface: Object2ByteFunction

Adds a pair to the map.

Specified by:

put in interface Object2ByteFunction<K>

Overrides:

put in class AbstractObject2ByteFunction<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)

removeByte

public byte removeByte(Object k)

Description copied from interface: Object2ByteFunction

Removes the mapping with the given key.

Specified by:

removeByte in interface Object2ByteFunction<K>

Overrides:

removeByte in class AbstractObject2ByteFunction<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: AbstractObject2ByteMap

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

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

Specified by:

keySet in interface Map<K,Byte>

Overrides:

keySet in class AbstractObject2ByteMap<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 ByteCollection values()

Description copied from class: AbstractObject2ByteMap

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

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

Specified by:

values in interface Map<K,Byte>

Overrides:

values in class AbstractObject2ByteMap<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 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.