ImmutableFloat2FloatOpenHashMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Float,java.lang.Float>
- - speiger.src.collections.floats.maps.abstracts.AbstractFloat2FloatMap
  - - speiger.src.collections.floats.maps.impl.immutable.ImmutableFloat2FloatOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Float>, FloatUnaryOperator, Float2FloatMap, Float2FloatOrderedMap
```
public class ImmutableFloat2FloatOpenHashMap
extends AbstractFloat2FloatMap
implements Float2FloatOrderedMap
```
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.AbstractFloat2FloatMap
  AbstractFloat2FloatMap.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.Float2FloatOrderedMap
  Float2FloatOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2FloatMap
  Float2FloatMap.BuilderCache, Float2FloatMap.Entry, Float2FloatMap.FastEntrySet, Float2FloatMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`ImmutableFloat2FloatOpenHashMap(float[] keys, float[] values)` Helper constructor that allow to create a map from unboxed values
`ImmutableFloat2FloatOpenHashMap(java.lang.Float[] keys, java.lang.Float[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableFloat2FloatOpenHashMap(float[] keys, float[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`ImmutableFloat2FloatOpenHashMap(java.lang.Float[] keys, java.lang.Float[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableFloat2FloatOpenHashMap(Float2FloatMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableFloat2FloatOpenHashMap(Float2FloatMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableFloat2FloatOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`ImmutableFloat2FloatOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> 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
`float`	`addTo(float key, float value)` A Helper method to add a primitives together.
`void`	`clear()`
`float`	`computeFloat(float key, FloatFloatUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`float`	`computeFloatIfAbsent(float key, FloatUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`float`	`computeFloatIfPresent(float key, FloatFloatUnaryOperator 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(float value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`containsValue(java.lang.Object value)` Deprecated.
`ImmutableFloat2FloatOpenHashMap`	`copy()` A Function that does a shallow clone of the Map itself.
`float`	`firstFloatKey()` A method to get the first Key of a Map.
`float`	`firstFloatValue()` A method to get the first Value of a Map.
`ObjectOrderedSet<Float2FloatMap.Entry>`	`float2FloatEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`forEach(FloatFloatConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`float`	`get(float key)` A Type Specific get method to reduce boxing/unboxing
`java.lang.Float`	`get(java.lang.Object key)`
`float`	`getAndMoveToFirst(float key)` A Specific get method that allows to move teh given key/value int the first index.
`float`	`getAndMoveToLast(float key)` A Specific get method that allows to move teh given key/value int the last index.
`float`	`getOrDefault(float key, float defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`FloatOrderedSet`	`keySet()`
`float`	`lastFloatKey()` A method to get the last Key of a Map.
`float`	`lastFloatValue()` A method to get the last Value of a Map.
`void`	`mergeAllFloat(Float2FloatMap m, FloatFloatUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`float`	`mergeFloat(float key, float value, FloatFloatUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`boolean`	`moveToFirst(float key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(float key)` A specific move method to move a given key/value to the last index.
`float`	`pollFirstFloatKey()` A method to get and remove the first Key of a Map.
`float`	`pollLastFloatKey()` A method to get and remove the last Key of a Map.
`float`	`put(float key, float value)` Type Specific method to reduce boxing/unboxing of values
`float`	`putAndMoveToFirst(float key, float value)` A customized put method that allows you to insert into the first index.
`float`	`putAndMoveToLast(float key, float value)` A customized put method that allows you to insert into the last index.
`float`	`putIfAbsent(float key, float value)` Type Specific method to reduce boxing/unboxing of values
`float`	`remove(float key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(float key, float value)` Type Specific remove function to reduce boxing/unboxing
`java.lang.Float`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`float`	`removeOrDefault(float key, float defaultValue)` Type-Specific Remove function with a default return value if wanted.
`float`	`replace(float key, float value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(float key, float oldValue, float newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`float`	`subFrom(float key, float value)` A Helper method to subtract from primitive from each other.
`float`	`supplyFloatIfAbsent(float key, FloatSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`FloatCollection`	`values()`

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2FloatMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceFloats, replaceFloats, 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.floats.maps.interfaces.Float2FloatOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2FloatMap
addToAll, applyAsFloat, builder, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, getDefaultReturnValue, getOrDefault, merge, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, replace, replace, replaceAll, replaceFloats, replaceFloats, setDefaultReturnValue

Methods inherited from interface java.util.Map
equals, hashCode, isEmpty, putAll

Methods inherited from interface speiger.src.collections.floats.functions.function.FloatUnaryOperator
andThen, compose, identity

- Constructor Detail
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(java.lang.Float[] keys,
                                       java.lang.Float[] 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(java.lang.Float[] keys,
                                       java.lang.Float[] 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(float[] keys,
                                       float[] 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(float[] keys,
                                       float[] 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(Float2FloatMap 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
  - ImmutableFloat2FloatOpenHashMap
```
public ImmutableFloat2FloatOpenHashMap(Float2FloatMap 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 float put(float key,
                 float value)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Float2FloatMap
    
    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 float putIfAbsent(float key,
                         float value)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Float2FloatMap
    
    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 float addTo(float key,
                   float value)
```
    Description copied from interface: Float2FloatMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Float2FloatMap
    
    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 float subFrom(float key,
                     float value)
```
    Description copied from interface: Float2FloatMap
    
    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 Float2FloatMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Float2FloatMap
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - putAndMoveToFirst
```
public float putAndMoveToFirst(float key,
                               float value)
```
    Description copied from interface: Float2FloatOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Float2FloatOrderedMap
    
    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 float putAndMoveToLast(float key,
                              float value)
```
    Description copied from interface: Float2FloatOrderedMap
    
    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 Float2FloatOrderedMap
    
    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(float key)
```
    Description copied from interface: Float2FloatOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Float2FloatOrderedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(float key)
```
    Description copied from interface: Float2FloatOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Float2FloatOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public float getAndMoveToFirst(float key)
```
    Description copied from interface: Float2FloatOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Float2FloatOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public float getAndMoveToLast(float key)
```
    Description copied from interface: Float2FloatOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Float2FloatOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - containsKey
```
public boolean containsKey(float key)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Float2FloatMap
    
    Overrides:
    
    containsKey in class AbstractFloat2FloatMap
    
    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.Float>
    
    Specified by:
    
    containsKey in interface Float2FloatMap
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Float,java.lang.Float>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(float value)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Float2FloatMap
    
    Overrides:
    
    containsValue in class AbstractFloat2FloatMap
    
    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.Float>
    
    Specified by:
    
    containsValue in interface Float2FloatMap
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Float,java.lang.Float>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
  - remove
```
public float remove(float key)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2FloatMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public float removeOrDefault(float key,
                             float defaultValue)
```
    Description copied from interface: Float2FloatMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    removeOrDefault in interface Float2FloatMap
    
    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.Float remove(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    remove in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    remove in interface Float2FloatMap
    
    Overrides:
    
    remove in class AbstractFloat2FloatMap
    
    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,
                      float value)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2FloatMap
    
    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.Float,java.lang.Float>
    
    Specified by:
    
    remove in interface Float2FloatMap
    
    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 float get(float key)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Float2FloatMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - get
```
public java.lang.Float get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    get in interface Float2FloatMap
    
    Overrides:
    
    get in class AbstractFloat2FloatMap
  - getOrDefault
```
public float getOrDefault(float key,
                          float defaultValue)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Float2FloatMap
    
    Overrides:
    
    getOrDefault in class AbstractFloat2FloatMap
    
    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
  - firstFloatKey
```
public float firstFloatKey()
```
    Description copied from interface: Float2FloatOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstFloatKey in interface Float2FloatOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstFloatKey
```
public float pollFirstFloatKey()
```
    Description copied from interface: Float2FloatOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstFloatKey in interface Float2FloatOrderedMap
    
    Returns:
    
    the first key in the map
  - lastFloatKey
```
public float lastFloatKey()
```
    Description copied from interface: Float2FloatOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastFloatKey in interface Float2FloatOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastFloatKey
```
public float pollLastFloatKey()
```
    Description copied from interface: Float2FloatOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastFloatKey in interface Float2FloatOrderedMap
    
    Returns:
    
    the last key in the map
  - firstFloatValue
```
public float firstFloatValue()
```
    Description copied from interface: Float2FloatOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstFloatValue in interface Float2FloatOrderedMap
    
    Returns:
    
    the first key in the map
  - lastFloatValue
```
public float lastFloatValue()
```
    Description copied from interface: Float2FloatOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastFloatValue in interface Float2FloatOrderedMap
    
    Returns:
    
    the last key in the map
  - float2FloatEntrySet
```
public ObjectOrderedSet<Float2FloatMap.Entry> float2FloatEntrySet()
```
    Description copied from interface: Float2FloatMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    float2FloatEntrySet in interface Float2FloatMap
    
    Specified by:
    
    float2FloatEntrySet in interface Float2FloatOrderedMap
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public FloatOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    keySet in interface Float2FloatMap
    
    Specified by:
    
    keySet in interface Float2FloatOrderedMap
    
    Overrides:
    
    keySet in class AbstractFloat2FloatMap
  - values
```
public FloatCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    values in interface Float2FloatMap
    
    Overrides:
    
    values in class AbstractFloat2FloatMap
  - copy
```
public ImmutableFloat2FloatOpenHashMap copy()
```
    Description copied from interface: Float2FloatMap
    
    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 Float2FloatMap
    
    Specified by:
    
    copy in interface Float2FloatOrderedMap
    
    Overrides:
    
    copy in class AbstractFloat2FloatMap
    
    Returns:
    
    a Shallow Copy of the Map
  - forEach
```
public void forEach(FloatFloatConsumer action)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Float2FloatMap
    
    Overrides:
    
    forEach in class AbstractFloat2FloatMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(float key,
                       float oldValue,
                       float newValue)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Float2FloatMap
    
    Overrides:
    
    replace in class AbstractFloat2FloatMap
    
    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(float key,
                     float value)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Float2FloatMap
    
    Overrides:
    
    replace in class AbstractFloat2FloatMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeFloat
```
public float computeFloat(float key,
                          FloatFloatUnaryOperator mappingFunction)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeFloat in interface Float2FloatMap
    
    Overrides:
    
    computeFloat in class AbstractFloat2FloatMap
    
    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(float key,
                                  FloatUnaryOperator mappingFunction)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeFloatIfAbsent in interface Float2FloatMap
    
    Overrides:
    
    computeFloatIfAbsent in class AbstractFloat2FloatMap
    
    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(float key,
                                 FloatSupplier valueProvider)
```
    Description copied from interface: Float2FloatMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyFloatIfAbsent in interface Float2FloatMap
    
    Overrides:
    
    supplyFloatIfAbsent in class AbstractFloat2FloatMap
    
    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(float key,
                                   FloatFloatUnaryOperator mappingFunction)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeFloatIfPresent in interface Float2FloatMap
    
    Overrides:
    
    computeFloatIfPresent in class AbstractFloat2FloatMap
    
    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(float key,
                        float value,
                        FloatFloatUnaryOperator mappingFunction)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeFloat in interface Float2FloatMap
    
    Overrides:
    
    mergeFloat in class AbstractFloat2FloatMap
    
    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(Float2FloatMap m,
                          FloatFloatUnaryOperator mappingFunction)
```
    Description copied from interface: Float2FloatMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllFloat in interface Float2FloatMap
    
    Overrides:
    
    mergeAllFloat in class AbstractFloat2FloatMap
    
    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.Float>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Float,java.lang.Float>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Float,java.lang.Float>

Class ImmutableFloat2FloatOpenHashMap

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.floats.functions.function.FloatUnaryOperator

Constructor Detail

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

ImmutableFloat2FloatOpenHashMap

Method Detail

put

putIfAbsent

addTo

subFrom

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

containsKey

containsKey

containsValue

containsValue

remove

removeOrDefault

remove

remove

remove

get

get

getOrDefault

firstFloatKey

pollFirstFloatKey

lastFloatKey

pollLastFloatKey

firstFloatValue

lastFloatValue

float2FloatEntrySet

keySet

values

copy

forEach

replace

replace

computeFloat

computeFloatIfAbsent

supplyFloatIfAbsent

computeFloatIfPresent

mergeFloat

mergeAllFloat

size

clear