Float2IntOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Float,java.lang.Integer>
- - speiger.src.collections.floats.maps.abstracts.AbstractFloat2IntMap
  - - speiger.src.collections.floats.maps.impl.hash.Float2IntOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Integer>, Float2IntFunction, Float2IntMap

Direct Known Subclasses:

Float2IntLinkedOpenHashMap
```
public class Float2IntOpenHashMap
extends AbstractFloat2IntMap
```
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.floats.maps.abstracts.AbstractFloat2IntMap
  AbstractFloat2IntMap.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.floats.maps.interfaces.Float2IntMap
  Float2IntMap.Entry, Float2IntMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Float2IntOpenHashMap()` Default Constructor
`Float2IntOpenHashMap(float[] keys, int[] values)` Helper constructor that allow to create a map from unboxed values
`Float2IntOpenHashMap(float[] keys, int[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Float2IntOpenHashMap(java.lang.Float[] keys, java.lang.Integer[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Float2IntOpenHashMap(java.lang.Float[] keys, java.lang.Integer[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Float2IntOpenHashMap(Float2IntMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Float2IntOpenHashMap(Float2IntMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Float2IntOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Float2IntOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Float2IntOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Integer> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Float2IntOpenHashMap(java.util.Map<? extends java.lang.Float,? 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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addTo(float key, int value)` A Helper method to add a primitives together.
`void`	`clear()`
`int`	`computeInt(float key, FloatIntUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfAbsent(float key, Float2IntFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfPresent(float key, FloatIntUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(float 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.
`ObjectSet<Float2IntMap.Entry>`	`float2IntEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`forEach(FloatIntConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Integer`	`get(java.lang.Object key)`
`int`	`getInt(float key)` A Type Specific get method to reduce boxing/unboxing
`int`	`getOrDefault(float key, int defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`FloatSet`	`keySet()`
`void`	`mergeAllInt(Float2IntMap m, IntIntUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`int`	`mergeInt(float key, int value, IntIntUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`int`	`put(float key, int value)` Type Specific method to reduce boxing/unboxing of values
`int`	`putIfAbsent(float key, int value)` Type Specific method to reduce boxing/unboxing of values
`int`	`remFloat(float key)` Type Specific remove function to reduce boxing/unboxing
`int`	`remFloatOrDefault(float key, int defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(float 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(float key, int value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(float 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.floats.maps.abstracts.AbstractFloat2IntMap
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.floats.maps.interfaces.Float2IntMap
compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map
isEmpty

- Constructor Detail
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap()
```
    Default Constructor
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(java.lang.Float[] 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(java.lang.Float[] 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(float[] 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(float[] 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(java.util.Map<? extends java.lang.Float,? 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(java.util.Map<? extends java.lang.Float,? 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(Float2IntMap 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
  - Float2IntOpenHashMap
```
public Float2IntOpenHashMap(Float2IntMap 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(float key,
               int value)
```
    Description copied from interface: Float2IntMap
    
    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(float key,
                       int value)
```
    Description copied from interface: Float2IntMap
    
    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(float key,
                 int value)
```
    Description copied from interface: Float2IntMap
    
    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(float key)
```
    Description copied from interface: Float2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Float2IntMap
    
    Overrides:
    
    containsKey in class AbstractFloat2IntMap
    
    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.Float,java.lang.Integer>
    
    Specified by:
    
    containsKey in interface Float2IntMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Float,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: Float2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Float2IntMap
    
    Overrides:
    
    containsValue in class AbstractFloat2IntMap
    
    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.Float,java.lang.Integer>
    
    Specified by:
    
    containsValue in interface Float2IntMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Float,java.lang.Integer>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - remFloat
```
public int remFloat(float key)
```
    Description copied from interface: Float2IntMap
    
    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
  - remFloatOrDefault
```
public int remFloatOrDefault(float key,
                             int defaultValue)
```
    Description copied from interface: Float2IntMap
    
    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.Float,java.lang.Integer>
    
    Specified by:
    
    remove in interface Float2IntMap
    
    Overrides:
    
    remove in class java.util.AbstractMap<java.lang.Float,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(float key,
                      int value)
```
    Description copied from interface: Float2IntMap
    
    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(float key)
```
    Description copied from interface: Float2IntMap
    
    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.Float,java.lang.Integer>
    
    Specified by:
    
    get in interface Float2IntMap
    
    Overrides:
    
    get in class AbstractFloat2IntMap
  - getOrDefault
```
public int getOrDefault(float key,
                        int defaultValue)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Float2IntMap
    
    Overrides:
    
    getOrDefault in class AbstractFloat2IntMap
    
    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
  - float2IntEntrySet
```
public ObjectSet<Float2IntMap.Entry> float2IntEntrySet()
```
    Description copied from interface: Float2IntMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public FloatSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    keySet in interface Float2IntMap
    
    Overrides:
    
    keySet in class AbstractFloat2IntMap
  - values
```
public IntCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    values in interface Float2IntMap
    
    Overrides:
    
    values in class AbstractFloat2IntMap
  - forEach
```
public void forEach(FloatIntConsumer action)
```
    Description copied from interface: Float2IntMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Float2IntMap
    
    Overrides:
    
    forEach in class AbstractFloat2IntMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(float key,
                       int oldValue,
                       int newValue)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Float2IntMap
    
    Overrides:
    
    replace in class AbstractFloat2IntMap
    
    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(float key,
                   int value)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Float2IntMap
    
    Overrides:
    
    replace in class AbstractFloat2IntMap
    
    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(float key,
                      FloatIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeInt in interface Float2IntMap
    
    Overrides:
    
    computeInt in class AbstractFloat2IntMap
    
    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(float key,
                              Float2IntFunction mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfAbsent in interface Float2IntMap
    
    Overrides:
    
    computeIntIfAbsent in class AbstractFloat2IntMap
    
    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(float key,
                               FloatIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfPresent in interface Float2IntMap
    
    Overrides:
    
    computeIntIfPresent in class AbstractFloat2IntMap
    
    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(float key,
                    int value,
                    IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeInt in interface Float2IntMap
    
    Overrides:
    
    mergeInt in class AbstractFloat2IntMap
    
    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(Float2IntMap m,
                        IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllInt in interface Float2IntMap
    
    Overrides:
    
    mergeAllInt in class AbstractFloat2IntMap
    
    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.Float,java.lang.Integer>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Float,java.lang.Integer>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Float,java.lang.Integer>

Class Float2IntOpenHashMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2IntMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2IntMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2IntMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2IntMap

Methods inherited from interface java.util.Map

Constructor Detail

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Float2IntOpenHashMap

Method Detail

put

putIfAbsent

addTo

containsKey

containsKey

containsValue

containsValue

remFloat

remFloatOrDefault

remove

remove

remove

getInt

get

getOrDefault

float2IntEntrySet

keySet

values

forEach

replace

replace

computeInt

computeIntIfAbsent

computeIntIfPresent

mergeInt

mergeAllInt

size

clear