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:

it.unimi.dsi.fastutil.chars.Char2ObjectFunction<V>, Char2ObjectMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Character,V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Character,V>

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

AbstractChar2ObjectMap.BasicEntry<V>, AbstractChar2ObjectMap.BasicEntrySet<V>

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Char2ObjectMap.FastEntrySet<V>	entries Cached set of entries.
protected char[]	key The keys (valid up to size, excluded).
protected it.unimi.dsi.fastutil.chars.CharSet	keys Cached set of keys.
protected int	size The number of valid entries in key and value.
protected java.lang.Object[]	value The values (parallel to key).
protected it.unimi.dsi.fastutil.objects.ObjectCollection<V>	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

Constructor and Description
Char2ObjectArrayMap() Creates a new empty array map.
Char2ObjectArrayMap(char[] key, java.lang.Object[] value) Creates a new empty array map with given key and value backing arrays.
Char2ObjectArrayMap(char[] 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.
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(java.util.Map<? extends java.lang.Character,? extends V> m) Creates a new empty array map copying the entries of a given map.

Method Summary

Modifier and Type	Method and Description
Char2ObjectMap.FastEntrySet<V>	char2ObjectEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	clear() Removes all of the mappings from this map (optional operation).
Char2ObjectArrayMap<V>	clone() Returns a deep copy of this map.
boolean	containsKey(char k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(java.lang.Object v)
V	get(char k)
boolean	isEmpty()
it.unimi.dsi.fastutil.chars.CharSet	keySet() Returns a type-specific-set view of the keys of this map.
V	put(char k, V v)
V	remove(char k)
int	size() Returns the number of key/value mappings in this map.
it.unimi.dsi.fastutil.objects.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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ObjectMap

compute, computeIfAbsent, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, containsKey, defaultReturnValue, defaultReturnValue, entrySet, forEach, get, getOrDefault, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replace

Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ObjectFunction

andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

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

apply

Methods inherited from interface java.util.function.Function

andThen, identity

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

key

protected transient char[] key

The keys (valid up to size, excluded).

value

protected transient java.lang.Object[] value

The values (parallel to key).

size

protected int size

The number of valid entries in key and value.

entries

protected transient Char2ObjectMap.FastEntrySet<V> entries

Cached set of entries.

keys

protected transient it.unimi.dsi.fastutil.chars.CharSet keys

Cached set of keys.

values

protected transient it.unimi.dsi.fastutil.objects.ObjectCollection<V> values

Cached collection of values.

Constructor Detail

Char2ObjectArrayMap

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

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(java.util.Map<? extends java.lang.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,
                           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

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 Map.entrySet() so that it returns an ObjectSet of type-specific entries (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:

Map.entrySet()

get

public V get(char k)

Specified by:

get in interface it.unimi.dsi.fastutil.chars.Char2ObjectFunction<V>

size

public int size()

Description copied from interface: Char2ObjectMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Char2ObjectMap<V>

Specified by:

size in interface java.util.Map<java.lang.Character,V>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

clear

public void clear()

Description copied from interface: Char2ObjectMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Char2ObjectMap<V>

Specified by:

clear in interface java.util.Map<java.lang.Character,V>

containsKey

public boolean containsKey(char k)

Description copied from class: AbstractChar2ObjectMap

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface it.unimi.dsi.fastutil.chars.Char2ObjectFunction<V>

Specified by:

containsKey in interface Char2ObjectMap<V>

Overrides:

containsKey in class AbstractChar2ObjectMap<V>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object v)

Description copied from class: AbstractChar2ObjectMap

Specified by:

containsValue in interface java.util.Map<java.lang.Character,V>

Overrides:

containsValue in class AbstractChar2ObjectMap<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Character,V>

Overrides:

isEmpty in class AbstractChar2ObjectMap<V>

put

public V put(char k,
             V v)

Specified by:

put in interface it.unimi.dsi.fastutil.chars.Char2ObjectFunction<V>

remove

public V remove(char k)

Specified by:

remove in interface it.unimi.dsi.fastutil.chars.Char2ObjectFunction<V>

keySet

public it.unimi.dsi.fastutil.chars.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 Map.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 java.util.Map<java.lang.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 it.unimi.dsi.fastutil.objects.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 Map.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 java.util.Map<java.lang.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 java.lang.Object

Returns:

a deep copy of this map.