speiger.src.collections.ints.maps.impl.hash

Class Int2ShortLinkedOpenHashMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ShortMap

speiger.src.collections.ints.maps.impl.hash.Int2ShortOpenHashMap

speiger.src.collections.ints.maps.impl.hash.Int2ShortLinkedOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Short>, java.util.SortedMap<java.lang.Integer,java.lang.Short>, Int2ShortFunction, Int2ShortMap, Int2ShortSortedMap

public class Int2ShortLinkedOpenHashMap
extends Int2ShortOpenHashMap
implements Int2ShortSortedMap

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.ints.maps.abstracts.AbstractInt2ShortMap

AbstractInt2ShortMap.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.Int2ShortSortedMap

Int2ShortSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ShortMap

Int2ShortMap.Entry, Int2ShortMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Int2ShortLinkedOpenHashMap() Default Constructor
Int2ShortLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Int2ShortLinkedOpenHashMap(int[] keys, short[] values) Helper constructor that allow to create a map from unboxed values
Int2ShortLinkedOpenHashMap(int[] keys, short[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Int2ShortLinkedOpenHashMap(Int2ShortMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Int2ShortLinkedOpenHashMap(Int2ShortMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Int2ShortLinkedOpenHashMap(java.lang.Integer[] keys, java.lang.Short[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Int2ShortLinkedOpenHashMap(java.lang.Integer[] keys, java.lang.Short[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Int2ShortLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Int2ShortLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Short> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Int2ShortLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? 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()
IntComparator	comparator()
int	firstIntKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
void	forEach(IntShortConsumer action) Type Specific forEach method to reduce boxing/unboxing
short	getAndMoveToFirst(int key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(int key) A Specific get method that allows to move teh given key/value int the last index.
Int2ShortSortedMap	headMap(int toKey) A Type Specific HeadMap method to reduce boxing/unboxing
ObjectSet<Int2ShortMap.Entry>	int2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
int	lastIntKey() A method to get the last Key of a Map.
short	lastShortValue() A method to get the last Value of a Map.
boolean	moveToFirst(int key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(int key) A specific move method to move a given key/value to the last index.
int	pollFirstIntKey() A method to get and remove the first Key of a Map.
int	pollLastIntKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(int key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(int key, short value) A customized put method that allows you to insert into the last index.
Int2ShortSortedMap	subMap(int fromKey, int toKey) A Type Specific SubMap method to reduce boxing/unboxing
Int2ShortSortedMap	tailMap(int fromKey) A Type Specific TailMap method to reduce boxing/unboxing
ShortCollection	values()

Methods inherited from class speiger.src.collections.ints.maps.impl.hash.Int2ShortOpenHashMap

addTo, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, get, getOrDefault, getShort, mergeAllShort, mergeShort, put, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, size

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

isEmpty, put, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ShortSortedMap

firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ShortMap

addTo, addToAll, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, size

Constructor Detail

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap()

Default Constructor

Int2ShortLinkedOpenHashMap

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

Int2ShortLinkedOpenHashMap

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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(java.lang.Integer[] 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(java.lang.Integer[] 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(int[] 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(int[] 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(Int2ShortMap 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

Int2ShortLinkedOpenHashMap

public Int2ShortLinkedOpenHashMap(Int2ShortMap 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(int key,
                               short value)

Description copied from interface: Int2ShortSortedMap

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

Specified by:

putAndMoveToFirst in interface Int2ShortSortedMap

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

Description copied from interface: Int2ShortSortedMap

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 Int2ShortSortedMap

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

Description copied from interface: Int2ShortSortedMap

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

Specified by:

moveToFirst in interface Int2ShortSortedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(int key)

Description copied from interface: Int2ShortSortedMap

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

Specified by:

moveToLast in interface Int2ShortSortedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(int key)

Description copied from interface: Int2ShortSortedMap

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

Specified by:

getAndMoveToFirst in interface Int2ShortSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(int key)

Description copied from interface: Int2ShortSortedMap

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

Specified by:

getAndMoveToLast in interface Int2ShortSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public IntComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Integer,java.lang.Short>

Specified by:

comparator in interface Int2ShortSortedMap

subMap

public Int2ShortSortedMap subMap(int fromKey,
                                 int toKey)

Description copied from interface: Int2ShortSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Int2ShortSortedMap

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

public Int2ShortSortedMap headMap(int toKey)

Description copied from interface: Int2ShortSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Int2ShortSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Int2ShortSortedMap tailMap(int fromKey)

Description copied from interface: Int2ShortSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Int2ShortSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstIntKey

public int firstIntKey()

Description copied from interface: Int2ShortSortedMap

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2ShortSortedMap

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2ShortSortedMap

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

Specified by:

pollFirstIntKey in interface Int2ShortSortedMap

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ShortSortedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2ShortSortedMap

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2ShortSortedMap

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

Specified by:

pollLastIntKey in interface Int2ShortSortedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Int2ShortSortedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Int2ShortSortedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Int2ShortSortedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Int2ShortSortedMap

Returns:

the last key in the map

int2ShortEntrySet

public ObjectSet<Int2ShortMap.Entry> int2ShortEntrySet()

Description copied from interface: Int2ShortMap

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

Specified by:

int2ShortEntrySet in interface Int2ShortMap

Overrides:

int2ShortEntrySet in class Int2ShortOpenHashMap

Returns:

a EntrySet of the collection

keySet

public IntSet keySet()

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<java.lang.Integer,java.lang.Short>

Specified by:

keySet in interface Int2ShortMap

Specified by:

keySet in interface Int2ShortSortedMap

Overrides:

keySet in class Int2ShortOpenHashMap

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface java.util.SortedMap<java.lang.Integer,java.lang.Short>

Specified by:

values in interface Int2ShortMap

Specified by:

values in interface Int2ShortSortedMap

Overrides:

values in class Int2ShortOpenHashMap

forEach

public void forEach(IntShortConsumer action)

Description copied from interface: Int2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Int2ShortMap

Overrides:

forEach in class Int2ShortOpenHashMap

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Integer,java.lang.Short>

Overrides:

clear in class Int2ShortOpenHashMap