speiger.src.collections.ints.utils.maps

Class Int2DoubleMaps.SingletonMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2DoubleMap

speiger.src.collections.ints.utils.maps.Int2DoubleMaps.SingletonMap

All Implemented Interfaces:

java.util.function.IntToDoubleFunction, java.util.Map<java.lang.Integer,java.lang.Double>, Int2DoubleFunction, Int2DoubleMap

Enclosing class:

Int2DoubleMaps

public static class Int2DoubleMaps.SingletonMap
extends AbstractInt2DoubleMap

Singleton Map instance that is used in the helper method

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2DoubleMap

AbstractInt2DoubleMap.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.ints.maps.interfaces.Int2DoubleMap

Int2DoubleMap.BuilderCache, Int2DoubleMap.Entry, Int2DoubleMap.FastEntrySet, Int2DoubleMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
double	addTo(int key, double value) A Helper method to add a primitives together.
double	computeDouble(int key, IntDoubleUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
double	computeDoubleIfAbsent(int key, Int2DoubleFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
double	computeDoubleIfPresent(int key, IntDoubleUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Int2DoubleMaps.SingletonMap	copy() A Function that does a shallow clone of the Map itself.
double	get(int key) A Type Specific get method to reduce boxing/unboxing
double	getOrDefault(int key, double defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<Int2DoubleMap.Entry>	int2DoubleEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
void	mergeAllDouble(Int2DoubleMap m, DoubleDoubleUnaryOperator mappingFunction) A Bulk method for merging Maps.
double	mergeDouble(int key, double value, DoubleDoubleUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
double	put(int key, double value) Type Specific method to reduce boxing/unboxing of values
double	putIfAbsent(int key, double value) Type Specific method to reduce boxing/unboxing of values
double	remove(int key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(int key, double value) Type Specific remove function to reduce boxing/unboxing
double	removeOrDefault(int key, double defaultValue) Type-Specific Remove function with a default return value if wanted.
double	subFrom(int key, double value) A Helper method to subtract from primitive from each other.
double	supplyDoubleIfAbsent(int key, DoubleSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
DoubleCollection	values()

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2DoubleMap

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

applyAsDouble, 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 double put(int key,
                  double value)

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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 Int2DoubleMap.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 double remove(int key)

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

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

Description copied from interface: Int2DoubleMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2DoubleMap

Overrides:

getOrDefault in class AbstractInt2DoubleMap

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

computeDouble

public double computeDouble(int key,
                            IntDoubleUnaryOperator mappingFunction)

Description copied from interface: Int2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDouble in interface Int2DoubleMap

Overrides:

computeDouble in class AbstractInt2DoubleMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeDoubleIfAbsent

public double computeDoubleIfAbsent(int key,
                                    Int2DoubleFunction mappingFunction)

Description copied from interface: Int2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDoubleIfAbsent in interface Int2DoubleMap

Overrides:

computeDoubleIfAbsent in class AbstractInt2DoubleMap

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

computeDoubleIfPresent

public double computeDoubleIfPresent(int key,
                                     IntDoubleUnaryOperator mappingFunction)

Description copied from interface: Int2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDoubleIfPresent in interface Int2DoubleMap

Overrides:

computeDoubleIfPresent in class AbstractInt2DoubleMap

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

supplyDoubleIfAbsent

public double supplyDoubleIfAbsent(int key,
                                   DoubleSupplier valueProvider)

Description copied from interface: Int2DoubleMap

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

Specified by:

supplyDoubleIfAbsent in interface Int2DoubleMap

Overrides:

supplyDoubleIfAbsent in class AbstractInt2DoubleMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeDouble

public double mergeDouble(int key,
                          double value,
                          DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Int2DoubleMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeDouble in interface Int2DoubleMap

Overrides:

mergeDouble in class AbstractInt2DoubleMap

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

mergeAllDouble

public void mergeAllDouble(Int2DoubleMap m,
                           DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Int2DoubleMap

A Bulk method for merging Maps.

Specified by:

mergeAllDouble in interface Int2DoubleMap

Overrides:

mergeAllDouble in class AbstractInt2DoubleMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

copy

public Int2DoubleMaps.SingletonMap copy()

Description copied from interface: Int2DoubleMap

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 Int2DoubleMap

Overrides:

copy in class AbstractInt2DoubleMap

Returns:

a Shallow Copy of the Map

keySet

public IntSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2DoubleMap

Overrides:

keySet in class AbstractInt2DoubleMap

values

public DoubleCollection values()

Specified by:

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

Specified by:

values in interface Int2DoubleMap

Overrides:

values in class AbstractInt2DoubleMap

int2DoubleEntrySet

public ObjectSet<Int2DoubleMap.Entry> int2DoubleEntrySet()

Description copied from interface: Int2DoubleMap

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

Returns:

a EntrySet of the collection