ImmutableFloat2ShortOpenHashMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Float,java.lang.Short>
- - speiger.src.collections.floats.maps.abstracts.AbstractFloat2ShortMap
  - - speiger.src.collections.floats.maps.impl.immutable.ImmutableFloat2ShortOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Short>, Float2ShortFunction, Float2ShortMap, Float2ShortOrderedMap
```
public class ImmutableFloat2ShortOpenHashMap
extends AbstractFloat2ShortMap
implements Float2ShortOrderedMap
```
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.AbstractFloat2ShortMap
  AbstractFloat2ShortMap.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.Float2ShortOrderedMap
  Float2ShortOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ShortMap
  Float2ShortMap.BuilderCache, Float2ShortMap.Entry, Float2ShortMap.FastEntrySet, Float2ShortMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`ImmutableFloat2ShortOpenHashMap(float[] keys, short[] values)` Helper constructor that allow to create a map from unboxed values
`ImmutableFloat2ShortOpenHashMap(java.lang.Float[] keys, java.lang.Short[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableFloat2ShortOpenHashMap(float[] keys, short[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`ImmutableFloat2ShortOpenHashMap(java.lang.Float[] keys, java.lang.Short[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`ImmutableFloat2ShortOpenHashMap(Float2ShortMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableFloat2ShortOpenHashMap(Float2ShortMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`ImmutableFloat2ShortOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Short> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`ImmutableFloat2ShortOpenHashMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Short> 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
`short`	`addTo(float key, short value)` A Helper method to add a primitives together.
`void`	`clear()`
`short`	`computeShort(float key, FloatShortUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`short`	`computeShortIfAbsent(float key, Float2ShortFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`short`	`computeShortIfPresent(float key, FloatShortUnaryOperator 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(java.lang.Object value)` Deprecated.
`boolean`	`containsValue(short value)` Type Specific method to reduce boxing/unboxing of values
`ImmutableFloat2ShortOpenHashMap`	`copy()` A Function that does a shallow clone of the Map itself.
`float`	`firstFloatKey()` A method to get the first Key of a Map.
`short`	`firstShortValue()` A method to get the first Value of a Map.
`ObjectOrderedSet<Float2ShortMap.Entry>`	`float2ShortEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`void`	`forEach(FloatShortConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`short`	`get(float key)` A Type Specific get method to reduce boxing/unboxing
`java.lang.Short`	`get(java.lang.Object key)`
`short`	`getAndMoveToFirst(float key)` A Specific get method that allows to move teh given key/value int the first index.
`short`	`getAndMoveToLast(float key)` A Specific get method that allows to move teh given key/value int the last index.
`short`	`getOrDefault(float key, short defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`FloatOrderedSet`	`keySet()`
`float`	`lastFloatKey()` A method to get the last Key of a Map.
`short`	`lastShortValue()` A method to get the last Value of a Map.
`void`	`mergeAllShort(Float2ShortMap m, ShortShortUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`short`	`mergeShort(float key, short value, ShortShortUnaryOperator 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.
`short`	`put(float key, short value)` Type Specific method to reduce boxing/unboxing of values
`short`	`putAndMoveToFirst(float key, short value)` A customized put method that allows you to insert into the first index.
`short`	`putAndMoveToLast(float key, short value)` A customized put method that allows you to insert into the last index.
`short`	`putIfAbsent(float key, short value)` Type Specific method to reduce boxing/unboxing of values
`short`	`remove(float key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(float key, short value)` Type Specific remove function to reduce boxing/unboxing
`java.lang.Short`	`remove(java.lang.Object key)` Deprecated.
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`short`	`removeOrDefault(float key, short defaultValue)` Type-Specific Remove function with a default return value if wanted.
`short`	`replace(float key, short value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(float key, short oldValue, short newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`short`	`subFrom(float key, short value)` A Helper method to subtract from primitive from each other.
`short`	`supplyShortIfAbsent(float key, ShortSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`ShortCollection`	`values()`

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

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

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

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

Class ImmutableFloat2ShortOpenHashMap

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Map

Constructor Detail

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

ImmutableFloat2ShortOpenHashMap

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

firstShortValue

lastShortValue

float2ShortEntrySet

keySet

values

copy

forEach

replace

replace

computeShort

computeShortIfAbsent

supplyShortIfAbsent

computeShortIfPresent

mergeShort

mergeAllShort

size

clear