it.unimi.dsi.fastutil.ints
Class Int2ReferenceArrayMap<V>

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction<V>
      it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap<V>
          it.unimi.dsi.fastutil.ints.Int2ReferenceArrayMap<V>

All Implemented Interfaces:

Function<Integer,V>, Int2ReferenceFunction<V>, Int2ReferenceMap<V>, Serializable, Cloneable, Map<Integer,V>

public class Int2ReferenceArrayMap<V>
extends AbstractInt2ReferenceMap<V>
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.ints.AbstractInt2ReferenceMap

AbstractInt2ReferenceMap.BasicEntry<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceMap

Int2ReferenceMap.Entry<V>, Int2ReferenceMap.FastEntrySet<V>

Constructor Summary

Int2ReferenceArrayMap()
Creates a new empty array map.

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

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

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

Int2ReferenceArrayMap(Int2ReferenceMap<V> 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(int k) Checks whether the given value is contained in AbstractInt2ReferenceMap.keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in AbstractInt2ReferenceMap.values().
V	get(int k) Returns the value to which the given key is mapped.
Int2ReferenceMap.FastEntrySet<V>	int2ReferenceEntrySet() Returns a type-specific set view of the mappings contained in this map.
boolean	isEmpty()
IntSet	keySet() Returns a type-specific-set view of the keys of this map.
V	put(int k, V v) Adds a pair to the map.
V	remove(int 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.
ReferenceCollection<V>	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap

entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction

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.ints.Int2ReferenceFunction

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

Int2ReferenceArrayMap

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

Int2ReferenceArrayMap

public Int2ReferenceArrayMap()

Creates a new empty array map.

Int2ReferenceArrayMap

public Int2ReferenceArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Int2ReferenceArrayMap

public Int2ReferenceArrayMap(Int2ReferenceMap<V> m)

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

Parameters:

m - a map.

Int2ReferenceArrayMap

public Int2ReferenceArrayMap(int[] key,
                             Object[] 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

int2ReferenceEntrySet

public Int2ReferenceMap.FastEntrySet<V> int2ReferenceEntrySet()

Description copied from interface: Int2ReferenceMap

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

Specified by:

int2ReferenceEntrySet in interface Int2ReferenceMap<V>

Returns:

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

See Also:

Int2ReferenceMap.entrySet()

get

public V get(int k)

Description copied from interface: Int2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2ReferenceFunction<V>

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<Integer,V>

Specified by:

size in interface Map<Integer,V>

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<Integer,V>

Specified by:

clear in interface Map<Integer,V>

Overrides:

clear in class AbstractInt2ReferenceFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2ReferenceMap

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

Specified by:

containsKey in interface Int2ReferenceFunction<V>

Overrides:

containsKey in class AbstractInt2ReferenceMap<V>

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractInt2ReferenceMap

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

Specified by:

containsValue in interface Map<Integer,V>

Overrides:

containsValue in class AbstractInt2ReferenceMap<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Integer,V>

Overrides:

isEmpty in class AbstractInt2ReferenceMap<V>

put

public V put(int k,
             V v)

Description copied from interface: Int2ReferenceFunction

Adds a pair to the map.

Specified by:

put in interface Int2ReferenceFunction<V>

Overrides:

put in class AbstractInt2ReferenceFunction<V>

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 V remove(int k)

Description copied from interface: Int2ReferenceFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2ReferenceFunction<V>

Overrides:

remove in class AbstractInt2ReferenceFunction<V>

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 IntSet keySet()

Description copied from class: AbstractInt2ReferenceMap

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

The view is backed by the set returned by AbstractInt2ReferenceMap.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 Int2ReferenceMap<V>

Specified by:

keySet in interface Map<Integer,V>

Overrides:

keySet in class AbstractInt2ReferenceMap<V>

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 ReferenceCollection<V> values()

Description copied from class: AbstractInt2ReferenceMap

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

The view is backed by the set returned by AbstractInt2ReferenceMap.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 Int2ReferenceMap<V>

Specified by:

values in interface Map<Integer,V>

Overrides:

values in class AbstractInt2ReferenceMap<V>

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.