it.unimi.dsi.fastutil.ints

Class Int2BooleanArrayMap

java.lang.Object

it.unimi.dsi.fastutil.ints.AbstractInt2BooleanFunction

it.unimi.dsi.fastutil.ints.AbstractInt2BooleanMap

it.unimi.dsi.fastutil.ints.Int2BooleanArrayMap

All Implemented Interfaces:

Function<java.lang.Integer,java.lang.Boolean>, Int2BooleanFunction, Int2BooleanMap, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Integer,java.lang.Boolean>

public class Int2BooleanArrayMap
extends AbstractInt2BooleanMap
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.AbstractInt2BooleanMap

AbstractInt2BooleanMap.BasicEntry

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

Int2BooleanMap.Entry, Int2BooleanMap.FastEntrySet

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2BooleanFunction

defRetValue

Constructor Summary

Constructors

Constructor and Description
Int2BooleanArrayMap() Creates a new empty array map.
Int2BooleanArrayMap(int capacity) Creates a new empty array map of given capacity.
Int2BooleanArrayMap(int[] key, boolean[] value) Creates a new empty array map with given key and value backing arrays.
Int2BooleanArrayMap(int[] key, boolean[] value, int size) Creates a new array map with given key and value backing arrays, using the given number of elements.
Int2BooleanArrayMap(Int2BooleanMap m) Creates a new empty array map copying the entries of a given map.
Int2BooleanArrayMap(java.util.Map<? extends java.lang.Integer,? 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
void	clear() Removes all associations from this function (optional operation).
Int2BooleanArrayMap	clone() Returns a deep copy of this map.
boolean	containsKey(int k) Checks whether the given value is contained in AbstractInt2BooleanMap.keySet().
boolean	containsValue(boolean v) Checks whether the given value is contained in AbstractInt2BooleanMap.values().
boolean	get(int k) Returns the value to which the given key is mapped.
Int2BooleanMap.FastEntrySet	int2BooleanEntrySet() 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.
boolean	put(int k, boolean v) Adds a pair to the map.
boolean	remove(int 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.
BooleanCollection	values() Returns a type-specific-set view of the values of this map.

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

containsValue, entrySet, equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get, put, remove

Methods inherited from class java.lang.Object

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

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

defaultReturnValue, defaultReturnValue

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

containsKey, get, put, remove

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, forEach, get, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll

Constructor Detail

Int2BooleanArrayMap

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

Int2BooleanArrayMap

public Int2BooleanArrayMap()

Creates a new empty array map.

Int2BooleanArrayMap

public Int2BooleanArrayMap(int capacity)

Creates a new empty array map of given capacity.

Parameters:

capacity - the initial capacity.

Int2BooleanArrayMap

public Int2BooleanArrayMap(Int2BooleanMap m)

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

Parameters:

m - a map.

Int2BooleanArrayMap

public Int2BooleanArrayMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Boolean> m)

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

Parameters:

m - a map.

Int2BooleanArrayMap

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

int2BooleanEntrySet

public Int2BooleanMap.FastEntrySet int2BooleanEntrySet()

Description copied from interface: Int2BooleanMap

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 Int2BooleanMap.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:

int2BooleanEntrySet in interface Int2BooleanMap

Returns:

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

See Also:

Int2BooleanMap.entrySet()

get

public boolean get(int k)

Description copied from interface: Int2BooleanFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2BooleanFunction

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

Specified by:

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

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

Specified by:

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

Overrides:

clear in class AbstractInt2BooleanFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2BooleanMap

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

Specified by:

containsKey in interface Int2BooleanFunction

Overrides:

containsKey in class AbstractInt2BooleanMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(boolean v)

Description copied from class: AbstractInt2BooleanMap

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

Specified by:

containsValue in interface Int2BooleanMap

Overrides:

containsValue in class AbstractInt2BooleanMap

See Also:

Map.containsValue(Object)

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractInt2BooleanMap

put

public boolean put(int k,
                   boolean v)

Description copied from interface: Int2BooleanFunction

Adds a pair to the map.

Specified by:

put in interface Int2BooleanFunction

Overrides:

put in class AbstractInt2BooleanFunction

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

Description copied from interface: Int2BooleanFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2BooleanFunction

Overrides:

remove in class AbstractInt2BooleanFunction

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

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

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

Specified by:

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

Overrides:

keySet in class AbstractInt2BooleanMap

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

Description copied from class: AbstractInt2BooleanMap

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

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

Specified by:

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

Overrides:

values in class AbstractInt2BooleanMap

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