it.unimi.dsi.fastutil.chars

Class Char2BooleanArrayMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2BooleanFunction

it.unimi.dsi.fastutil.chars.AbstractChar2BooleanMap

it.unimi.dsi.fastutil.chars.Char2BooleanArrayMap

All Implemented Interfaces:

it.unimi.dsi.fastutil.chars.Char2BooleanFunction, Char2BooleanMap, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Character,java.lang.Boolean>, java.util.function.IntPredicate, java.util.Map<java.lang.Character,java.lang.Boolean>

public class Char2BooleanArrayMap
extends AbstractChar2BooleanMap
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.AbstractChar2BooleanMap

AbstractChar2BooleanMap.BasicEntry, AbstractChar2BooleanMap.BasicEntrySet

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

Char2BooleanMap.Entry, Char2BooleanMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected Char2BooleanMap.FastEntrySet	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 boolean[]	value The values (parallel to key).
protected it.unimi.dsi.fastutil.booleans.BooleanCollection	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Char2BooleanMap.FastEntrySet	char2BooleanEntrySet() 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).
Char2BooleanArrayMap	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(boolean v) Returns true if this map maps one or more keys to the specified value.
boolean	get(char k)
boolean	isEmpty()
it.unimi.dsi.fastutil.chars.CharSet	keySet() Returns a type-specific-set view of the keys of this map.
boolean	put(char k, boolean v)
boolean	remove(char k)
int	size() Returns the number of key/value mappings in this map.
it.unimi.dsi.fastutil.booleans.BooleanCollection	values() Returns a type-specific-set view of the values of this map.

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

equals, hashCode, putAll, toString

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

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

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

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

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

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

and, negate, or

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 boolean[] value

The values (parallel to key).

size

protected int size

The number of valid entries in key and value.

entries

protected transient Char2BooleanMap.FastEntrySet 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.booleans.BooleanCollection values

Cached collection of values.

Constructor Detail

Char2BooleanArrayMap

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

Char2BooleanArrayMap

public Char2BooleanArrayMap()

Creates a new empty array map.

Char2BooleanArrayMap

public Char2BooleanArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Char2BooleanArrayMap

public Char2BooleanArrayMap(Char2BooleanMap m)

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

Parameters:

m - a map.

Char2BooleanArrayMap

public Char2BooleanArrayMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Boolean> m)

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

Parameters:

m - a map.

Char2BooleanArrayMap

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

char2BooleanEntrySet

public Char2BooleanMap.FastEntrySet char2BooleanEntrySet()

Description copied from interface: Char2BooleanMap

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:

char2BooleanEntrySet in interface Char2BooleanMap

Returns:

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

See Also:

Map.entrySet()

get

public boolean get(char k)

Specified by:

get in interface it.unimi.dsi.fastutil.chars.Char2BooleanFunction

size

public int size()

Description copied from interface: Char2BooleanMap

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 Char2BooleanMap

Specified by:

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

Returns:

the number of key-value mappings in this map.

See Also:

Size64

clear

public void clear()

Description copied from interface: Char2BooleanMap

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

Specified by:

clear in interface Char2BooleanMap

Specified by:

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

containsKey

public boolean containsKey(char k)

Description copied from class: AbstractChar2BooleanMap

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

Specified by:

containsKey in interface it.unimi.dsi.fastutil.chars.Char2BooleanFunction

Specified by:

containsKey in interface Char2BooleanMap

Overrides:

containsKey in class AbstractChar2BooleanMap

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(boolean v)

Description copied from class: AbstractChar2BooleanMap

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

Specified by:

containsValue in interface Char2BooleanMap

Overrides:

containsValue in class AbstractChar2BooleanMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractChar2BooleanMap

put

public boolean put(char k,
                   boolean v)

Specified by:

put in interface it.unimi.dsi.fastutil.chars.Char2BooleanFunction

remove

public boolean remove(char k)

Specified by:

remove in interface it.unimi.dsi.fastutil.chars.Char2BooleanFunction

keySet

public it.unimi.dsi.fastutil.chars.CharSet keySet()

Description copied from class: AbstractChar2BooleanMap

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 Char2BooleanMap

Specified by:

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

Overrides:

keySet in class AbstractChar2BooleanMap

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.booleans.BooleanCollection values()

Description copied from class: AbstractChar2BooleanMap

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 Char2BooleanMap

Specified by:

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

Overrides:

values in class AbstractChar2BooleanMap

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