it.unimi.dsi.fastutil.chars
Class Char2ObjectArrayMap<V>

java.lang.Object
  it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction<V>
      it.unimi.dsi.fastutil.chars.AbstractChar2ObjectMap<V>
          it.unimi.dsi.fastutil.chars.Char2ObjectArrayMap<V>

All Implemented Interfaces:

Char2ObjectFunction<V>, Char2ObjectMap<V>, Function<Character,V>, Serializable, Cloneable, Map<Character,V>

public class Char2ObjectArrayMap<V>
extends AbstractChar2ObjectMap<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.chars.AbstractChar2ObjectMap

AbstractChar2ObjectMap.BasicEntry<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ObjectMap

Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>

Constructor Summary

Char2ObjectArrayMap()
Creates a new empty array map.

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

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

Char2ObjectArrayMap(Char2ObjectMap<V> m)
Creates a new empty array map copying the entries of a given map.

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

Char2ObjectArrayMap(Map<? extends Character,? extends V> m)
Creates a new empty array map copying the entries of a given map.

Method Summary

Char2ObjectMap.FastEntrySet<V>	char2ObjectEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
Char2ObjectArrayMap<V>	clone() Returns a deep copy of this map.
boolean	containsKey(char k) Checks whether the given value is contained in AbstractChar2ObjectMap.keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in AbstractChar2ObjectMap.values().
V	get(char k) Returns the value to which the given key is mapped.
boolean	isEmpty()
CharSet	keySet() Returns a type-specific-set view of the keys of this map.
V	put(char k, V v) Adds a pair to the map.
V	remove(char 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.
ObjectCollection<V>	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ObjectMap

entrySet, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction

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.chars.Char2ObjectFunction

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

Char2ObjectArrayMap

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

Char2ObjectArrayMap

public Char2ObjectArrayMap()

Creates a new empty array map.

Char2ObjectArrayMap

public Char2ObjectArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Char2ObjectArrayMap

public Char2ObjectArrayMap(Char2ObjectMap<V> m)

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

Parameters:

m - a map.

Char2ObjectArrayMap

public Char2ObjectArrayMap(Map<? extends Character,? extends V> m)

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

Parameters:

m - a map.

Char2ObjectArrayMap

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

char2ObjectEntrySet

public Char2ObjectMap.FastEntrySet<V> char2ObjectEntrySet()

Description copied from interface: Char2ObjectMap

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

Specified by:

char2ObjectEntrySet in interface Char2ObjectMap<V>

Returns:

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

See Also:

Char2ObjectMap.entrySet()

get

public V get(char k)

Description copied from interface: Char2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2ObjectFunction<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<Character,V>

Specified by:

size in interface Map<Character,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<Character,V>

Specified by:

clear in interface Map<Character,V>

Overrides:

clear in class AbstractChar2ObjectFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(char k)

Description copied from class: AbstractChar2ObjectMap

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

Specified by:

containsKey in interface Char2ObjectFunction<V>

Overrides:

containsKey in class AbstractChar2ObjectMap<V>

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractChar2ObjectMap

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

Specified by:

containsValue in interface Map<Character,V>

Overrides:

containsValue in class AbstractChar2ObjectMap<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character,V>

Overrides:

isEmpty in class AbstractChar2ObjectMap<V>

put

public V put(char k,
             V v)

Description copied from interface: Char2ObjectFunction

Adds a pair to the map.

Specified by:

put in interface Char2ObjectFunction<V>

Overrides:

put in class AbstractChar2ObjectFunction<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(char k)

Description copied from interface: Char2ObjectFunction

Removes the mapping with the given key.

Specified by:

remove in interface Char2ObjectFunction<V>

Overrides:

remove in class AbstractChar2ObjectFunction<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 CharSet keySet()

Description copied from class: AbstractChar2ObjectMap

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

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

Specified by:

keySet in interface Map<Character,V>

Overrides:

keySet in class AbstractChar2ObjectMap<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 ObjectCollection<V> values()

Description copied from class: AbstractChar2ObjectMap

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

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

Specified by:

values in interface Map<Character,V>

Overrides:

values in class AbstractChar2ObjectMap<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 Char2ObjectArrayMap<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 Object

Returns:

a deep copy of this map.