speiger.src.collections.doubles.utils.maps

Class Double2DoubleMaps.SingletonMap

java.lang.Object

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

speiger.src.collections.doubles.maps.abstracts.AbstractDouble2DoubleMap

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

All Implemented Interfaces:

java.util.function.DoubleUnaryOperator, java.util.Map<java.lang.Double,java.lang.Double>, Double2DoubleFunction, Double2DoubleMap

Enclosing class:

Double2DoubleMaps

public static class Double2DoubleMaps.SingletonMap
extends AbstractDouble2DoubleMap

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

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

Double2DoubleMap.BuilderCache, Double2DoubleMap.Entry, Double2DoubleMap.FastEntrySet, Double2DoubleMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
double	addTo(double key, double value) A Helper method to add a primitives together.
double	computeDouble(double key, DoubleDoubleUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
double	computeDoubleIfAbsent(double key, Double2DoubleFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
double	computeDoubleIfPresent(double key, DoubleDoubleUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Double2DoubleMaps.SingletonMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<Double2DoubleMap.Entry>	double2DoubleEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
double	get(double key) A Type Specific get method to reduce boxing/unboxing
double	getOrDefault(double key, double defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
DoubleSet	keySet()
void	mergeAllDouble(Double2DoubleMap m, DoubleDoubleUnaryOperator mappingFunction) A Bulk method for merging Maps.
double	mergeDouble(double key, double value, DoubleDoubleUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
double	put(double key, double value) Type Specific method to reduce boxing/unboxing of values
double	putIfAbsent(double key, double value) Type Specific method to reduce boxing/unboxing of values
double	remove(double key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(double key, double value) Type Specific remove function to reduce boxing/unboxing
double	removeOrDefault(double key, double defaultValue) Type-Specific Remove function with a default return value if wanted.
double	subFrom(double key, double value) A Helper method to subtract from primitive from each other.
double	supplyDoubleIfAbsent(double 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.doubles.maps.abstracts.AbstractDouble2DoubleMap

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

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

Methods inherited from interface speiger.src.collections.doubles.functions.function.Double2DoubleFunction

applyAsDouble

Methods inherited from interface java.util.function.DoubleUnaryOperator

andThen, compose, identity

Method Detail

put

public double put(double key,
                  double value)

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

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 Double2DoubleMap.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(double key)

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

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

Description copied from interface: Double2DoubleMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Double2DoubleMap

Overrides:

getOrDefault in class AbstractDouble2DoubleMap

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(double key,
                            DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Double2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDouble in interface Double2DoubleMap

Overrides:

computeDouble in class AbstractDouble2DoubleMap

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(double key,
                                    Double2DoubleFunction mappingFunction)

Description copied from interface: Double2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDoubleIfAbsent in interface Double2DoubleMap

Overrides:

computeDoubleIfAbsent in class AbstractDouble2DoubleMap

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(double key,
                                     DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Double2DoubleMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeDoubleIfPresent in interface Double2DoubleMap

Overrides:

computeDoubleIfPresent in class AbstractDouble2DoubleMap

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(double key,
                                   DoubleSupplier valueProvider)

Description copied from interface: Double2DoubleMap

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

Specified by:

supplyDoubleIfAbsent in interface Double2DoubleMap

Overrides:

supplyDoubleIfAbsent in class AbstractDouble2DoubleMap

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

Description copied from interface: Double2DoubleMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeDouble in interface Double2DoubleMap

Overrides:

mergeDouble in class AbstractDouble2DoubleMap

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(Double2DoubleMap m,
                           DoubleDoubleUnaryOperator mappingFunction)

Description copied from interface: Double2DoubleMap

A Bulk method for merging Maps.

Specified by:

mergeAllDouble in interface Double2DoubleMap

Overrides:

mergeAllDouble in class AbstractDouble2DoubleMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

copy

public Double2DoubleMaps.SingletonMap copy()

Description copied from interface: Double2DoubleMap

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 Double2DoubleMap

Overrides:

copy in class AbstractDouble2DoubleMap

Returns:

a Shallow Copy of the Map

keySet

public DoubleSet keySet()

Specified by:

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

Specified by:

keySet in interface Double2DoubleMap

Overrides:

keySet in class AbstractDouble2DoubleMap

values

public DoubleCollection values()

Specified by:

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

Specified by:

values in interface Double2DoubleMap

Overrides:

values in class AbstractDouble2DoubleMap

double2DoubleEntrySet

public ObjectSet<Double2DoubleMap.Entry> double2DoubleEntrySet()

Description copied from interface: Double2DoubleMap

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

Returns:

a EntrySet of the collection