it.unimi.dsi.fastutil.bytes
Class Byte2IntArrayMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.bytes.AbstractByte2IntFunction
      extended by it.unimi.dsi.fastutil.bytes.AbstractByte2IntMap
          extended by it.unimi.dsi.fastutil.bytes.Byte2IntArrayMap
All Implemented Interfaces:
Byte2IntFunction, Byte2IntMap, Function<java.lang.Byte,java.lang.Integer>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Byte,java.lang.Integer>

public class Byte2IntArrayMap
extends AbstractByte2IntMap
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.bytes.AbstractByte2IntMap
AbstractByte2IntMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntMap
Byte2IntMap.Entry, Byte2IntMap.FastEntrySet
 
Constructor Summary
Byte2IntArrayMap()
          Creates a new empty array map.
Byte2IntArrayMap(byte[] key, int[] value)
          Creates a new empty array map with given key and value backing arrays.
Byte2IntArrayMap(byte[] key, int[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Byte2IntArrayMap(Byte2IntMap m)
          Creates a new empty array map copying the entries of a given map.
Byte2IntArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Byte2IntArrayMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Integer> m)
          Creates a new empty array map copying the entries of a given map.
 
Method Summary
 Byte2IntMap.FastEntrySet byte2IntEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 Byte2IntArrayMap clone()
          Returns a deep copy of this map.
 boolean containsKey(byte k)
          Checks whether the given value is contained in AbstractByte2IntMap.keySet().
 boolean containsValue(int v)
          Checks whether the given value is contained in AbstractByte2IntMap.values().
 int 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.
 int put(byte k, int v)
          Adds a pair to the map.
 int 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.
 IntCollection values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2IntMap
containsValue, entrySet, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2IntFunction
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.Byte2IntFunction
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

Byte2IntArrayMap

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

Byte2IntArrayMap

public Byte2IntArrayMap()
Creates a new empty array map.


Byte2IntArrayMap

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

Parameters:
capacity - the initial capacity.

Byte2IntArrayMap

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

Parameters:
m - a map.

Byte2IntArrayMap

public Byte2IntArrayMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Integer> m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Byte2IntArrayMap

public Byte2IntArrayMap(byte[] key,
                        int[] 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

byte2IntEntrySet

public Byte2IntMap.FastEntrySet byte2IntEntrySet()
Description copied from interface: Byte2IntMap
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 Byte2IntMap.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:
byte2IntEntrySet in interface Byte2IntMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Byte2IntMap.entrySet()

get

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

Specified by:
get in interface Byte2IntFunction
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.Byte,java.lang.Integer>
Specified by:
size in interface java.util.Map<java.lang.Byte,java.lang.Integer>
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.Byte,java.lang.Integer>
Specified by:
clear in interface java.util.Map<java.lang.Byte,java.lang.Integer>
Overrides:
clear in class AbstractByte2IntFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Byte2IntFunction
Overrides:
containsKey in class AbstractByte2IntMap
See Also:
Function.containsKey(Object)

containsValue

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

Specified by:
containsValue in interface Byte2IntMap
Overrides:
containsValue in class AbstractByte2IntMap
See Also:
Map.containsValue(Object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.Byte,java.lang.Integer>
Overrides:
isEmpty in class AbstractByte2IntMap

put

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

Specified by:
put in interface Byte2IntFunction
Overrides:
put in class AbstractByte2IntFunction
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 int remove(byte k)
Description copied from interface: Byte2IntFunction
Removes the mapping with the given key.

Specified by:
remove in interface Byte2IntFunction
Overrides:
remove in class AbstractByte2IntFunction
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: AbstractByte2IntMap
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractByte2IntMap.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 Byte2IntMap
Specified by:
keySet in interface java.util.Map<java.lang.Byte,java.lang.Integer>
Overrides:
keySet in class AbstractByte2IntMap
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 IntCollection values()
Description copied from class: AbstractByte2IntMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractByte2IntMap.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 Byte2IntMap
Specified by:
values in interface java.util.Map<java.lang.Byte,java.lang.Integer>
Overrides:
values in class AbstractByte2IntMap
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 Byte2IntArrayMap 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.