Package it.unimi.dsi.fastutil.ints

Class Int2CharArrayMap

java.lang.Object

it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction

it.unimi.dsi.fastutil.ints.AbstractInt2CharMap

it.unimi.dsi.fastutil.ints.Int2CharArrayMap

All Implemented Interfaces:

Function<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Integer,java.lang.Character>, java.util.function.IntUnaryOperator, java.util.Map<java.lang.Integer,java.lang.Character>

public class Int2CharArrayMap
extends AbstractInt2CharMap
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.ints.AbstractInt2CharMap

AbstractInt2CharMap.BasicEntry, AbstractInt2CharMap.BasicEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2CharMap

Int2CharMap.Entry, Int2CharMap.FastEntrySet

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all of the mappings from this map (optional operation).
Int2CharArrayMap	clone()	Returns a deep copy of this map.
boolean	containsKey(int 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(int k)	Returns the value to which the given key is mapped.
Int2CharMap.FastEntrySet	int2CharEntrySet()	Returns a type-specific set view of the mappings contained in this map.
boolean	isEmpty()
IntSet	keySet()	Returns a type-specific-set view of the keys of this map.
char	put(int k, char v)	Adds a pair to the map (optional operation).
char	remove(int k)	Removes the mapping with the given key (optional operation).
int	size()	Returns the number of key/value mappings in this map.
CharCollection	values()	Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2CharMap

equals, hashCode, putAll, toString

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2CharFunction

applyAsInt

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2CharMap

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

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose

Methods inherited from interface java.util.Map

forEach, replaceAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Int2CharArrayMap

public Int2CharArrayMap(int[] 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).

Int2CharArrayMap

public Int2CharArrayMap()

Creates a new empty array map.

Int2CharArrayMap

public Int2CharArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Int2CharArrayMap

public Int2CharArrayMap(Int2CharMap m)

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

Parameters:

m - a map.

Int2CharArrayMap

public Int2CharArrayMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> m)

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

Parameters:

m - a map.

Int2CharArrayMap

public Int2CharArrayMap(int[] 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

int2CharEntrySet

public Int2CharMap.FastEntrySet int2CharEntrySet()

Description copied from interface: Int2CharMap

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:

int2CharEntrySet in interface Int2CharMap

Returns:

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

See Also:

Map.entrySet()

get

public char get(int k)

Description copied from interface: Int2CharFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2CharFunction

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

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 Function<java.lang.Integer,java.lang.Character>

Specified by:

size in interface Int2CharMap

Specified by:

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

Returns:

the number of key-value mappings in this map.

See Also:

Size64

clear

public void clear()

Description copied from interface: Int2CharMap

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

Specified by:

clear in interface Function<java.lang.Integer,java.lang.Character>

Specified by:

clear in interface Int2CharMap

Specified by:

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

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from interface: Int2CharMap

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

Specified by:

containsKey in interface Int2CharFunction

Specified by:

containsKey in interface Int2CharMap

Overrides:

containsKey in class AbstractInt2CharMap

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 interface: Int2CharMap

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

Specified by:

containsValue in interface Int2CharMap

Overrides:

containsValue in class AbstractInt2CharMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractInt2CharMap

put

public char put(int k,
                char v)

Description copied from interface: Int2CharFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Int2CharFunction

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

Description copied from interface: Int2CharFunction

Removes the mapping with the given key (optional operation).

Specified by:

remove in interface Int2CharFunction

Parameters:

k - the key.

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 IntSet keySet()

Description copied from class: AbstractInt2CharMap

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 Int2CharMap

Specified by:

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

Overrides:

keySet in class AbstractInt2CharMap

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

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 Int2CharMap

Specified by:

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

Overrides:

values in class AbstractInt2CharMap

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

Returns:

a deep copy of this map.