it.unimi.dsi.fastutil.shorts

Class Short2CharArrayMap

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction

it.unimi.dsi.fastutil.shorts.AbstractShort2CharMap

it.unimi.dsi.fastutil.shorts.Short2CharArrayMap

All Implemented Interfaces:

it.unimi.dsi.fastutil.shorts.Short2CharFunction, Short2CharMap, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Short,java.lang.Character>, java.util.function.IntUnaryOperator, java.util.Map<java.lang.Short,java.lang.Character>

public class Short2CharArrayMap
extends AbstractShort2CharMap
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.shorts.AbstractShort2CharMap

AbstractShort2CharMap.BasicEntry, AbstractShort2CharMap.BasicEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharMap

Short2CharMap.Entry, Short2CharMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected Short2CharMap.FastEntrySet	entries Cached set of entries.
protected short[]	key The keys (valid up to size, excluded).
protected it.unimi.dsi.fastutil.shorts.ShortSet	keys Cached set of keys.
protected int	size The number of valid entries in key and value.
protected char[]	value The values (parallel to key).
protected it.unimi.dsi.fastutil.chars.CharCollection	values Cached collection of values.

Fields inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction

defRetValue

Constructor Summary

Constructors

Constructor and Description
Short2CharArrayMap() Creates a new empty array map.
Short2CharArrayMap(int capacity) Creates a new empty array map of given capacity.
Short2CharArrayMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> m) Creates a new empty array map copying the entries of a given map.
Short2CharArrayMap(short[] key, char[] value) Creates a new empty array map with given key and value backing arrays.
Short2CharArrayMap(short[] key, char[] value, int size) Creates a new array map with given key and value backing arrays, using the given number of elements.
Short2CharArrayMap(Short2CharMap m) Creates a new empty array map copying the entries of a given map.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
Short2CharArrayMap	clone() Returns a deep copy of this map.
boolean	containsKey(short k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(char v) Returns true if this map maps one or more keys to the specified value.
char	get(short k)
boolean	isEmpty()
it.unimi.dsi.fastutil.shorts.ShortSet	keySet() Returns a type-specific-set view of the keys of this map.
char	put(short k, char v)
char	remove(short k)
Short2CharMap.FastEntrySet	short2CharEntrySet() Returns a type-specific set view of the mappings contained in this map.
int	size() Returns the number of key/value mappings in this map.
it.unimi.dsi.fastutil.chars.CharCollection	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharMap

equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharMap

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

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharFunction

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, 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

identity

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.Map

replaceAll

Field Detail

key

protected transient short[] key

The keys (valid up to size, excluded).

value

protected transient char[] value

The values (parallel to key).

size

protected int size

The number of valid entries in key and value.

entries

protected transient Short2CharMap.FastEntrySet entries

Cached set of entries.

keys

protected transient it.unimi.dsi.fastutil.shorts.ShortSet keys

Cached set of keys.

values

protected transient it.unimi.dsi.fastutil.chars.CharCollection values

Cached collection of values.

Constructor Detail

Short2CharArrayMap

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

Short2CharArrayMap

public Short2CharArrayMap()

Creates a new empty array map.

Short2CharArrayMap

public Short2CharArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Short2CharArrayMap

public Short2CharArrayMap(Short2CharMap m)

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

Parameters:

m - a map.

Short2CharArrayMap

public Short2CharArrayMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> m)

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

Parameters:

m - a map.

Short2CharArrayMap

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

short2CharEntrySet

public Short2CharMap.FastEntrySet short2CharEntrySet()

Description copied from interface: Short2CharMap

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:

short2CharEntrySet in interface Short2CharMap

Returns:

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

See Also:

Map.entrySet()

get

public char get(short k)

Specified by:

get in interface it.unimi.dsi.fastutil.shorts.Short2CharFunction

size

public int size()

Description copied from interface: Short2CharMap

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 Short2CharMap

Specified by:

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

Returns:

the number of key-value mappings in this map.

See Also:

Size64

clear

public void clear()

Description copied from interface: Short2CharMap

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

Specified by:

clear in interface Short2CharMap

Specified by:

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

containsKey

public boolean containsKey(short k)

Description copied from class: AbstractShort2CharMap

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

Specified by:

containsKey in interface it.unimi.dsi.fastutil.shorts.Short2CharFunction

Specified by:

containsKey in interface Short2CharMap

Overrides:

containsKey in class AbstractShort2CharMap

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

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Short2CharMap

Overrides:

containsValue in class AbstractShort2CharMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractShort2CharMap

put

public char put(short k,
                char v)

Specified by:

put in interface it.unimi.dsi.fastutil.shorts.Short2CharFunction

remove

public char remove(short k)

Specified by:

remove in interface it.unimi.dsi.fastutil.shorts.Short2CharFunction

keySet

public it.unimi.dsi.fastutil.shorts.ShortSet keySet()

Description copied from class: AbstractShort2CharMap

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 Short2CharMap

Specified by:

keySet in interface java.util.Map<java.lang.Short,java.lang.Character>

Overrides:

keySet in class AbstractShort2CharMap

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.chars.CharCollection values()

Description copied from class: AbstractShort2CharMap

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 Short2CharMap

Specified by:

values in interface java.util.Map<java.lang.Short,java.lang.Character>

Overrides:

values in class AbstractShort2CharMap

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