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:

it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>, Object2ByteMap<K>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<K,java.lang.Byte>, java.util.function.ToIntFunction<K>, java.util.Map<K,java.lang.Byte>

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

AbstractObject2ByteMap.BasicEntry<K>, AbstractObject2ByteMap.BasicEntrySet<K>

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Object2ByteMap.FastEntrySet<K>	entries Cached set of entries.
protected java.lang.Object[]	key The keys (valid up to size, excluded).
protected it.unimi.dsi.fastutil.objects.ObjectSet<K>	keys Cached set of keys.
protected int	size The number of valid entries in key and value.
protected byte[]	value The values (parallel to key).
protected it.unimi.dsi.fastutil.bytes.ByteCollection	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

Constructor and Description
Object2ByteArrayMap() Creates a new empty array map.
Object2ByteArrayMap(int capacity) Creates a new empty array map of given capacity.
Object2ByteArrayMap(java.util.Map<? extends K,? extends java.lang.Byte> m) Creates a new empty array map copying the entries of a given map.
Object2ByteArrayMap(java.lang.Object[] key, byte[] value) Creates a new empty array map with given key and value backing arrays.
Object2ByteArrayMap(java.lang.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

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
Object2ByteArrayMap<K>	clone() Returns a deep copy of this map.
boolean	containsKey(java.lang.Object k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(byte v) Returns true if this map maps one or more keys to the specified value.
byte	getByte(java.lang.Object k)
boolean	isEmpty()
it.unimi.dsi.fastutil.objects.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)
byte	removeByte(java.lang.Object k)
int	size() Returns the number of key/value mappings in this map.
it.unimi.dsi.fastutil.bytes.ByteCollection	values() Returns a type-specific-set view of the values of this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ByteMap

computeByte, computeByteIfAbsent, computeByteIfAbsentPartial, computeByteIfPresent, computeIfAbsent, computeIfAbsent, containsValue, defaultReturnValue, defaultReturnValue, entrySet, forEach, get, getOrDefault, getOrDefault, merge, merge, mergeByte, mergeByte, mergeByte, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ByteFunction

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.Function

compose, identity

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, replaceAll

Field Detail

key

protected transient java.lang.Object[] key

The keys (valid up to size, excluded).

value

protected transient byte[] value

The values (parallel to key).

size

protected int size

The number of valid entries in key and value.

entries

protected transient Object2ByteMap.FastEntrySet<K> entries

Cached set of entries.

keys

protected transient it.unimi.dsi.fastutil.objects.ObjectSet<K> keys

Cached set of keys.

values

protected transient it.unimi.dsi.fastutil.bytes.ByteCollection values

Cached collection of values.

Constructor Detail

Object2ByteArrayMap

public Object2ByteArrayMap(java.lang.Object[] 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).

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(java.util.Map<? extends K,? extends java.lang.Byte> m)

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

Parameters:

m - a map.

Object2ByteArrayMap

public Object2ByteArrayMap(java.lang.Object[] 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

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 Map.entrySet() so that it returns an ObjectSet of type-specific entries (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:

Map.entrySet()

getByte

public byte getByte(java.lang.Object k)

Specified by:

getByte in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>

size

public int size()

Description copied from interface: Object2ByteMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Object2ByteMap<K>

Specified by:

size in interface java.util.Map<K,java.lang.Byte>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

clear

public void clear()

Description copied from interface: Object2ByteMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Object2ByteMap<K>

Specified by:

clear in interface java.util.Map<K,java.lang.Byte>

containsKey

public boolean containsKey(java.lang.Object k)

Description copied from class: AbstractObject2ByteMap

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface Object2ByteMap<K>

Specified by:

containsKey in interface java.util.Map<K,java.lang.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

Returns true if this map maps one or more keys to the specified value.

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 java.util.Map<K,java.lang.Byte>

Overrides:

isEmpty in class AbstractObject2ByteMap<K>

put

public byte put(K k,
                byte v)

Specified by:

put in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>

removeByte

public byte removeByte(java.lang.Object k)

Specified by:

removeByte in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>

keySet

public it.unimi.dsi.fastutil.objects.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 Map.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 java.util.Map<K,java.lang.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 it.unimi.dsi.fastutil.bytes.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 Map.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 java.util.Map<K,java.lang.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 Object2ByteArrayMap<K> 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.