it.unimi.dsi.fastutil.chars
Class Char2LongArrayMap

java.lang.Object
  it.unimi.dsi.fastutil.chars.AbstractChar2LongFunction
      it.unimi.dsi.fastutil.chars.AbstractChar2LongMap
          it.unimi.dsi.fastutil.chars.Char2LongArrayMap

All Implemented Interfaces:

Char2LongFunction, Char2LongMap, Function<Character,Long>, Serializable, Cloneable, Map<Character,Long>

public class Char2LongArrayMap
extends AbstractChar2LongMap
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.AbstractChar2LongMap

AbstractChar2LongMap.BasicEntry

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

Char2LongMap.Entry, Char2LongMap.FastEntrySet

Constructor Summary

Char2LongArrayMap()
Creates a new empty array map.

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

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

Char2LongArrayMap(Char2LongMap m)
Creates a new empty array map copying the entries of a given map.

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

Method Summary

Char2LongMap.FastEntrySet	char2LongEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
Object	clone() Returns a deep copy of this map.
boolean	containsKey(char k) Checks whether the given value is contained in AbstractChar2LongMap.keySet().
boolean	containsValue(long v) Checks whether the given value is contained in AbstractChar2LongMap.values().
long	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.
long	put(char k, long v) Adds a pair to the map.
long	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.
LongCollection	values() Returns a type-specific-set view of the values of this map.

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

containsValue, entrySet, equals, hashCode, putAll, toString

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

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.Char2LongFunction

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

Char2LongArrayMap

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

Char2LongArrayMap

public Char2LongArrayMap()

Creates a new empty array map.

Char2LongArrayMap

public Char2LongArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Char2LongArrayMap

public Char2LongArrayMap(Char2LongMap m)

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

Parameters:

m - a map.

Char2LongArrayMap

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

char2LongEntrySet

public Char2LongMap.FastEntrySet char2LongEntrySet()

Description copied from interface: Char2LongMap

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

Specified by:

char2LongEntrySet in interface Char2LongMap

Returns:

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

See Also:

Char2LongMap.entrySet()

get

public long get(char k)

Description copied from interface: Char2LongFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2LongFunction

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,Long>

Specified by:

size in interface Map<Character,Long>

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,Long>

Specified by:

clear in interface Map<Character,Long>

Overrides:

clear in class AbstractChar2LongFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(char k)

Description copied from class: AbstractChar2LongMap

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

Specified by:

containsKey in interface Char2LongFunction

Overrides:

containsKey in class AbstractChar2LongMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(long v)

Description copied from class: AbstractChar2LongMap

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

Specified by:

containsValue in interface Char2LongMap

Overrides:

containsValue in class AbstractChar2LongMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character,Long>

Overrides:

isEmpty in class AbstractChar2LongMap

put

public long put(char k,
                long v)

Description copied from interface: Char2LongFunction

Adds a pair to the map.

Specified by:

put in interface Char2LongFunction

Overrides:

put in class AbstractChar2LongFunction

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 long remove(char k)

Description copied from interface: Char2LongFunction

Removes the mapping with the given key.

Specified by:

remove in interface Char2LongFunction

Overrides:

remove in class AbstractChar2LongFunction

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: AbstractChar2LongMap

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

The view is backed by the set returned by AbstractChar2LongMap.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 Char2LongMap

Specified by:

keySet in interface Map<Character,Long>

Overrides:

keySet in class AbstractChar2LongMap

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 LongCollection values()

Description copied from class: AbstractChar2LongMap

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

The view is backed by the set returned by AbstractChar2LongMap.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 Char2LongMap

Specified by:

values in interface Map<Character,Long>

Overrides:

values in class AbstractChar2LongMap

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.