speiger.src.collections.ints.maps.abstracts

Class AbstractInt2FloatMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2FloatMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Float>, Int2FloatFunction, Int2FloatMap

Direct Known Subclasses:

ImmutableInt2FloatOpenHashMap, Int2FloatArrayMap, Int2FloatAVLTreeMap, Int2FloatConcurrentOpenHashMap, Int2FloatMaps.EmptyMap, Int2FloatMaps.SingletonMap, Int2FloatMaps.SynchronizedMap, Int2FloatMaps.UnmodifyableMap, Int2FloatOpenCustomHashMap, Int2FloatOpenHashMap, Int2FloatRBTreeMap

public abstract class AbstractInt2FloatMap
extends java.util.AbstractMap<java.lang.Integer,java.lang.Float>
implements Int2FloatMap

A Base Implementation of a Type Specific Map to reduce boxing/unboxing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractInt2FloatMap.BasicEntry A Simple Type Specific Entry class to reduce boxing/unboxing

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

Int2FloatMap.BuilderCache, Int2FloatMap.Entry, Int2FloatMap.FastEntrySet, Int2FloatMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractInt2FloatMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Int2FloatMap m) A Helper method to bulk add primitives together.
float	computeFloat(int key, IntFloatUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
float	computeFloatIfAbsent(int key, Int2FloatFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
float	computeFloatIfPresent(int key, IntFloatUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(int key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(float value) Type Specific method to reduce boxing/unboxing of values
Int2FloatMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Integer,java.lang.Float>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(IntFloatConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Float	get(java.lang.Object key)
float	getDefaultReturnValue() Method to see what the default return value is.
float	getOrDefault(int key, float defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
java.lang.Float	getOrDefault(java.lang.Object key, java.lang.Float defaultValue)
int	hashCode()
IntSet	keySet()
void	mergeAllFloat(Int2FloatMap m, FloatFloatUnaryOperator mappingFunction) A Bulk method for merging Maps.
float	mergeFloat(int key, float value, FloatFloatUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Float	put(java.lang.Integer key, java.lang.Float value) Deprecated.
void	putAll(int[] keys, float[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(Int2FloatMap m) Type Specific function for the bull putting of values
void	putAll(java.lang.Integer[] keys, java.lang.Float[] values, int offset, int size) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Float> m)
void	putAllIfAbsent(Int2FloatMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Float	remove(java.lang.Object key)
float	replace(int key, float value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(int key, float oldValue, float newValue) A Type Specific replace method to replace an existing value
void	replaceFloats(Int2FloatMap m) Type-Specific bulk replace method.
void	replaceFloats(IntFloatUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractInt2FloatMap	setDefaultReturnValue(float v) Method to define the default return value if a requested key isn't present
float	supplyFloatIfAbsent(int key, FloatSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
FloatCollection	values()

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

addTo, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, int2FloatEntrySet, merge, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractInt2FloatMap

public AbstractInt2FloatMap()

Method Detail

getDefaultReturnValue

public float getDefaultReturnValue()

Description copied from interface: Int2FloatMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Int2FloatMap

Returns:

default return value

setDefaultReturnValue

public AbstractInt2FloatMap setDefaultReturnValue(float v)

Description copied from interface: Int2FloatMap

Method to define the default return value if a requested key isn't present

Specified by:

setDefaultReturnValue in interface Int2FloatMap

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Int2FloatMap copy()

Description copied from interface: Int2FloatMap

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 Int2FloatMap

Returns:

a Shallow Copy of the Map

put

@Deprecated
public java.lang.Float put(java.lang.Integer key,
                                        java.lang.Float value)

Deprecated.

Specified by:

put in interface java.util.Map<java.lang.Integer,java.lang.Float>

Specified by:

put in interface Int2FloatMap

Overrides:

put in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

addToAll

public void addToAll(Int2FloatMap m)

Description copied from interface: Int2FloatMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Int2FloatMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Int2FloatMap m)

Description copied from interface: Int2FloatMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Int2FloatMap

Parameters:

m - the elements that should be inserted

putAll

public void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Float> m)

Specified by:

putAll in interface java.util.Map<java.lang.Integer,java.lang.Float>

Overrides:

putAll in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

putAll

public void putAll(int[] keys,
                   float[] values,
                   int offset,
                   int size)

Description copied from interface: Int2FloatMap

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Specified by:

putAll in interface Int2FloatMap

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

See Also:

Map.putAll(Map)

putAll

public void putAll(java.lang.Integer[] keys,
                   java.lang.Float[] values,
                   int offset,
                   int size)

Description copied from interface: Int2FloatMap

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Specified by:

putAll in interface Int2FloatMap

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

See Also:

Map.putAll(Map)

putAllIfAbsent

public void putAllIfAbsent(Int2FloatMap m)

Description copied from interface: Int2FloatMap

Type-Specific bulk put method put elements into the map if not present.

Specified by:

putAllIfAbsent in interface Int2FloatMap

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(int key)

Description copied from interface: Int2FloatMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Int2FloatMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(float value)

Description copied from interface: Int2FloatMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Int2FloatMap

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Int2FloatMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Int2FloatMap

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

Description copied from interface: Int2FloatMap

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

Specified by:

replace in interface Int2FloatMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceFloats

public void replaceFloats(Int2FloatMap m)

Description copied from interface: Int2FloatMap

Type-Specific bulk replace method. Could be seen as putAllIfPresent

Specified by:

replaceFloats in interface Int2FloatMap

Parameters:

m - elements that should be replaced.

replaceFloats

public void replaceFloats(IntFloatUnaryOperator mappingFunction)

Description copied from interface: Int2FloatMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceFloats in interface Int2FloatMap

Parameters:

mappingFunction - operation to replace all values

computeFloat

public float computeFloat(int key,
                          IntFloatUnaryOperator mappingFunction)

Description copied from interface: Int2FloatMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeFloat in interface Int2FloatMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeFloatIfAbsent

public float computeFloatIfAbsent(int key,
                                  Int2FloatFunction mappingFunction)

Description copied from interface: Int2FloatMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeFloatIfAbsent in interface Int2FloatMap

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

supplyFloatIfAbsent

public float supplyFloatIfAbsent(int key,
                                 FloatSupplier valueProvider)

Description copied from interface: Int2FloatMap

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

Specified by:

supplyFloatIfAbsent in interface Int2FloatMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeFloatIfPresent

public float computeFloatIfPresent(int key,
                                   IntFloatUnaryOperator mappingFunction)

Description copied from interface: Int2FloatMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeFloatIfPresent in interface Int2FloatMap

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

mergeFloat

public float mergeFloat(int key,
                        float value,
                        FloatFloatUnaryOperator mappingFunction)

Description copied from interface: Int2FloatMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeFloat in interface Int2FloatMap

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

mergeAllFloat

public void mergeAllFloat(Int2FloatMap m,
                          FloatFloatUnaryOperator mappingFunction)

Description copied from interface: Int2FloatMap

A Bulk method for merging Maps.

Specified by:

mergeAllFloat in interface Int2FloatMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

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

Specified by:

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

Specified by:

get in interface Int2FloatMap

Overrides:

get in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

getOrDefault

public java.lang.Float getOrDefault(java.lang.Object key,
                                    java.lang.Float defaultValue)

Specified by:

getOrDefault in interface java.util.Map<java.lang.Integer,java.lang.Float>

Specified by:

getOrDefault in interface Int2FloatMap

getOrDefault

public float getOrDefault(int key,
                          float defaultValue)

Description copied from interface: Int2FloatMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2FloatMap

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

remove

public java.lang.Float remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface Int2FloatMap

Overrides:

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

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

forEach

public void forEach(IntFloatConsumer action)

Description copied from interface: Int2FloatMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Int2FloatMap

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

Specified by:

keySet in interface Int2FloatMap

Overrides:

keySet in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

values

public FloatCollection values()

Specified by:

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

Specified by:

values in interface Int2FloatMap

Overrides:

values in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Integer,java.lang.Float>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.Integer,java.lang.Float>

Specified by:

entrySet in interface Int2FloatMap

Specified by:

entrySet in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<java.lang.Integer,java.lang.Float>

Overrides:

equals in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.Integer,java.lang.Float>

Overrides:

hashCode in class java.util.AbstractMap<java.lang.Integer,java.lang.Float>