speiger.src.collections.ints.maps.impl.misc

Class Int2IntArrayMap

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.misc.Int2IntArrayMap

All Implemented Interfaces:

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

public class Int2IntArrayMap
extends AbstractInt2IntMap
implements Int2IntSortedMap

A Very Specific Type Specific implementation of a ArrayMap. This type of map is for very specific use cases that usaully would have lead to Tupled Lists otherwise. It also does not allow duplication (except for array constructors) and checks from last to first. It is not designed to be used as a HashMap replacement due to the poor performance it would cause.

Note:

in this implementation SubMaps do NOT keep track of parent changes fully. For performance reasons it will just have a start/end index and not values Anything within that range will be updated appropiatly a shrink/growth of elements will break SubMaps in some ways. This can be useful but be careful, this implementation does not shrink and only grows.

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

Int2IntSortedMap.FastSortedSet

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

Int2IntMap.Entry, Int2IntMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Int2IntArrayMap() Default Constructor
Int2IntArrayMap(int minCapacity) Constructor that defines the minimum capacity
Int2IntArrayMap(int[] keys, int[] values) Helper constructor that allow to create a map from unboxed values
Int2IntArrayMap(int[] keys, int[] values, int length) Helper constructor that allow to create a map from unboxed values
Int2IntArrayMap(Int2IntMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Int2IntArrayMap(java.lang.Integer[] keys, java.lang.Integer[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Int2IntArrayMap(java.lang.Integer[] keys, java.lang.Integer[] values, int length) Helper constructor that allow to create a map from boxed values (it will unbox them) with a custom length
Int2IntArrayMap(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.

Method Summary

Modifier and Type	Method and Description
int	addTo(int key, int value) A Helper method to add a primitives together.
void	clear()
IntComparator	comparator()
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)
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value)
int	firstIntKey() A method to get the first Key of a Map.
int	firstIntValue() A method to get the first Value of a Map.
void	forEach(IntIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
int	getAndMoveToFirst(int key) A Specific get method that allows to move teh given key/value int the first index.
int	getAndMoveToLast(int key) A Specific get method that allows to move teh given key/value int the last index.
int	getInt(int key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(int key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
Int2IntSortedMap	headMap(int toKey) A Type Specific HeadMap method to reduce boxing/unboxing
ObjectSortedSet<Int2IntMap.Entry>	int2IntEntrySet() 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.
int	lastIntValue() A method to get the last Value of a Map.
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
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.
int	put(int key, int value) Type Specific method to reduce boxing/unboxing of values
int	putAndMoveToFirst(int key, int value) A customized put method that allows you to insert into the first index.
int	putAndMoveToLast(int key, int value) A customized put method that allows you to insert into the last index.
int	putIfAbsent(int key, int value) Type Specific method to reduce boxing/unboxing of values
int	remInt(int key) Type Specific remove function to reduce boxing/unboxing
int	remIntOrDefault(int key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
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	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()
Int2IntSortedMap	subMap(int fromKey, int toKey) A Type Specific SubMap method to reduce boxing/unboxing
Int2IntSortedMap	tailMap(int fromKey) A Type Specific TailMap method to reduce boxing/unboxing
IntCollection	values()

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

addToAll, entrySet, equals, get, 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.ints.maps.interfaces.Int2IntSortedMap

firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap

entrySet

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

addToAll, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll

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

Int2IntArrayMap

public Int2IntArrayMap()

Default Constructor

Int2IntArrayMap

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

Int2IntArrayMap

public Int2IntArrayMap(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 length

Int2IntArrayMap

public Int2IntArrayMap(java.lang.Integer[] keys,
                       java.lang.Integer[] values,
                       int length)

Helper constructor that allow to create a map from boxed values (it will unbox them) with a custom length

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

length - the amount of values that should be pulled from the array

Throws:

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

Int2IntArrayMap

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

Int2IntArrayMap

public Int2IntArrayMap(int[] keys,
                       int[] values,
                       int length)

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.

length - the amount of values that should be pulled from the array

Throws:

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

Int2IntArrayMap

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

Int2IntArrayMap

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

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.

putAndMoveToFirst

public int putAndMoveToFirst(int key,
                             int value)

Description copied from interface: Int2IntSortedMap

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

Specified by:

putAndMoveToFirst in interface Int2IntSortedMap

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

Description copied from interface: Int2IntSortedMap

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 Int2IntSortedMap

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

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

Specified by:

moveToFirst in interface Int2IntSortedMap

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

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

Specified by:

moveToLast in interface Int2IntSortedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

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

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

containsKey

public boolean containsKey(java.lang.Object key)

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(java.lang.Object value)

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)

getInt

public int getInt(int key)

Description copied from interface: Int2IntMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

getInt in interface Int2IntFunction

Specified by:

getInt in interface Int2IntMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

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

getAndMoveToFirst

public int getAndMoveToFirst(int key)

Description copied from interface: Int2IntSortedMap

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

Specified by:

getAndMoveToFirst in interface Int2IntSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public int getAndMoveToLast(int key)

Description copied from interface: Int2IntSortedMap

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

Specified by:

getAndMoveToLast in interface Int2IntSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstIntKey

public int firstIntKey()

Description copied from interface: Int2IntSortedMap

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2IntSortedMap

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2IntSortedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2IntSortedMap

Returns:

the last key in the map

firstIntValue

public int firstIntValue()

Description copied from interface: Int2IntSortedMap

A method to get the first Value of a Map.

Specified by:

firstIntValue in interface Int2IntSortedMap

Returns:

the first key in the map

lastIntValue

public int lastIntValue()

Description copied from interface: Int2IntSortedMap

A method to get the last Value of a Map.

Specified by:

lastIntValue in interface Int2IntSortedMap

Returns:

the last key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2IntSortedMap

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

Specified by:

pollFirstIntKey in interface Int2IntSortedMap

Returns:

the first key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2IntSortedMap

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

Specified by:

pollLastIntKey in interface Int2IntSortedMap

Returns:

the last key in the map

remInt

public int remInt(int key)

Description copied from interface: Int2IntMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remInt in interface Int2IntMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remIntOrDefault

public int remIntOrDefault(int key,
                           int defaultValue)

Description copied from interface: Int2IntMap

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

Specified by:

remIntOrDefault 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 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 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 java.util.AbstractMap<java.lang.Integer,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(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)

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

keySet

public IntSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Int2IntMap

Specified by:

keySet in interface Int2IntSortedMap

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

Specified by:

values in interface Int2IntMap

Specified by:

values in interface Int2IntSortedMap

Overrides:

values in class AbstractInt2IntMap

int2IntEntrySet

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

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

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>

comparator

public IntComparator comparator()

Specified by:

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

Specified by:

comparator in interface Int2IntSortedMap

subMap

public Int2IntSortedMap subMap(int fromKey,
                               int toKey)

Description copied from interface: Int2IntSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Int2IntSortedMap

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 Int2IntSortedMap headMap(int toKey)

Description copied from interface: Int2IntSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Int2IntSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Int2IntSortedMap tailMap(int fromKey)

Description copied from interface: Int2IntSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Int2IntSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range