it.unimi.dsi.fastutil.bytes
Class Byte2BooleanArrayMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.bytes.AbstractByte2BooleanFunction
      extended by it.unimi.dsi.fastutil.bytes.AbstractByte2BooleanMap
          extended by it.unimi.dsi.fastutil.bytes.Byte2BooleanArrayMap
All Implemented Interfaces:
Byte2BooleanFunction, Byte2BooleanMap, Function<Byte,Boolean>, Serializable, Cloneable, Map<Byte,Boolean>

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

Byte2BooleanArrayMap

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

Byte2BooleanArrayMap

public Byte2BooleanArrayMap()
Creates a new empty array map.


Byte2BooleanArrayMap

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

Parameters:
capacity - the initial capacity.

Byte2BooleanArrayMap

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

Parameters:
m - a map.

Byte2BooleanArrayMap

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

Parameters:
m - a map.

Byte2BooleanArrayMap

public Byte2BooleanArrayMap(byte[] key,
                            boolean[] 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

byte2BooleanEntrySet

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

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

get

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

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

containsKey

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

Specified by:
containsKey in interface Byte2BooleanFunction
Overrides:
containsKey in class AbstractByte2BooleanMap
See Also:
Function.containsKey(Object)

containsValue

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

Specified by:
containsValue in interface Byte2BooleanMap
Overrides:
containsValue in class AbstractByte2BooleanMap
See Also:
Map.containsValue(Object)

isEmpty

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

put

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

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

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

The view is backed by the set returned by AbstractByte2BooleanMap.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 Byte2BooleanMap
Specified by:
keySet in interface Map<Byte,Boolean>
Overrides:
keySet in class AbstractByte2BooleanMap
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 BooleanCollection values()
Description copied from class: AbstractByte2BooleanMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractByte2BooleanMap.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 Byte2BooleanMap
Specified by:
values in interface Map<Byte,Boolean>
Overrides:
values in class AbstractByte2BooleanMap
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 Byte2BooleanArrayMap 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.