speiger.src.collections.doubles.maps.impl.hash

Class Double2ObjectOpenHashMap<V>

java.lang.Object

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

speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ObjectMap<V>

speiger.src.collections.doubles.maps.impl.hash.Double2ObjectOpenHashMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.DoubleFunction<V>, java.util.Map<java.lang.Double,V>, Double2ObjectMap<V>, ITrimmable

Direct Known Subclasses:

Double2ObjectLinkedOpenHashMap

public class Double2ObjectOpenHashMap<V>
extends AbstractDouble2ObjectMap<V>
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.doubles.maps.abstracts.AbstractDouble2ObjectMap

AbstractDouble2ObjectMap.BasicEntry<V>

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

Double2ObjectMap.BuilderCache<V>, Double2ObjectMap.Entry<V>, Double2ObjectMap.FastEntrySet<V>, Double2ObjectMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Double2ObjectOpenHashMap() Default Constructor
Double2ObjectOpenHashMap(double[] keys, V[] values) Helper constructor that allow to create a map from unboxed values
Double2ObjectOpenHashMap(java.lang.Double[] keys, V[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Double2ObjectOpenHashMap(double[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Double2ObjectOpenHashMap(java.lang.Double[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Double2ObjectOpenHashMap(Double2ObjectMap<V> map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Double2ObjectOpenHashMap(Double2ObjectMap<V> map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Double2ObjectOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Double2ObjectOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Double2ObjectOpenHashMap(java.util.Map<? extends java.lang.Double,? extends V> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Double2ObjectOpenHashMap(java.util.Map<? extends java.lang.Double,? extends V> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
V	compute(double key, DoubleObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(double key, DoubleFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(double key, DoubleObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(double key) Type Specific method to reduce boxing/unboxing of values
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(java.lang.Object value)
Double2ObjectOpenHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<Double2ObjectMap.Entry<V>>	double2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	forEach(DoubleObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	get(double key) A Type Specific get method to reduce boxing/unboxing
V	get(java.lang.Object key)
V	getOrDefault(double key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
DoubleSet	keySet()
V	merge(double key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Double2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(double key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(double key, V value) Type Specific method to reduce boxing/unboxing of values
V	remove(double key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(double key, V value) Type Specific remove function to reduce boxing/unboxing
V	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
V	removeOrDefault(double key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
V	replace(double key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(double key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
int	size()
V	supplyIfAbsent(double key, ObjectSupplier<V> 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
ObjectCollection<V>	values()

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

entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, 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.doubles.maps.interfaces.Double2ObjectMap

apply, 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap()

Default Constructor

Double2ObjectOpenHashMap

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

Double2ObjectOpenHashMap

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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(java.lang.Double[] keys,
                                V[] 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(java.lang.Double[] keys,
                                V[] 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(double[] keys,
                                V[] 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(double[] keys,
                                V[] 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(java.util.Map<? extends java.lang.Double,? extends V> 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(java.util.Map<? extends java.lang.Double,? extends V> 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(Double2ObjectMap<V> 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

Double2ObjectOpenHashMap

public Double2ObjectOpenHashMap(Double2ObjectMap<V> 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 V put(double key,
             V value)

Description copied from interface: Double2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Double2ObjectMap<V>

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

Description copied from interface: Double2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Double2ObjectMap<V>

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)

containsKey

public boolean containsKey(double key)

Description copied from interface: Double2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Double2ObjectMap<V>

Overrides:

containsKey in class AbstractDouble2ObjectMap<V>

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.Double,V>

Specified by:

containsKey in interface Double2ObjectMap<V>

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Double,V>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Double,V>

Overrides:

containsValue in class AbstractDouble2ObjectMap<V>

remove

public V remove(double key)

Description copied from interface: Double2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Double2ObjectMap<V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public V removeOrDefault(double key,
                         V defaultValue)

Description copied from interface: Double2ObjectMap

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

Specified by:

removeOrDefault in interface Double2ObjectMap<V>

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 V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Double,V>

Specified by:

remove in interface Double2ObjectMap<V>

Overrides:

remove in class AbstractDouble2ObjectMap<V>

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

Description copied from interface: Double2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Double2ObjectMap<V>

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.Double,V>

Specified by:

remove in interface Double2ObjectMap<V>

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

Description copied from interface: Double2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Double2ObjectMap<V>

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Double,V>

Specified by:

get in interface Double2ObjectMap<V>

Overrides:

get in class AbstractDouble2ObjectMap<V>

getOrDefault

public V getOrDefault(double key,
                      V defaultValue)

Description copied from interface: Double2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Double2ObjectMap<V>

Overrides:

getOrDefault in class AbstractDouble2ObjectMap<V>

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 Double2ObjectOpenHashMap<V> copy()

Description copied from interface: Double2ObjectMap

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 Double2ObjectMap<V>

Overrides:

copy in class AbstractDouble2ObjectMap<V>

Returns:

a Shallow Copy of the Map

double2ObjectEntrySet

public ObjectSet<Double2ObjectMap.Entry<V>> double2ObjectEntrySet()

Description copied from interface: Double2ObjectMap

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

Specified by:

double2ObjectEntrySet in interface Double2ObjectMap<V>

Returns:

a EntrySet of the collection

keySet

public DoubleSet keySet()

Specified by:

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

Specified by:

keySet in interface Double2ObjectMap<V>

Overrides:

keySet in class AbstractDouble2ObjectMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Double2ObjectMap<V>

Overrides:

values in class AbstractDouble2ObjectMap<V>

forEach

public void forEach(DoubleObjectConsumer<V> action)

Description copied from interface: Double2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Double2ObjectMap<V>

Overrides:

forEach in class AbstractDouble2ObjectMap<V>

Parameters:

action - processor of the values that are iterator over

replace

public boolean replace(double key,
                       V oldValue,
                       V newValue)

Description copied from interface: Double2ObjectMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Double2ObjectMap<V>

Overrides:

replace in class AbstractDouble2ObjectMap<V>

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

Description copied from interface: Double2ObjectMap

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

Specified by:

replace in interface Double2ObjectMap<V>

Overrides:

replace in class AbstractDouble2ObjectMap<V>

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

compute

public V compute(double key,
                 DoubleObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Double2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Double2ObjectMap<V>

Overrides:

compute in class AbstractDouble2ObjectMap<V>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIfAbsent

public V computeIfAbsent(double key,
                         DoubleFunction<V> mappingFunction)

Description copied from interface: Double2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Double2ObjectMap<V>

Overrides:

computeIfAbsent in class AbstractDouble2ObjectMap<V>

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

supplyIfAbsent

public V supplyIfAbsent(double key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Double2ObjectMap

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

Specified by:

supplyIfAbsent in interface Double2ObjectMap<V>

Overrides:

supplyIfAbsent in class AbstractDouble2ObjectMap<V>

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeIfPresent

public V computeIfPresent(double key,
                          DoubleObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Double2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Double2ObjectMap<V>

Overrides:

computeIfPresent in class AbstractDouble2ObjectMap<V>

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

merge

public V merge(double key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Double2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Double2ObjectMap<V>

Overrides:

merge in class AbstractDouble2ObjectMap<V>

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

mergeAll

public void mergeAll(Double2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Double2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Double2ObjectMap<V>

Overrides:

mergeAll in class AbstractDouble2ObjectMap<V>

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.Double,V>

Overrides:

size in class java.util.AbstractMap<java.lang.Double,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Double,V>

Overrides:

clear in class java.util.AbstractMap<java.lang.Double,V>

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