speiger.src.collections.doubles.maps.impl.customHash

Class Double2ObjectLinkedOpenCustomHashMap<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.customHash.Double2ObjectOpenCustomHashMap<V>

speiger.src.collections.doubles.maps.impl.customHash.Double2ObjectLinkedOpenCustomHashMap<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>, Double2ObjectOrderedMap<V>, ITrimmable

public class Double2ObjectLinkedOpenCustomHashMap<V>
extends Double2ObjectOpenCustomHashMap<V>
implements Double2ObjectOrderedMap<V>

A Type Specific LinkedHashMap that allows for custom HashControl. That uses arrays to create links between nodes. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control. This implementation of SortedMap does not support SubMaps of any kind. It implements the interface due to sortability and first/last access

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

Double2ObjectOrderedMap.FastOrderedSet<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
Double2ObjectLinkedOpenCustomHashMap(double[] keys, V[] values, DoubleStrategy strategy) Helper constructor that allow to create a map from unboxed values
Double2ObjectLinkedOpenCustomHashMap(java.lang.Double[] keys, V[] values, DoubleStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Double2ObjectLinkedOpenCustomHashMap(double[] keys, V[] values, float loadFactor, DoubleStrategy strategy) Helper constructor that allow to create a map from unboxed values
Double2ObjectLinkedOpenCustomHashMap(java.lang.Double[] keys, V[] values, float loadFactor, DoubleStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Double2ObjectLinkedOpenCustomHashMap(Double2ObjectMap<V> map, DoubleStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Double2ObjectLinkedOpenCustomHashMap(Double2ObjectMap<V> map, float loadFactor, DoubleStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Double2ObjectLinkedOpenCustomHashMap(DoubleStrategy strategy) Default Constructor
Double2ObjectLinkedOpenCustomHashMap(int minCapacity, DoubleStrategy strategy) Constructor that defines the minimum capacity
Double2ObjectLinkedOpenCustomHashMap(int minCapacity, float loadFactor, DoubleStrategy strategy) Constructor that defines the minimum capacity and load factor
Double2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Double,? extends V> map, DoubleStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Double2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Double,? extends V> map, float loadFactor, DoubleStrategy strategy) 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
Double2ObjectLinkedOpenCustomHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
ObjectOrderedSet<Double2ObjectMap.Entry<V>>	double2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
double	firstDoubleKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
void	forEach(DoubleObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(double key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(double key) A Specific get method that allows to move teh given key/value int the last index.
DoubleOrderedSet	keySet()
double	lastDoubleKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(double key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(double key) A specific move method to move a given key/value to the last index.
double	pollFirstDoubleKey() A method to get and remove the first Key of a Map.
double	pollLastDoubleKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(double key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(double key, V value) A customized put method that allows you to insert into the last index.
ObjectCollection<V>	values()

Methods inherited from class speiger.src.collections.doubles.maps.impl.customHash.Double2ObjectOpenCustomHashMap

compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, get, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, supplyIfAbsent, trim

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

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

Constructor Detail

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(DoubleStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                            DoubleStrategy strategy)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashMap is allowed to be.

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the minimum capacity is negative

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                            float loadFactor,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(java.lang.Double[] keys,
                                            V[] values,
                                            DoubleStrategy strategy)

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.

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the keys and values do not match in lenght

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(java.lang.Double[] keys,
                                            V[] values,
                                            float loadFactor,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(double[] keys,
                                            V[] values,
                                            DoubleStrategy strategy)

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.

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the keys and values do not match in lenght

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(double[] keys,
                                            V[] values,
                                            float loadFactor,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Double,? extends V> map,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Double,? extends V> map,
                                            float loadFactor,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(Double2ObjectMap<V> map,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Double2ObjectLinkedOpenCustomHashMap

public Double2ObjectLinkedOpenCustomHashMap(Double2ObjectMap<V> map,
                                            float loadFactor,
                                            DoubleStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

putAndMoveToFirst

public V putAndMoveToFirst(double key,
                           V value)

Description copied from interface: Double2ObjectOrderedMap

A customized put method that allows you to insert into the first index.

Specified by:

putAndMoveToFirst in interface Double2ObjectOrderedMap<V>

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

putAndMoveToLast

public V putAndMoveToLast(double key,
                          V value)

Description copied from interface: Double2ObjectOrderedMap

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

Specified by:

putAndMoveToLast in interface Double2ObjectOrderedMap<V>

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

moveToFirst

public boolean moveToFirst(double key)

Description copied from interface: Double2ObjectOrderedMap

A specific move method to move a given key/value to the first index.

Specified by:

moveToFirst in interface Double2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(double key)

Description copied from interface: Double2ObjectOrderedMap

A specific move method to move a given key/value to the last index.

Specified by:

moveToLast in interface Double2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(double key)

Description copied from interface: Double2ObjectOrderedMap

A Specific get method that allows to move teh given key/value int the first index.

Specified by:

getAndMoveToFirst in interface Double2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(double key)

Description copied from interface: Double2ObjectOrderedMap

A Specific get method that allows to move teh given key/value int the last index.

Specified by:

getAndMoveToLast in interface Double2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Double2ObjectLinkedOpenCustomHashMap<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>

Specified by:

copy in interface Double2ObjectOrderedMap<V>

Overrides:

copy in class Double2ObjectOpenCustomHashMap<V>

Returns:

a Shallow Copy of the Map

firstDoubleKey

public double firstDoubleKey()

Description copied from interface: Double2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstDoubleKey in interface Double2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstDoubleKey

public double pollFirstDoubleKey()

Description copied from interface: Double2ObjectOrderedMap

A method to get and remove the first Key of a Map.

Specified by:

pollFirstDoubleKey in interface Double2ObjectOrderedMap<V>

Returns:

the first key in the map

lastDoubleKey

public double lastDoubleKey()

Description copied from interface: Double2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastDoubleKey in interface Double2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastDoubleKey

public double pollLastDoubleKey()

Description copied from interface: Double2ObjectOrderedMap

A method to get and remove the last Key of a Map.

Specified by:

pollLastDoubleKey in interface Double2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Double2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Double2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Double2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Double2ObjectOrderedMap<V>

Returns:

the last key in the map

double2ObjectEntrySet

public ObjectOrderedSet<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>

Specified by:

double2ObjectEntrySet in interface Double2ObjectOrderedMap<V>

Overrides:

double2ObjectEntrySet in class Double2ObjectOpenCustomHashMap<V>

Returns:

a EntrySet of the collection

keySet

public DoubleOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Double2ObjectMap<V>

Specified by:

keySet in interface Double2ObjectOrderedMap<V>

Overrides:

keySet in class Double2ObjectOpenCustomHashMap<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 Double2ObjectOpenCustomHashMap<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 Double2ObjectOpenCustomHashMap<V>

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

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

Overrides:

clear in class Double2ObjectOpenCustomHashMap<V>

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

Overrides:

clearAndTrim in class Double2ObjectOpenCustomHashMap<V>

Parameters:

size - the amount of elements that should be allowed