speiger.src.collections.doubles.utils.maps

Class Double2ShortMaps.SingletonMap

java.lang.Object

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

speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ShortMap

speiger.src.collections.doubles.utils.maps.Double2ShortMaps.SingletonMap

All Implemented Interfaces:

java.util.Map<java.lang.Double,java.lang.Short>, Double2ShortFunction, Double2ShortMap

Enclosing class:

Double2ShortMaps

public static class Double2ShortMaps.SingletonMap
extends AbstractDouble2ShortMap

Singleton Map instance that is used in the helper method

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ShortMap

AbstractDouble2ShortMap.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.doubles.maps.interfaces.Double2ShortMap

Double2ShortMap.BuilderCache, Double2ShortMap.Entry, Double2ShortMap.FastEntrySet, Double2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
short	addTo(double key, short value) A Helper method to add a primitives together.
short	computeShort(double key, DoubleShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfAbsent(double key, Double2ShortFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfPresent(double key, DoubleShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Double2ShortMaps.SingletonMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<Double2ShortMap.Entry>	double2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
short	get(double key) A Type Specific get method to reduce boxing/unboxing
short	getOrDefault(double key, short defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
DoubleSet	keySet()
void	mergeAllShort(Double2ShortMap m, ShortShortUnaryOperator mappingFunction) A Bulk method for merging Maps.
short	mergeShort(double key, short value, ShortShortUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
short	put(double key, short value) Type Specific method to reduce boxing/unboxing of values
short	putIfAbsent(double key, short value) Type Specific method to reduce boxing/unboxing of values
short	remove(double key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(double key, short value) Type Specific remove function to reduce boxing/unboxing
short	removeOrDefault(double key, short defaultValue) Type-Specific Remove function with a default return value if wanted.
short	subFrom(double key, short value) A Helper method to subtract from primitive from each other.
short	supplyShortIfAbsent(double key, ShortSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ShortCollection	values()

Methods inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ShortMap

addToAll, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, replaceShorts, replaceShorts, 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.doubles.maps.interfaces.Double2ShortMap

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

Methods inherited from interface java.util.Map

clear, isEmpty, size

Method Detail

put

public short put(double key,
                 short value)

Description copied from interface: Double2ShortMap

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

Description copied from interface: Double2ShortMap

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

Description copied from interface: Double2ShortMap

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 short subFrom(double key,
                     short value)

Description copied from interface: Double2ShortMap

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 Double2ShortMap.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 short remove(double key)

Description copied from interface: Double2ShortMap

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 short removeOrDefault(double key,
                             short defaultValue)

Description copied from interface: Double2ShortMap

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

Description copied from interface: Double2ShortMap

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 short get(double key)

Description copied from interface: Double2ShortMap

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 short getOrDefault(double key,
                          short defaultValue)

Description copied from interface: Double2ShortMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Double2ShortMap

Overrides:

getOrDefault in class AbstractDouble2ShortMap

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

computeShort

public short computeShort(double key,
                          DoubleShortUnaryOperator mappingFunction)

Description copied from interface: Double2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShort in interface Double2ShortMap

Overrides:

computeShort in class AbstractDouble2ShortMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeShortIfAbsent

public short computeShortIfAbsent(double key,
                                  Double2ShortFunction mappingFunction)

Description copied from interface: Double2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfAbsent in interface Double2ShortMap

Overrides:

computeShortIfAbsent in class AbstractDouble2ShortMap

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

computeShortIfPresent

public short computeShortIfPresent(double key,
                                   DoubleShortUnaryOperator mappingFunction)

Description copied from interface: Double2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfPresent in interface Double2ShortMap

Overrides:

computeShortIfPresent in class AbstractDouble2ShortMap

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

supplyShortIfAbsent

public short supplyShortIfAbsent(double key,
                                 ShortSupplier valueProvider)

Description copied from interface: Double2ShortMap

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

Specified by:

supplyShortIfAbsent in interface Double2ShortMap

Overrides:

supplyShortIfAbsent in class AbstractDouble2ShortMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeShort

public short mergeShort(double key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)

Description copied from interface: Double2ShortMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeShort in interface Double2ShortMap

Overrides:

mergeShort in class AbstractDouble2ShortMap

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

mergeAllShort

public void mergeAllShort(Double2ShortMap m,
                          ShortShortUnaryOperator mappingFunction)

Description copied from interface: Double2ShortMap

A Bulk method for merging Maps.

Specified by:

mergeAllShort in interface Double2ShortMap

Overrides:

mergeAllShort in class AbstractDouble2ShortMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

copy

public Double2ShortMaps.SingletonMap copy()

Description copied from interface: Double2ShortMap

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 Double2ShortMap

Overrides:

copy in class AbstractDouble2ShortMap

Returns:

a Shallow Copy of the Map

keySet

public DoubleSet keySet()

Specified by:

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

Specified by:

keySet in interface Double2ShortMap

Overrides:

keySet in class AbstractDouble2ShortMap

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface Double2ShortMap

Overrides:

values in class AbstractDouble2ShortMap

double2ShortEntrySet

public ObjectSet<Double2ShortMap.Entry> double2ShortEntrySet()

Description copied from interface: Double2ShortMap

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

Returns:

a EntrySet of the collection