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

Class Short2FloatOpenHashMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2FloatMap

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

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Float>, Short2FloatFunction, Short2FloatMap, ITrimmable

Direct Known Subclasses:

Short2FloatLinkedOpenHashMap

public class Short2FloatOpenHashMap
extends AbstractShort2FloatMap
implements ITrimmable

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

AbstractShort2FloatMap.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.Short2FloatMap

Short2FloatMap.BuilderCache, Short2FloatMap.Entry, Short2FloatMap.FastEntrySet, Short2FloatMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Short2FloatOpenHashMap() Default Constructor
Short2FloatOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Short2FloatOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Short2FloatOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Float> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2FloatOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Float> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2FloatOpenHashMap(short[] keys, float[] values) Helper constructor that allow to create a map from unboxed values
Short2FloatOpenHashMap(java.lang.Short[] keys, java.lang.Float[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2FloatOpenHashMap(short[] keys, float[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Short2FloatOpenHashMap(java.lang.Short[] keys, java.lang.Float[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2FloatOpenHashMap(Short2FloatMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Short2FloatOpenHashMap(Short2FloatMap 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
float	addTo(short key, float value) A Helper method to add a primitives together.
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
float	computeFloat(short key, ShortFloatUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
float	computeFloatIfAbsent(short key, Short2FloatFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
float	computeFloatIfPresent(short key, ShortFloatUnaryOperator 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(float value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
Short2FloatOpenHashMap	copy() A Function that does a shallow clone of the Map itself.
void	forEach(ShortFloatConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Float	get(java.lang.Object key)
float	get(short key) A Type Specific get method to reduce boxing/unboxing
float	getOrDefault(short key, float defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
void	mergeAllFloat(Short2FloatMap m, FloatFloatUnaryOperator mappingFunction) A Bulk method for merging Maps.
float	mergeFloat(short key, float value, FloatFloatUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
float	put(short key, float value) Type Specific method to reduce boxing/unboxing of values
float	putIfAbsent(short key, float value) Type Specific method to reduce boxing/unboxing of values
java.lang.Float	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
float	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, float value) Type Specific remove function to reduce boxing/unboxing
float	removeOrDefault(short key, float defaultValue) Type-Specific Remove function with a default return value if wanted.
float	replace(short key, float value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, float oldValue, float newValue) A Type Specific replace method to replace an existing value
ObjectSet<Short2FloatMap.Entry>	short2FloatEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	size()
float	subFrom(short key, float value) A Helper method to subtract from primitive from each other.
float	supplyFloatIfAbsent(short key, FloatSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger
FloatCollection	values()

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceFloats, replaceFloats, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

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

applyAsFloat, builder, compute, computeIfAbsent, computeIfPresent, forEach, merge, put, put, putAll, putAll, putIfAbsent, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

isEmpty

Constructor Detail

Short2FloatOpenHashMap

public Short2FloatOpenHashMap()

Default Constructor

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(java.lang.Short[] keys,
                              java.lang.Float[] 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(java.lang.Short[] keys,
                              java.lang.Float[] 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(short[] keys,
                              float[] 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(short[] keys,
                              float[] 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Float> 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Float> 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(Short2FloatMap 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

Short2FloatOpenHashMap

public Short2FloatOpenHashMap(Short2FloatMap 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 float put(short key,
                 float value)

Description copied from interface: Short2FloatMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2FloatMap

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 float putIfAbsent(short key,
                         float value)

Description copied from interface: Short2FloatMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2FloatMap

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 float addTo(short key,
                   float value)

Description copied from interface: Short2FloatMap

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

Specified by:

addTo in interface Short2FloatMap

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.

subFrom

public float subFrom(short key,
                     float value)

Description copied from interface: Short2FloatMap

A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the Short2FloatMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Specified by:

subFrom in interface Short2FloatMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2FloatMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2FloatMap

Overrides:

containsKey in class AbstractShort2FloatMap

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

Specified by:

containsKey in interface Short2FloatMap

Overrides:

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

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(float value)

Description copied from interface: Short2FloatMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2FloatMap

Overrides:

containsValue in class AbstractShort2FloatMap

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

Specified by:

containsValue in interface Short2FloatMap

Overrides:

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

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remove

public float remove(short key)

Description copied from interface: Short2FloatMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2FloatMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public float removeOrDefault(short key,
                             float defaultValue)

Description copied from interface: Short2FloatMap

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

Specified by:

removeOrDefault in interface Short2FloatMap

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

public java.lang.Float remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface Short2FloatMap

Overrides:

remove in class AbstractShort2FloatMap

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,
                      float value)

Description copied from interface: Short2FloatMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2FloatMap

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)

Specified by:

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

Specified by:

remove in interface Short2FloatMap

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)

get

public float get(short key)

Description copied from interface: Short2FloatMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2FloatMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

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

Specified by:

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

Specified by:

get in interface Short2FloatMap

Overrides:

get in class AbstractShort2FloatMap

getOrDefault

public float getOrDefault(short key,
                          float defaultValue)

Description copied from interface: Short2FloatMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2FloatMap

Overrides:

getOrDefault in class AbstractShort2FloatMap

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

copy

public Short2FloatOpenHashMap copy()

Description copied from interface: Short2FloatMap

A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface Short2FloatMap

Overrides:

copy in class AbstractShort2FloatMap

Returns:

a Shallow Copy of the Map

short2FloatEntrySet

public ObjectSet<Short2FloatMap.Entry> short2FloatEntrySet()

Description copied from interface: Short2FloatMap

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

Specified by:

short2FloatEntrySet in interface Short2FloatMap

Returns:

a EntrySet of the collection

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2FloatMap

Overrides:

keySet in class AbstractShort2FloatMap

values

public FloatCollection values()

Specified by:

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

Specified by:

values in interface Short2FloatMap

Overrides:

values in class AbstractShort2FloatMap

forEach

public void forEach(ShortFloatConsumer action)

Description copied from interface: Short2FloatMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2FloatMap

Overrides:

forEach in class AbstractShort2FloatMap

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Short2FloatMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2FloatMap

Overrides:

replace in class AbstractShort2FloatMap

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 float replace(short key,
                     float value)

Description copied from interface: Short2FloatMap

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

Specified by:

replace in interface Short2FloatMap

Overrides:

replace in class AbstractShort2FloatMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeFloat

public float computeFloat(short key,
                          ShortFloatUnaryOperator mappingFunction)

Description copied from interface: Short2FloatMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeFloat in interface Short2FloatMap

Overrides:

computeFloat in class AbstractShort2FloatMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeFloatIfAbsent

public float computeFloatIfAbsent(short key,
                                  Short2FloatFunction mappingFunction)

Description copied from interface: Short2FloatMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeFloatIfAbsent in interface Short2FloatMap

Overrides:

computeFloatIfAbsent in class AbstractShort2FloatMap

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

supplyFloatIfAbsent

public float supplyFloatIfAbsent(short key,
                                 FloatSupplier valueProvider)

Description copied from interface: Short2FloatMap

A Supplier based computeIfAbsent function to fill the most used usecase of this function

Specified by:

supplyFloatIfAbsent in interface Short2FloatMap

Overrides:

supplyFloatIfAbsent in class AbstractShort2FloatMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeFloatIfPresent

public float computeFloatIfPresent(short key,
                                   ShortFloatUnaryOperator mappingFunction)

Description copied from interface: Short2FloatMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeFloatIfPresent in interface Short2FloatMap

Overrides:

computeFloatIfPresent in class AbstractShort2FloatMap

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

mergeFloat

public float mergeFloat(short key,
                        float value,
                        FloatFloatUnaryOperator mappingFunction)

Description copied from interface: Short2FloatMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeFloat in interface Short2FloatMap

Overrides:

mergeFloat in class AbstractShort2FloatMap

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

mergeAllFloat

public void mergeAllFloat(Short2FloatMap m,
                          FloatFloatUnaryOperator mappingFunction)

Description copied from interface: Short2FloatMap

A Bulk method for merging Maps.

Specified by:

mergeAllFloat in interface Short2FloatMap

Overrides:

mergeAllFloat in class AbstractShort2FloatMap

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

Overrides:

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

clear

public void clear()

Specified by:

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

Overrides:

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

trim

public boolean trim(int size)

Description copied from interface: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Specified by:

trim in interface ITrimmable

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

clearAndTrim

public void clearAndTrim(int size)

Description copied from interface: ITrimmable

Trims the collection down to the requested size and clears all elements while doing so

Specified by:

clearAndTrim in interface ITrimmable

Parameters:

size - the amount of elements that should be allowed