it.unimi.dsi.fastutil.objects
Class Reference2CharArrayMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractReference2CharFunction<K>
      it.unimi.dsi.fastutil.objects.AbstractReference2CharMap<K>
          it.unimi.dsi.fastutil.objects.Reference2CharArrayMap<K>

All Implemented Interfaces:

Function<K,Character>, Reference2CharFunction<K>, Reference2CharMap<K>, Serializable, Cloneable, Map<K,Character>

public class Reference2CharArrayMap<K>
extends AbstractReference2CharMap<K>
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.objects.AbstractReference2CharMap

AbstractReference2CharMap.BasicEntry<K>

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

Reference2CharMap.Entry<K>, Reference2CharMap.FastEntrySet<K>

Constructor Summary

Reference2CharArrayMap()
Creates a new empty array map.

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

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

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

Reference2CharArrayMap(Reference2CharMap<K> 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(Object k) Checks whether the given value is contained in AbstractReference2CharMap.keySet().
boolean	containsValue(char v) Checks whether the given value is contained in AbstractReference2CharMap.values().
char	getChar(Object k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ReferenceSet<K>	keySet() Returns a type-specific-set view of the keys of this map.
char	put(K k, char v) Adds a pair to the map.
Reference2CharMap.FastEntrySet<K>	reference2CharEntrySet() Returns a type-specific set view of the mappings contained in this map.
char	removeChar(Object 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.
CharCollection	values() Returns a type-specific-set view of the values of this map.

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

containsValue, entrySet, equals, hashCode, putAll, toString

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

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.objects.Reference2CharFunction

defaultReturnValue, defaultReturnValue

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

get, put, remove

Methods inherited from interface java.util.Map

get, put, remove

Constructor Detail

Reference2CharArrayMap

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

Reference2CharArrayMap

public Reference2CharArrayMap()

Creates a new empty array map.

Reference2CharArrayMap

public Reference2CharArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Reference2CharArrayMap

public Reference2CharArrayMap(Reference2CharMap<K> m)

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

Parameters:

m - a map.

Reference2CharArrayMap

public Reference2CharArrayMap(Object[] key,
                              char[] 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

reference2CharEntrySet

public Reference2CharMap.FastEntrySet<K> reference2CharEntrySet()

Description copied from interface: Reference2CharMap

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

Specified by:

reference2CharEntrySet in interface Reference2CharMap<K>

Returns:

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

See Also:

Reference2CharMap.entrySet()

getChar

public char getChar(Object k)

Description copied from interface: Reference2CharFunction

Returns the value to which the given key is mapped.

Specified by:

getChar in interface Reference2CharFunction<K>

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<K,Character>

Specified by:

size in interface Map<K,Character>

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<K,Character>

Specified by:

clear in interface Map<K,Character>

Overrides:

clear in class AbstractReference2CharFunction<K>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractReference2CharMap

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

Specified by:

containsKey in interface Function<K,Character>

Specified by:

containsKey in interface Map<K,Character>

Overrides:

containsKey in class AbstractReference2CharMap<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(char v)

Description copied from class: AbstractReference2CharMap

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

Specified by:

containsValue in interface Reference2CharMap<K>

Overrides:

containsValue in class AbstractReference2CharMap<K>

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Character>

Overrides:

isEmpty in class AbstractReference2CharMap<K>

put

public char put(K k,
                char v)

Description copied from interface: Reference2CharFunction

Adds a pair to the map.

Specified by:

put in interface Reference2CharFunction<K>

Overrides:

put in class AbstractReference2CharFunction<K>

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)

removeChar

public char removeChar(Object k)

Description copied from interface: Reference2CharFunction

Removes the mapping with the given key.

Specified by:

removeChar in interface Reference2CharFunction<K>

Overrides:

removeChar in class AbstractReference2CharFunction<K>

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 ReferenceSet<K> keySet()

Description copied from class: AbstractReference2CharMap

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

The view is backed by the set returned by AbstractReference2CharMap.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 Reference2CharMap<K>

Specified by:

keySet in interface Map<K,Character>

Overrides:

keySet in class AbstractReference2CharMap<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 CharCollection values()

Description copied from class: AbstractReference2CharMap

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

The view is backed by the set returned by AbstractReference2CharMap.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 Reference2CharMap<K>

Specified by:

values in interface Map<K,Character>

Overrides:

values in class AbstractReference2CharMap<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 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.