it.unimi.dsi.fastutil.longs
Class Long2ByteArrayMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.longs.AbstractLong2ByteFunction
      extended by it.unimi.dsi.fastutil.longs.AbstractLong2ByteMap
          extended by it.unimi.dsi.fastutil.longs.Long2ByteArrayMap
All Implemented Interfaces:
Function<Long,Byte>, Long2ByteFunction, Long2ByteMap, Serializable, Cloneable, Map<Long,Byte>

public class Long2ByteArrayMap
extends AbstractLong2ByteMap
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.longs.AbstractLong2ByteMap
AbstractLong2ByteMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2ByteMap
Long2ByteMap.Entry, Long2ByteMap.FastEntrySet
 
Constructor Summary
Long2ByteArrayMap()
          Creates a new empty array map.
Long2ByteArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Long2ByteArrayMap(long[] key, byte[] value)
          Creates a new empty array map with given key and value backing arrays.
Long2ByteArrayMap(long[] key, byte[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Long2ByteArrayMap(Long2ByteMap m)
          Creates a new empty array map copying the entries of a given map.
Long2ByteArrayMap(Map<? extends Long,? extends Byte> 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).
 Long2ByteArrayMap clone()
          Returns a deep copy of this map.
 boolean containsKey(long k)
          Checks whether the given value is contained in AbstractLong2ByteMap.keySet().
 boolean containsValue(byte v)
          Checks whether the given value is contained in AbstractLong2ByteMap.values().
 byte get(long k)
          Returns the value to which the given key is mapped.
 boolean isEmpty()
           
 LongSet keySet()
          Returns a type-specific-set view of the keys of this map.
 Long2ByteMap.FastEntrySet long2ByteEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 byte put(long k, byte v)
          Adds a pair to the map.
 byte remove(long 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.longs.AbstractLong2ByteMap
containsValue, entrySet, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ByteFunction
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.longs.Long2ByteFunction
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

Long2ByteArrayMap

public Long2ByteArrayMap(long[] 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).

Long2ByteArrayMap

public Long2ByteArrayMap()
Creates a new empty array map.


Long2ByteArrayMap

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

Parameters:
capacity - the initial capacity.

Long2ByteArrayMap

public Long2ByteArrayMap(Long2ByteMap m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Long2ByteArrayMap

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

Parameters:
m - a map.

Long2ByteArrayMap

public Long2ByteArrayMap(long[] 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

long2ByteEntrySet

public Long2ByteMap.FastEntrySet long2ByteEntrySet()
Description copied from interface: Long2ByteMap
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 Long2ByteMap.entrySet() so that it returns an ObjectSet of objects of type Long2ByteMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
long2ByteEntrySet in interface Long2ByteMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Long2ByteMap.entrySet()

get

public byte get(long k)
Description copied from interface: Long2ByteFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Long2ByteFunction
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<Long,Byte>
Specified by:
size in interface Map<Long,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<Long,Byte>
Specified by:
clear in interface Map<Long,Byte>
Overrides:
clear in class AbstractLong2ByteFunction
See Also:
Map.clear()

containsKey

public boolean containsKey(long k)
Description copied from class: AbstractLong2ByteMap
Checks whether the given value is contained in AbstractLong2ByteMap.keySet().

Specified by:
containsKey in interface Long2ByteFunction
Overrides:
containsKey in class AbstractLong2ByteMap
See Also:
Function.containsKey(Object)

containsValue

public boolean containsValue(byte v)
Description copied from class: AbstractLong2ByteMap
Checks whether the given value is contained in AbstractLong2ByteMap.values().

Specified by:
containsValue in interface Long2ByteMap
Overrides:
containsValue in class AbstractLong2ByteMap
See Also:
Map.containsValue(Object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map<Long,Byte>
Overrides:
isEmpty in class AbstractLong2ByteMap

put

public byte put(long k,
                byte v)
Description copied from interface: Long2ByteFunction
Adds a pair to the map.

Specified by:
put in interface Long2ByteFunction
Overrides:
put in class AbstractLong2ByteFunction
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(long k)
Description copied from interface: Long2ByteFunction
Removes the mapping with the given key.

Specified by:
remove in interface Long2ByteFunction
Overrides:
remove in class AbstractLong2ByteFunction
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 LongSet keySet()
Description copied from class: AbstractLong2ByteMap
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractLong2ByteMap.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 Long2ByteMap
Specified by:
keySet in interface Map<Long,Byte>
Overrides:
keySet in class AbstractLong2ByteMap
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: AbstractLong2ByteMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractLong2ByteMap.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 Long2ByteMap
Specified by:
values in interface Map<Long,Byte>
Overrides:
values in class AbstractLong2ByteMap
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 Long2ByteArrayMap 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.