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

Class Int2IntOpenHashMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2IntMap

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

All Implemented Interfaces:

java.util.function.IntUnaryOperator, java.util.Map<java.lang.Integer,java.lang.Integer>, Int2IntFunction, Int2IntMap, ITrimmable

Direct Known Subclasses:

Int2IntLinkedOpenHashMap

public class Int2IntOpenHashMap
extends AbstractInt2IntMap
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.ints.maps.abstracts.AbstractInt2IntMap

AbstractInt2IntMap.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.Int2IntMap

Int2IntMap.BuilderCache, Int2IntMap.Entry, Int2IntMap.FastEntrySet, Int2IntMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Int2IntOpenHashMap() Default Constructor
Int2IntOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Int2IntOpenHashMap(int[] keys, int[] values) Helper constructor that allow to create a map from unboxed values
Int2IntOpenHashMap(int[] keys, int[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Int2IntOpenHashMap(Int2IntMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Int2IntOpenHashMap(Int2IntMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Int2IntOpenHashMap(java.lang.Integer[] keys, java.lang.Integer[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Int2IntOpenHashMap(java.lang.Integer[] keys, java.lang.Integer[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Int2IntOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Int2IntOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Integer> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Int2IntOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Integer> 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
int	addTo(int key, int value) A Helper method to add a primitives together.
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
int	computeInt(int key, IntIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(int key, Int2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(int key, IntIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(int key) Type Specific method to reduce boxing/unboxing of values
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
Int2IntOpenHashMap	copy() A Function that does a shallow clone of the Map itself.
void	forEach(IntIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
int	get(int key) A Type Specific get method to reduce boxing/unboxing
java.lang.Integer	get(java.lang.Object key)
int	getOrDefault(int key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<Int2IntMap.Entry>	int2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
void	mergeAllInt(Int2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(int key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
int	put(int key, int value) Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(int key, int value) Type Specific method to reduce boxing/unboxing of values
int	remove(int key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(int key, int value) Type Specific remove function to reduce boxing/unboxing
java.lang.Integer	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
int	removeOrDefault(int key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
int	replace(int key, int value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(int key, int oldValue, int newValue) A Type Specific replace method to replace an existing value
int	size()
int	subFrom(int key, int value) A Helper method to subtract from primitive from each other.
int	supplyIntIfAbsent(int key, IntSupplier 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
IntCollection	values()

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceInts, replaceInts, 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.ints.maps.interfaces.Int2IntMap

builder, compute, computeIfAbsent, computeIfPresent, forEach, merge, putAll, putAll, putIfAbsent, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

isEmpty

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2IntFunction

applyAsInt

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose, identity

Constructor Detail

Int2IntOpenHashMap

public Int2IntOpenHashMap()

Default Constructor

Int2IntOpenHashMap

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

Int2IntOpenHashMap

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

Int2IntOpenHashMap

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

Int2IntOpenHashMap

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

Int2IntOpenHashMap

public Int2IntOpenHashMap(int[] keys,
                          int[] 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

Int2IntOpenHashMap

public Int2IntOpenHashMap(int[] keys,
                          int[] 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

Int2IntOpenHashMap

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

Int2IntOpenHashMap

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

Int2IntOpenHashMap

public Int2IntOpenHashMap(Int2IntMap 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

Int2IntOpenHashMap

public Int2IntOpenHashMap(Int2IntMap 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 int put(int key,
               int value)

Description copied from interface: Int2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Int2IntMap

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

Description copied from interface: Int2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Int2IntMap

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

Description copied from interface: Int2IntMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Specified by:

addTo in interface Int2IntMap

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

Description copied from interface: Int2IntMap

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 Int2IntMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Specified by:

subFrom in interface Int2IntMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

containsKey

public boolean containsKey(int key)

Description copied from interface: Int2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Int2IntMap

Overrides:

containsKey in class AbstractInt2IntMap

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

Specified by:

containsKey in interface Int2IntMap

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Integer,java.lang.Integer>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(int value)

Description copied from interface: Int2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Int2IntMap

Overrides:

containsValue in class AbstractInt2IntMap

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

Specified by:

containsValue in interface Int2IntMap

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Integer,java.lang.Integer>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remove

public int remove(int key)

Description copied from interface: Int2IntMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Int2IntMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public int removeOrDefault(int key,
                           int defaultValue)

Description copied from interface: Int2IntMap

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

Specified by:

removeOrDefault in interface Int2IntMap

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

Specified by:

remove in interface java.util.Map<java.lang.Integer,java.lang.Integer>

Specified by:

remove in interface Int2IntMap

Overrides:

remove in class AbstractInt2IntMap

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

Description copied from interface: Int2IntMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Int2IntMap

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

Specified by:

remove in interface Int2IntMap

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

Description copied from interface: Int2IntMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Int2IntFunction

Specified by:

get in interface Int2IntMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

public java.lang.Integer get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Integer,java.lang.Integer>

Specified by:

get in interface Int2IntMap

Overrides:

get in class AbstractInt2IntMap

getOrDefault

public int getOrDefault(int key,
                        int defaultValue)

Description copied from interface: Int2IntMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2IntMap

Overrides:

getOrDefault in class AbstractInt2IntMap

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 Int2IntOpenHashMap copy()

Description copied from interface: Int2IntMap

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 Int2IntMap

Overrides:

copy in class AbstractInt2IntMap

Returns:

a Shallow Copy of the Map

int2IntEntrySet

public ObjectSet<Int2IntMap.Entry> int2IntEntrySet()

Description copied from interface: Int2IntMap

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

Specified by:

int2IntEntrySet in interface Int2IntMap

Returns:

a EntrySet of the collection

keySet

public IntSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2IntMap

Overrides:

keySet in class AbstractInt2IntMap

values

public IntCollection values()

Specified by:

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

Specified by:

values in interface Int2IntMap

Overrides:

values in class AbstractInt2IntMap

forEach

public void forEach(IntIntConsumer action)

Description copied from interface: Int2IntMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Int2IntMap

Overrides:

forEach in class AbstractInt2IntMap

Parameters:

action - processor of the values that are iterator over

replace

public boolean replace(int key,
                       int oldValue,
                       int newValue)

Description copied from interface: Int2IntMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Int2IntMap

Overrides:

replace in class AbstractInt2IntMap

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

Description copied from interface: Int2IntMap

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

Specified by:

replace in interface Int2IntMap

Overrides:

replace in class AbstractInt2IntMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeInt

public int computeInt(int key,
                      IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeInt in interface Int2IntMap

Overrides:

computeInt in class AbstractInt2IntMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIntIfAbsent

public int computeIntIfAbsent(int key,
                              Int2IntFunction mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfAbsent in interface Int2IntMap

Overrides:

computeIntIfAbsent in class AbstractInt2IntMap

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

supplyIntIfAbsent

public int supplyIntIfAbsent(int key,
                             IntSupplier valueProvider)

Description copied from interface: Int2IntMap

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

Specified by:

supplyIntIfAbsent in interface Int2IntMap

Overrides:

supplyIntIfAbsent in class AbstractInt2IntMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeIntIfPresent

public int computeIntIfPresent(int key,
                               IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfPresent in interface Int2IntMap

Overrides:

computeIntIfPresent in class AbstractInt2IntMap

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

mergeInt

public int mergeInt(int key,
                    int value,
                    IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeInt in interface Int2IntMap

Overrides:

mergeInt in class AbstractInt2IntMap

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

mergeAllInt

public void mergeAllInt(Int2IntMap m,
                        IntIntUnaryOperator mappingFunction)

Description copied from interface: Int2IntMap

A Bulk method for merging Maps.

Specified by:

mergeAllInt in interface Int2IntMap

Overrides:

mergeAllInt in class AbstractInt2IntMap

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

Overrides:

size in class java.util.AbstractMap<java.lang.Integer,java.lang.Integer>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<java.lang.Integer,java.lang.Integer>

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