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

Class Double2ShortLinkedOpenHashMap

java.lang.Object

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

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

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

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

All Implemented Interfaces:

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

public class Double2ShortLinkedOpenHashMap
extends Double2ShortOpenHashMap
implements Double2ShortOrderedMap

A Type Specific LinkedHashMap implementation that uses specific arrays to create links between nodes to remove the wrapping of elements to greatly reduce memory usage. In Addition adding some helper methods to move around elements. 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.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.Double2ShortOrderedMap

Double2ShortOrderedMap.FastOrderedSet

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ShortMap

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

Constructor Summary

Constructors

Constructor and Description
Double2ShortLinkedOpenHashMap() Default Constructor
Double2ShortLinkedOpenHashMap(double[] keys, short[] values) Helper constructor that allow to create a map from unboxed values
Double2ShortLinkedOpenHashMap(java.lang.Double[] keys, java.lang.Short[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Double2ShortLinkedOpenHashMap(double[] keys, short[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Double2ShortLinkedOpenHashMap(java.lang.Double[] keys, java.lang.Short[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Double2ShortLinkedOpenHashMap(Double2ShortMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Double2ShortLinkedOpenHashMap(Double2ShortMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Double2ShortLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Double2ShortLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Double2ShortLinkedOpenHashMap(java.util.Map<? extends java.lang.Double,? extends java.lang.Short> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Double2ShortLinkedOpenHashMap(java.util.Map<? extends java.lang.Double,? extends java.lang.Short> 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
boolean	containsValue(java.lang.Object value) Deprecated.
boolean	containsValue(short value) Type Specific method to reduce boxing/unboxing of values
Double2ShortLinkedOpenHashMap	copy() A Function that does a shallow clone of the Map itself.
ObjectOrderedSet<Double2ShortMap.Entry>	double2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
double	firstDoubleKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
void	forEach(DoubleShortConsumer action) Type Specific forEach method to reduce boxing/unboxing
short	getAndMoveToFirst(double key) A Specific get method that allows to move teh given key/value int the first index.
short	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.
short	lastShortValue() 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.
short	putAndMoveToFirst(double key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(double key, short value) A customized put method that allows you to insert into the last index.
ShortCollection	values()

Methods inherited from class speiger.src.collections.doubles.maps.impl.hash.Double2ShortOpenHashMap

addTo, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, get, get, getOrDefault, mergeAllShort, mergeShort, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, subFrom, supplyShortIfAbsent, trim

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, 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.Double2ShortOrderedMap

synchronize, synchronize, unmodifiable

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

addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, size

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

clearAndTrim, trim

Constructor Detail

Double2ShortLinkedOpenHashMap

public Double2ShortLinkedOpenHashMap()

Default Constructor

Double2ShortLinkedOpenHashMap

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

Double2ShortLinkedOpenHashMap

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

Double2ShortLinkedOpenHashMap

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

Double2ShortLinkedOpenHashMap

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

Double2ShortLinkedOpenHashMap

public Double2ShortLinkedOpenHashMap(double[] keys,
                                     short[] 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

Double2ShortLinkedOpenHashMap

public Double2ShortLinkedOpenHashMap(double[] keys,
                                     short[] 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

Double2ShortLinkedOpenHashMap

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

Double2ShortLinkedOpenHashMap

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

Double2ShortLinkedOpenHashMap

public Double2ShortLinkedOpenHashMap(Double2ShortMap 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

Double2ShortLinkedOpenHashMap

public Double2ShortLinkedOpenHashMap(Double2ShortMap 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

putAndMoveToFirst

public short putAndMoveToFirst(double key,
                               short value)

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

putAndMoveToFirst in interface Double2ShortOrderedMap

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

Description copied from interface: Double2ShortOrderedMap

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 Double2ShortOrderedMap

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: Double2ShortOrderedMap

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

Specified by:

moveToFirst in interface Double2ShortOrderedMap

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: Double2ShortOrderedMap

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

Specified by:

moveToLast in interface Double2ShortOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(double key)

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

getAndMoveToFirst in interface Double2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(double key)

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

getAndMoveToLast in interface Double2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

containsValue

public boolean containsValue(short value)

Description copied from interface: Double2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Double2ShortMap

Overrides:

containsValue in class Double2ShortOpenHashMap

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

@Deprecated
public boolean containsValue(java.lang.Object value)

Deprecated.

Specified by:

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

Specified by:

containsValue in interface Double2ShortMap

Overrides:

containsValue in class Double2ShortOpenHashMap

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

copy

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

Specified by:

copy in interface Double2ShortOrderedMap

Overrides:

copy in class Double2ShortOpenHashMap

Returns:

a Shallow Copy of the Map

firstDoubleKey

public double firstDoubleKey()

Description copied from interface: Double2ShortOrderedMap

A method to get the first Key of a Map.

Specified by:

firstDoubleKey in interface Double2ShortOrderedMap

Returns:

the first key in the map

pollFirstDoubleKey

public double pollFirstDoubleKey()

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

pollFirstDoubleKey in interface Double2ShortOrderedMap

Returns:

the first key in the map

lastDoubleKey

public double lastDoubleKey()

Description copied from interface: Double2ShortOrderedMap

A method to get the last Key of a Map.

Specified by:

lastDoubleKey in interface Double2ShortOrderedMap

Returns:

the last key in the map

pollLastDoubleKey

public double pollLastDoubleKey()

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

pollLastDoubleKey in interface Double2ShortOrderedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Double2ShortOrderedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Double2ShortOrderedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Double2ShortOrderedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Double2ShortOrderedMap

Returns:

the last key in the map

double2ShortEntrySet

public ObjectOrderedSet<Double2ShortMap.Entry> double2ShortEntrySet()

Description copied from interface: Double2ShortMap

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

Specified by:

double2ShortEntrySet in interface Double2ShortMap

Specified by:

double2ShortEntrySet in interface Double2ShortOrderedMap

Overrides:

double2ShortEntrySet in class Double2ShortOpenHashMap

Returns:

a EntrySet of the collection

keySet

public DoubleOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Double2ShortMap

Specified by:

keySet in interface Double2ShortOrderedMap

Overrides:

keySet in class Double2ShortOpenHashMap

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 Double2ShortOpenHashMap

forEach

public void forEach(DoubleShortConsumer action)

Description copied from interface: Double2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Double2ShortMap

Overrides:

forEach in class Double2ShortOpenHashMap

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,java.lang.Short>

Overrides:

clear in class Double2ShortOpenHashMap

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 Double2ShortOpenHashMap

Parameters:

size - the amount of elements that should be allowed