speiger.src.collections.longs.maps.impl.hash

Class Long2IntOpenHashMap

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2IntMap

speiger.src.collections.longs.maps.impl.hash.Long2IntOpenHashMap

All Implemented Interfaces:

java.util.function.LongToIntFunction, java.util.Map<java.lang.Long,java.lang.Integer>, Long2IntFunction, Long2IntMap

Direct Known Subclasses:

Long2IntLinkedOpenHashMap

public class Long2IntOpenHashMap
extends AbstractLong2IntMap

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.longs.maps.abstracts.AbstractLong2IntMap

AbstractLong2IntMap.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.longs.maps.interfaces.Long2IntMap

Long2IntMap.Entry, Long2IntMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Long2IntOpenHashMap() Default Constructor
Long2IntOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Long2IntOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Long2IntOpenHashMap(long[] keys, int[] values) Helper constructor that allow to create a map from unboxed values
Long2IntOpenHashMap(long[] keys, int[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Long2IntOpenHashMap(java.lang.Long[] keys, java.lang.Integer[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2IntOpenHashMap(java.lang.Long[] keys, java.lang.Integer[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2IntOpenHashMap(Long2IntMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2IntOpenHashMap(Long2IntMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2IntOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Integer> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Long2IntOpenHashMap(java.util.Map<? extends java.lang.Long,? 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(long key, int value) A Helper method to add a primitives together.
void	clear()
int	computeInt(long key, LongIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(long key, Long2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(long key, LongIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(long 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.
void	forEach(LongIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Integer	get(java.lang.Object key)
int	getInt(long key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(long key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
LongSet	keySet()
ObjectSet<Long2IntMap.Entry>	long2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	mergeAllInt(Long2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(long key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
int	put(long key, int value) Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(long key, int value) Type Specific method to reduce boxing/unboxing of values
int	remLong(long key) Type Specific remove function to reduce boxing/unboxing
int	remLongOrDefault(long key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(long key, int value) Type Specific remove function to reduce boxing/unboxing
java.lang.Integer	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
int	replace(long key, int value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(long key, int oldValue, int newValue) A Type Specific replace method to replace an existing value
int	size()
IntCollection	values()

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2IntMap

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

compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map

isEmpty

Methods inherited from interface speiger.src.collections.longs.functions.function.Long2IntFunction

applyAsInt

Constructor Detail

Long2IntOpenHashMap

public Long2IntOpenHashMap()

Default Constructor

Long2IntOpenHashMap

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

Long2IntOpenHashMap

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

Long2IntOpenHashMap

public Long2IntOpenHashMap(java.lang.Long[] 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

Long2IntOpenHashMap

public Long2IntOpenHashMap(java.lang.Long[] 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

Long2IntOpenHashMap

public Long2IntOpenHashMap(long[] 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

Long2IntOpenHashMap

public Long2IntOpenHashMap(long[] 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

Long2IntOpenHashMap

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

Long2IntOpenHashMap

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

Long2IntOpenHashMap

public Long2IntOpenHashMap(Long2IntMap 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

Long2IntOpenHashMap

public Long2IntOpenHashMap(Long2IntMap 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(long key,
               int value)

Description copied from interface: Long2IntMap

Type Specific method to reduce boxing/unboxing of values

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

Description copied from interface: Long2IntMap

Type Specific method to reduce boxing/unboxing of values

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

Description copied from interface: Long2IntMap

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

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.

containsKey

public boolean containsKey(long key)

Description copied from interface: Long2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Long2IntMap

Overrides:

containsKey in class AbstractLong2IntMap

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

Specified by:

containsKey in interface Long2IntMap

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Long,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: Long2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Long2IntMap

Overrides:

containsValue in class AbstractLong2IntMap

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

Specified by:

containsValue in interface Long2IntMap

Overrides:

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

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remLong

public int remLong(long key)

Description copied from interface: Long2IntMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remLongOrDefault

public int remLongOrDefault(long key,
                            int defaultValue)

Description copied from interface: Long2IntMap

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

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

@Deprecated
public java.lang.Integer remove(java.lang.Object key)

Deprecated.

Specified by:

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

Specified by:

remove in interface Long2IntMap

Overrides:

remove in class java.util.AbstractMap<java.lang.Long,java.lang.Integer>

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

Description copied from interface: Long2IntMap

Type Specific remove function to reduce boxing/unboxing

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)

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)

getInt

public int getInt(long key)

Description copied from interface: Long2IntMap

A Type Specific get method to reduce boxing/unboxing

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

Specified by:

get in interface Long2IntMap

Overrides:

get in class AbstractLong2IntMap

getOrDefault

public int getOrDefault(long key,
                        int defaultValue)

Description copied from interface: Long2IntMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Long2IntMap

Overrides:

getOrDefault in class AbstractLong2IntMap

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

long2IntEntrySet

public ObjectSet<Long2IntMap.Entry> long2IntEntrySet()

Description copied from interface: Long2IntMap

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

Returns:

a EntrySet of the collection

keySet

public LongSet keySet()

Specified by:

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

Specified by:

keySet in interface Long2IntMap

Overrides:

keySet in class AbstractLong2IntMap

values

public IntCollection values()

Specified by:

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

Specified by:

values in interface Long2IntMap

Overrides:

values in class AbstractLong2IntMap

forEach

public void forEach(LongIntConsumer action)

Description copied from interface: Long2IntMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Long2IntMap

Overrides:

forEach in class AbstractLong2IntMap

Parameters:

action - processor of the values that are iterator over

replace

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

Description copied from interface: Long2IntMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Long2IntMap

Overrides:

replace in class AbstractLong2IntMap

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

Description copied from interface: Long2IntMap

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

Specified by:

replace in interface Long2IntMap

Overrides:

replace in class AbstractLong2IntMap

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(long key,
                      LongIntUnaryOperator mappingFunction)

Description copied from interface: Long2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeInt in interface Long2IntMap

Overrides:

computeInt in class AbstractLong2IntMap

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(long key,
                              Long2IntFunction mappingFunction)

Description copied from interface: Long2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfAbsent in interface Long2IntMap

Overrides:

computeIntIfAbsent in class AbstractLong2IntMap

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

computeIntIfPresent

public int computeIntIfPresent(long key,
                               LongIntUnaryOperator mappingFunction)

Description copied from interface: Long2IntMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIntIfPresent in interface Long2IntMap

Overrides:

computeIntIfPresent in class AbstractLong2IntMap

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

Description copied from interface: Long2IntMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeInt in interface Long2IntMap

Overrides:

mergeInt in class AbstractLong2IntMap

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(Long2IntMap m,
                        IntIntUnaryOperator mappingFunction)

Description copied from interface: Long2IntMap

A Bulk method for merging Maps.

Specified by:

mergeAllInt in interface Long2IntMap

Overrides:

mergeAllInt in class AbstractLong2IntMap

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

Overrides:

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

clear

public void clear()

Specified by:

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

Overrides:

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