speiger.src.collections.shorts.maps.impl.hash

Class Short2IntOpenHashMap

java.lang.Object

java.util.AbstractMap<java.lang.Short,java.lang.Integer>

speiger.src.collections.shorts.maps.abstracts.AbstractShort2IntMap

speiger.src.collections.shorts.maps.impl.hash.Short2IntOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Integer>, Short2IntFunction, Short2IntMap

Direct Known Subclasses:

Short2IntLinkedOpenHashMap

public class Short2IntOpenHashMap
extends AbstractShort2IntMap

A Type Specific Custom implementation of the HashMap Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys and values. Extra to that there is a couple quality of life functions provided

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2IntMap

AbstractShort2IntMap.BasicEntry

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2IntMap

Short2IntMap.Entry, Short2IntMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Short2IntOpenHashMap() Default Constructor
Short2IntOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Short2IntOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Short2IntOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Integer> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2IntOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Integer> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2IntOpenHashMap(short[] keys, int[] values) Helper constructor that allow to create a map from unboxed values
Short2IntOpenHashMap(short[] keys, int[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Short2IntOpenHashMap(java.lang.Short[] keys, java.lang.Integer[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2IntOpenHashMap(java.lang.Short[] keys, java.lang.Integer[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2IntOpenHashMap(Short2IntMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Short2IntOpenHashMap(Short2IntMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.

Method Summary

Modifier and Type	Method and Description
int	addTo(short key, int value) A Helper method to add a primitives together.
void	clear()
int	computeInt(short key, ShortIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(short key, Short2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(short key, ShortIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsKey(short key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
void	forEach(ShortIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Integer	get(java.lang.Object key)
int	getInt(short key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(short key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllInt(Short2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(short key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
int	put(short key, int value) Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(short key, int value) Type Specific method to reduce boxing/unboxing of values
java.lang.Integer	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
boolean	remove(short key, int value) Type Specific remove function to reduce boxing/unboxing
int	remShort(short key) Type Specific remove function to reduce boxing/unboxing
int	remShortOrDefault(short key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
int	replace(short key, int value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, int oldValue, int newValue) A Type Specific replace method to replace an existing value
ObjectSet<Short2IntMap.Entry>	short2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	size()
IntCollection	values()

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2IntMap

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceInts, replaceInts, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

isEmpty, put, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2IntMap

compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map

isEmpty

Constructor Detail

Short2IntOpenHashMap

public Short2IntOpenHashMap()

Default Constructor

Short2IntOpenHashMap

public Short2IntOpenHashMap(int minCapacity)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashMap is allowed to be.

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

Short2IntOpenHashMap

public Short2IntOpenHashMap(int minCapacity,
                            float loadFactor)

Constructor that defines the minimum capacity and load factor

Parameters:

minCapacity - the minimum capacity the HashMap is allowed to be.

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Short2IntOpenHashMap

public Short2IntOpenHashMap(java.lang.Short[] keys,
                            java.lang.Integer[] values)

Helper constructor that allow to create a map from boxed values (it will unbox them)

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

Short2IntOpenHashMap

public Short2IntOpenHashMap(java.lang.Short[] keys,
                            java.lang.Integer[] values,
                            float loadFactor)

Helper constructor that allow to create a map from boxed values (it will unbox them)

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Short2IntOpenHashMap

public Short2IntOpenHashMap(short[] keys,
                            int[] values)

Helper constructor that allow to create a map from unboxed values

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

Short2IntOpenHashMap

public Short2IntOpenHashMap(short[] keys,
                            int[] values,
                            float loadFactor)

Helper constructor that allow to create a map from unboxed values

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Short2IntOpenHashMap

public Short2IntOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Integer> map)

A Helper constructor that allows to create a Map with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

Short2IntOpenHashMap

public Short2IntOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Integer> map,
                            float loadFactor)

A Helper constructor that allows to create a Map with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Short2IntOpenHashMap

public Short2IntOpenHashMap(Short2IntMap map)

A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

Short2IntOpenHashMap

public Short2IntOpenHashMap(Short2IntMap map,
                            float loadFactor)

A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

put

public int put(short key,
               int value)

Description copied from interface: Short2IntMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putIfAbsent

public int putIfAbsent(short key,
                       int value)

Description copied from interface: Short2IntMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

addTo

public int addTo(short key,
                 int value)

Description copied from interface: Short2IntMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2IntMap

Overrides:

containsKey in class AbstractShort2IntMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

@Deprecated
public boolean containsKey(java.lang.Object key)

Deprecated.

Specified by:

containsKey in interface java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

containsKey in interface Short2IntMap

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Short,java.lang.Integer>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(int value)

Description copied from interface: Short2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2IntMap

Overrides:

containsValue in class AbstractShort2IntMap

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

@Deprecated
public boolean containsValue(java.lang.Object value)

Deprecated.

Specified by:

containsValue in interface java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

containsValue in interface Short2IntMap

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Short,java.lang.Integer>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remShort

public int remShort(short key)

Description copied from interface: Short2IntMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remShortOrDefault

public int remShortOrDefault(short key,
                             int defaultValue)

Description copied from interface: Short2IntMap

Type-Specific Remove function with a default return value if wanted.

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

remove

@Deprecated
public java.lang.Integer remove(java.lang.Object key)

Deprecated.

Specified by:

remove in interface java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

remove in interface Short2IntMap

Overrides:

remove in class java.util.AbstractMap<java.lang.Short,java.lang.Integer>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

remove

public boolean remove(short key,
                      int value)

Description copied from interface: Short2IntMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

getInt

public int getInt(short key)

Description copied from interface: Short2IntMap

A Type Specific get method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

public java.lang.Integer get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

get in interface Short2IntMap

Overrides:

get in class AbstractShort2IntMap

getOrDefault

public int getOrDefault(short key,
                        int defaultValue)

Description copied from interface: Short2IntMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2IntMap

Overrides:

getOrDefault in class AbstractShort2IntMap

Parameters:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Returns:

the searched value or defaultValue value

short2IntEntrySet

public ObjectSet<Short2IntMap.Entry> short2IntEntrySet()

Description copied from interface: Short2IntMap

Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Returns:

a EntrySet of the collection

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2IntMap

Overrides:

keySet in class AbstractShort2IntMap

values

public IntCollection values()

Specified by:

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

Specified by:

values in interface Short2IntMap

Overrides:

values in class AbstractShort2IntMap

forEach

public void forEach(ShortIntConsumer action)

Description copied from interface: Short2IntMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2IntMap

Overrides:

forEach in class AbstractShort2IntMap

Parameters:

action - processor of the values that are iterator over

replace

public boolean replace(short key,
                       int oldValue,
                       int newValue)

Description copied from interface: Short2IntMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2IntMap

Overrides:

replace in class AbstractShort2IntMap

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

replace

public int replace(short key,
                   int value)

Description copied from interface: Short2IntMap

A Type Specific replace method to reduce boxing/unboxing replace an existing value

Specified by:

replace in interface Short2IntMap

Overrides:

replace in class AbstractShort2IntMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeInt

public int computeInt(short key,
                      ShortIntUnaryOperator mappingFunction)

Description copied from interface: Short2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeInt in interface Short2IntMap

Overrides:

computeInt in class AbstractShort2IntMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIntIfAbsent

public int computeIntIfAbsent(short key,
                              Short2IntFunction mappingFunction)

Description copied from interface: Short2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfAbsent in interface Short2IntMap

Overrides:

computeIntIfAbsent in class AbstractShort2IntMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

computeIntIfPresent

public int computeIntIfPresent(short key,
                               ShortIntUnaryOperator mappingFunction)

Description copied from interface: Short2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfPresent in interface Short2IntMap

Overrides:

computeIntIfPresent in class AbstractShort2IntMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

mergeInt

public int mergeInt(short key,
                    int value,
                    IntIntUnaryOperator mappingFunction)

Description copied from interface: Short2IntMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeInt in interface Short2IntMap

Overrides:

mergeInt in class AbstractShort2IntMap

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

mergeAllInt

public void mergeAllInt(Short2IntMap m,
                        IntIntUnaryOperator mappingFunction)

Description copied from interface: Short2IntMap

A Bulk method for merging Maps.

Specified by:

mergeAllInt in interface Short2IntMap

Overrides:

mergeAllInt in class AbstractShort2IntMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

size

public int size()

Specified by:

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

Overrides:

size in class java.util.AbstractMap<java.lang.Short,java.lang.Integer>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<java.lang.Short,java.lang.Integer>