it.unimi.dsi.fastutil.longs
Class Long2ReferenceArrayMap<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceFunction<V>
      extended by it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceMap<V>
          extended by it.unimi.dsi.fastutil.longs.Long2ReferenceArrayMap<V>
All Implemented Interfaces:
Function<java.lang.Long,V>, Long2ReferenceFunction<V>, Long2ReferenceMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Long,V>

public class Long2ReferenceArrayMap<V>
extends AbstractLong2ReferenceMap<V>
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.longs.AbstractLong2ReferenceMap
AbstractLong2ReferenceMap.BasicEntry<V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2ReferenceMap
Long2ReferenceMap.Entry<V>, Long2ReferenceMap.FastEntrySet<V>
 
Constructor Summary
Long2ReferenceArrayMap()
          Creates a new empty array map.
Long2ReferenceArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Long2ReferenceArrayMap(long[] key, java.lang.Object[] value)
          Creates a new empty array map with given key and value backing arrays.
Long2ReferenceArrayMap(long[] key, java.lang.Object[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Long2ReferenceArrayMap(Long2ReferenceMap<V> m)
          Creates a new empty array map copying the entries of a given map.
Long2ReferenceArrayMap(java.util.Map<? extends java.lang.Long,? extends 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).
 Long2ReferenceArrayMap<V> clone()
          Returns a deep copy of this map.
 boolean containsKey(long k)
          Checks whether the given value is contained in AbstractLong2ReferenceMap.keySet().
 boolean containsValue(java.lang.Object v)
          Checks whether the given value is contained in AbstractLong2ReferenceMap.values().
 V 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.
 Long2ReferenceMap.FastEntrySet<V> long2ReferenceEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 V put(long k, V v)
          Adds a pair to the map.
 V 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.
 ReferenceCollection<V> values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceMap
entrySet, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceFunction
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.Long2ReferenceFunction
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

Long2ReferenceArrayMap

public Long2ReferenceArrayMap(long[] key,
                              java.lang.Object[] 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).

Long2ReferenceArrayMap

public Long2ReferenceArrayMap()
Creates a new empty array map.


Long2ReferenceArrayMap

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

Parameters:
capacity - the initial capacity.

Long2ReferenceArrayMap

public Long2ReferenceArrayMap(Long2ReferenceMap<V> m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Long2ReferenceArrayMap

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

Parameters:
m - a map.

Long2ReferenceArrayMap

public Long2ReferenceArrayMap(long[] key,
                              java.lang.Object[] 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

long2ReferenceEntrySet

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

get

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

Specified by:
get in interface Long2ReferenceFunction<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<java.lang.Long,V>
Specified by:
size in interface java.util.Map<java.lang.Long,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<java.lang.Long,V>
Specified by:
clear in interface java.util.Map<java.lang.Long,V>
Overrides:
clear in class AbstractLong2ReferenceFunction<V>
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Long2ReferenceFunction<V>
Overrides:
containsKey in class AbstractLong2ReferenceMap<V>
See Also:
Function.containsKey(Object)

containsValue

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

Specified by:
containsValue in interface java.util.Map<java.lang.Long,V>
Overrides:
containsValue in class AbstractLong2ReferenceMap<V>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.Long,V>
Overrides:
isEmpty in class AbstractLong2ReferenceMap<V>

put

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

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

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

The view is backed by the set returned by AbstractLong2ReferenceMap.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 Long2ReferenceMap<V>
Specified by:
keySet in interface java.util.Map<java.lang.Long,V>
Overrides:
keySet in class AbstractLong2ReferenceMap<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: AbstractLong2ReferenceMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractLong2ReferenceMap.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 Long2ReferenceMap<V>
Specified by:
values in interface java.util.Map<java.lang.Long,V>
Overrides:
values in class AbstractLong2ReferenceMap<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 Long2ReferenceArrayMap<V> 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.