Float2FloatAVLTreeMap (Primitive-Collections 0.2.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.tree.Float2FloatAVLTreeMap

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Float>, java.util.NavigableMap<java.lang.Float,java.lang.Float>, java.util.SortedMap<java.lang.Float,java.lang.Float>, Float2FloatFunction, Float2FloatMap, Float2FloatNavigableMap, Float2FloatSortedMap
```
public class Float2FloatAVLTreeMap
extends AbstractFloat2FloatMap
implements Float2FloatNavigableMap
```
A Simple Type Specific AVL TreeMap implementation that reduces boxing/unboxing. It is using a bit more memory then FastUtil, but it saves a lot of Performance on the Optimized removal and iteration logic. Which makes the implementation actually useable and does not get outperformed by Javas default implementation.

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.Float2FloatSortedMap
  Float2FloatSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2FloatMap
  Float2FloatMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Float2FloatAVLTreeMap()` Default Constructor
`Float2FloatAVLTreeMap(float[] keys, float[] values)` Helper constructor that allow to create a map from unboxed values
`Float2FloatAVLTreeMap(java.lang.Float[] keys, java.lang.Float[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Float2FloatAVLTreeMap(float[] keys, float[] values, FloatComparator comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Float2FloatAVLTreeMap(java.lang.Float[] keys, java.lang.Float[] values, FloatComparator comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
`Float2FloatAVLTreeMap(Float2FloatMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Float2FloatAVLTreeMap(Float2FloatMap map, FloatComparator comp)` A Type Specific Helper function that has a custom sorter and allows to create a new Map with exactly the same values as the provided map.
`Float2FloatAVLTreeMap(FloatComparator comp)` Constructor that allows to define the sorter
`Float2FloatAVLTreeMap(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.
`Float2FloatAVLTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> map, FloatComparator comp)` A Helper constructor that has a custom sorter and allows to create a Map with exactly the same values as the provided map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`addTo(float key, float value)` A Helper method to add a primitives together.
`Float2FloatMap.Entry`	`ceilingEntry(float key)` A Type Specific ceilingEntry method to reduce boxing/unboxing.
`float`	`ceilingKey(float e)` A Type Specific ceilingKey method to reduce boxing/unboxing.
`void`	`clear()`
`FloatComparator`	`comparator()`
`float`	`computeFloat(float key, FloatFloatUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`float`	`computeFloatIfAbsent(float key, Float2FloatFunction 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
`FloatNavigableSet`	`descendingKeySet()`
`Float2FloatNavigableMap`	`descendingMap()`
`Float2FloatMap.Entry`	`firstEntry()`
`float`	`firstFloatKey()` A method to get the first Key of a Map.
`float`	`firstFloatValue()` A method to get the first Value of a Map.
`ObjectSet<Float2FloatMap.Entry>`	`float2FloatEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Float2FloatMap.Entry`	`floorEntry(float key)` A Type Specific floorEntry method to reduce boxing/unboxing.
`float`	`floorKey(float e)` A Type Specific floorKey method to reduce boxing/unboxing.
`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`	`getDefaultMaxValue()` A Helper method to get the max value for SubMaps.
`float`	`getDefaultMinValue()` A Helper method to get the min value for SubMaps.
`float`	`getFloat(float key)` A Type Specific get method to reduce boxing/unboxing
`float`	`getOrDefault(float key, float defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Float2FloatNavigableMap`	`headMap(float toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Float2FloatMap.Entry`	`higherEntry(float key)` A Type Specific higherEntry method to reduce boxing/unboxing.
`float`	`higherKey(float e)` A Type Specific higherKey method to reduce boxing/unboxing.
`FloatSortedSet`	`keySet()`
`Float2FloatMap.Entry`	`lastEntry()`
`float`	`lastFloatKey()` A method to get the last Key of a Map.
`float`	`lastFloatValue()` A method to get the last Value of a Map.
`Float2FloatMap.Entry`	`lowerEntry(float key)` A Type Specific lowerEntry method to reduce boxing/unboxing.
`float`	`lowerKey(float e)` A Type Specific lowerKey method to reduce boxing/unboxing.
`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.
`FloatNavigableSet`	`navigableKeySet()`
`Float2FloatMap.Entry`	`pollFirstEntry()`
`float`	`pollFirstFloatKey()` A method to get and remove the first Key of a Map.
`Float2FloatMap.Entry`	`pollLastEntry()`
`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`	`remFloat(float key)` Type Specific remove function to reduce boxing/unboxing
`float`	`remFloatOrDefault(float key, float defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(float key, float value)` Type Specific remove function to reduce boxing/unboxing
`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
`void`	`setDefaultMaxValue(float value)` A Helper method to set the max value for SubMaps.
`void`	`setDefaultMinValue(float value)` A Helper method to set the min value for SubMaps.
`int`	`size()`
`Float2FloatNavigableMap`	`subMap(float fromKey, boolean fromInclusive, float toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`Float2FloatNavigableMap`	`tailMap(float fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`FloatCollection`	`values()`

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2FloatMap
addToAll, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceFloats, replaceFloats, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
containsKey, containsValue, isEmpty, put, remove, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2FloatNavigableMap
ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, subMap, tailMap, tailMap, tailMap

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2FloatSortedMap
firstKey, lastKey

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

Methods inherited from interface java.util.SortedMap
entrySet

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

- Constructor Detail
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap()
```
    Default Constructor
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(FloatComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(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
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(java.lang.Float[] keys,
                             java.lang.Float[] values,
                             FloatComparator comp)
```
    Helper constructor that has a custom sorter and 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.
    
    comp - the function that decides how the tree is sorted, can be null
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(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
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(float[] keys,
                             float[] values,
                             FloatComparator comp)
```
    Helper constructor that has a custom sorter and 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.
    
    comp - the function that decides how the tree is sorted, can be null
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(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
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Float> map,
                             FloatComparator comp)
```
    A Helper constructor that has a custom sorter and 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
    
    comp - the function that decides how the tree is sorted, can be null
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(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
  - Float2FloatAVLTreeMap
```
public Float2FloatAVLTreeMap(Float2FloatMap map,
                             FloatComparator comp)
```
    A Type Specific Helper function that has a custom sorter and 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
    
    comp - the function that decides how the tree is sorted, can be null
- Method Detail
  - setDefaultMaxValue
```
public void setDefaultMaxValue(float value)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Helper method to set the max value for SubMaps. (Default: float.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface Float2FloatNavigableMap
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public float getDefaultMaxValue()
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Helper method to get the max value for SubMaps.
    
    Specified by:
    
    getDefaultMaxValue in interface Float2FloatNavigableMap
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(float value)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Helper method to set the min value for SubMaps. (Default: float.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface Float2FloatNavigableMap
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public float getDefaultMinValue()
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Helper method to get the min value for SubMaps.
    
    Specified by:
    
    getDefaultMinValue in interface Float2FloatNavigableMap
    
    Returns:
    
    the default min value.
  - 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.
  - putAndMoveToFirst
```
public float putAndMoveToFirst(float key,
                               float value)
```
    Description copied from interface: Float2FloatSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Float2FloatSortedMap
    
    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: Float2FloatSortedMap
    
    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 Float2FloatSortedMap
    
    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: Float2FloatSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Float2FloatSortedMap
    
    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: Float2FloatSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Float2FloatSortedMap
    
    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: Float2FloatSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Float2FloatSortedMap
    
    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: Float2FloatSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Float2FloatSortedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public FloatComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    comparator in interface Float2FloatSortedMap
  - 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
  - getFloat
```
public float getFloat(float key)
```
    Description copied from interface: Float2FloatMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getFloat in interface Float2FloatFunction
    
    Specified by:
    
    getFloat in interface Float2FloatMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - 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: Float2FloatSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstFloatKey in interface Float2FloatSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstFloatKey
```
public float pollFirstFloatKey()
```
    Description copied from interface: Float2FloatSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstFloatKey in interface Float2FloatSortedMap
    
    Returns:
    
    the first key in the map
  - lastFloatKey
```
public float lastFloatKey()
```
    Description copied from interface: Float2FloatSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastFloatKey in interface Float2FloatSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastFloatKey
```
public float pollLastFloatKey()
```
    Description copied from interface: Float2FloatSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastFloatKey in interface Float2FloatSortedMap
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Float2FloatMap.Entry firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    firstEntry in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Float2FloatMap.Entry lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    lastEntry in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Float2FloatMap.Entry pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    pollFirstEntry in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Float2FloatMap.Entry pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    pollLastEntry in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstFloatValue
```
public float firstFloatValue()
```
    Description copied from interface: Float2FloatSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstFloatValue in interface Float2FloatSortedMap
    
    Returns:
    
    the first key in the map
  - lastFloatValue
```
public float lastFloatValue()
```
    Description copied from interface: Float2FloatSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastFloatValue in interface Float2FloatSortedMap
    
    Returns:
    
    the last key in the map
  - remFloat
```
public float remFloat(float key)
```
    Description copied from interface: Float2FloatMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remFloat in interface Float2FloatMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remFloatOrDefault
```
public float remFloatOrDefault(float key,
                               float defaultValue)
```
    Description copied from interface: Float2FloatMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    remFloatOrDefault 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
```
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)
  - 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,
                                  Float2FloatFunction 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
  - 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>
  - keySet
```
public FloatSortedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    keySet in interface Float2FloatMap
    
    Specified by:
    
    keySet in interface Float2FloatSortedMap
    
    Overrides:
    
    keySet in class AbstractFloat2FloatMap
  - float2FloatEntrySet
```
public ObjectSet<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
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public FloatCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    values in interface Float2FloatMap
    
    Specified by:
    
    values in interface Float2FloatSortedMap
    
    Overrides:
    
    values in class AbstractFloat2FloatMap
  - navigableKeySet
```
public FloatNavigableSet navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    navigableKeySet in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Float2FloatNavigableMap descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    descendingMap in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public FloatNavigableSet descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<java.lang.Float,java.lang.Float>
    
    Specified by:
    
    descendingKeySet in interface Float2FloatNavigableMap
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Float2FloatNavigableMap subMap(float fromKey,
                                      boolean fromInclusive,
                                      float toKey,
                                      boolean toInclusive)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Float2FloatNavigableMap
    
    Parameters:
    
    fromKey - where the submap should start
    
    fromInclusive - if the fromKey is inclusive or not
    
    toKey - where the subMap should end
    
    toInclusive - if the toKey is inclusive or not
    
    Returns:
    
    a SubMap that is within the range of the desired range
  - headMap
```
public Float2FloatNavigableMap headMap(float toKey,
                                       boolean inclusive)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Float2FloatNavigableMap
    
    Parameters:
    
    toKey - where the HeadMap should end
    
    inclusive - if the toKey is inclusive or not
    
    Returns:
    
    a HeadMap that is within the range of the desired range
  - tailMap
```
public Float2FloatNavigableMap tailMap(float fromKey,
                                       boolean inclusive)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Float2FloatNavigableMap
    
    Parameters:
    
    fromKey - where the TailMap should start
    
    inclusive - if the fromKey is inclusive or not
    
    Returns:
    
    a TailMap that is within the range of the desired range
  - lowerKey
```
public float lowerKey(float e)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific lowerKey method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerKey in interface Float2FloatNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower key that can be found
  - floorKey
```
public float floorKey(float e)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific floorKey method to reduce boxing/unboxing.
    
    Specified by:
    
    floorKey in interface Float2FloatNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the greatest lower or equal key that can be found
  - higherKey
```
public float higherKey(float e)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific higherKey method to reduce boxing/unboxing.
    
    Specified by:
    
    higherKey in interface Float2FloatNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher key that can be found
  - ceilingKey
```
public float ceilingKey(float e)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific ceilingKey method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingKey in interface Float2FloatNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - lowerEntry
```
public Float2FloatMap.Entry lowerEntry(float key)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific lowerEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerEntry in interface Float2FloatNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower entry that can be found, or null
  - higherEntry
```
public Float2FloatMap.Entry higherEntry(float key)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific higherEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    higherEntry in interface Float2FloatNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher entry that can be found, or null
  - floorEntry
```
public Float2FloatMap.Entry floorEntry(float key)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific floorEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    floorEntry in interface Float2FloatNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower or equal entry that can be found, or null
  - ceilingEntry
```
public Float2FloatMap.Entry ceilingEntry(float key)
```
    Description copied from interface: Float2FloatNavigableMap
    
    A Type Specific ceilingEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingEntry in interface Float2FloatNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher or equal entry that can be found, or null

Class Float2FloatAVLTreeMap

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

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

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

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

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Float2FloatAVLTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

addTo

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

containsKey

getFloat

getOrDefault

firstFloatKey

pollFirstFloatKey

lastFloatKey

pollLastFloatKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstFloatValue

lastFloatValue

remFloat

remFloatOrDefault

remove

replace

replace

computeFloat

computeFloatIfAbsent

computeFloatIfPresent

mergeFloat

mergeAllFloat

size

clear

keySet

float2FloatEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey