speiger.src.collections.shorts.utils.maps

Class Short2FloatMaps.SingletonMap

java.lang.Object

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

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

speiger.src.collections.shorts.utils.maps.Short2FloatMaps.SingletonMap

All Implemented Interfaces:

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

Enclosing class:

Short2FloatMaps

public static class Short2FloatMaps.SingletonMap
extends AbstractShort2FloatMap

Singleton Map instance that is used in the helper method

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

Method Summary

Modifier and Type	Method and Description
float	addTo(short key, float value) A Helper method to add a primitives together.
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
Short2FloatMaps.SingletonMap	copy() A Function that does a shallow clone of the Map itself.
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
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.
ObjectSet<Short2FloatMap.Entry>	short2FloatEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
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
FloatCollection	values()

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

addToAll, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, replaceFloats, replaceFloats, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, merge, putAll, putAll, putIfAbsent, remove, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Method Detail

put

public float put(short key,
                 float value)

Description copied from interface: Short2FloatMap

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

Description copied from interface: Short2FloatMap

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

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

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public float remove(short key)

Description copied from interface: Short2FloatMap

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

removeOrDefault

public float removeOrDefault(short key,
                             float defaultValue)

Description copied from interface: Short2FloatMap

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

public boolean remove(short key,
                      float value)

Description copied from interface: Short2FloatMap

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)

get

public float get(short key)

Description copied from interface: Short2FloatMap

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

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

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

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

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

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

copy

public Short2FloatMaps.SingletonMap 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

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

short2FloatEntrySet

public ObjectSet<Short2FloatMap.Entry> short2FloatEntrySet()

Description copied from interface: Short2FloatMap

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

Returns:

a EntrySet of the collection