Float2IntRBTreeMap (Primitive-Collections 0.2.0 API)

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

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Integer>, java.util.NavigableMap<java.lang.Float,java.lang.Integer>, java.util.SortedMap<java.lang.Float,java.lang.Integer>, Float2IntFunction, Float2IntMap, Float2IntNavigableMap, Float2IntSortedMap
```
public class Float2IntRBTreeMap
extends AbstractFloat2IntMap
implements Float2IntNavigableMap
```
A Simple Type Specific RB 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.AbstractFloat2IntMap
  AbstractFloat2IntMap.BasicEntry
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2IntSortedMap
  Float2IntSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2IntMap
  Float2IntMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Float2IntRBTreeMap()` Default Constructor
`Float2IntRBTreeMap(float[] keys, int[] values)` Helper constructor that allow to create a map from unboxed values
`Float2IntRBTreeMap(float[] keys, int[] values, FloatComparator comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Float2IntRBTreeMap(java.lang.Float[] keys, java.lang.Integer[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Float2IntRBTreeMap(java.lang.Float[] keys, java.lang.Integer[] values, FloatComparator comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
`Float2IntRBTreeMap(Float2IntMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Float2IntRBTreeMap(Float2IntMap 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.
`Float2IntRBTreeMap(FloatComparator comp)` Constructor that allows to define the sorter
`Float2IntRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Integer> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Float2IntRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Integer> 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
`int`	`addTo(float key, int value)` A Helper method to add a primitives together.
`Float2IntMap.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()`
`int`	`computeInt(float key, FloatIntUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfAbsent(float key, Float2IntFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfPresent(float key, FloatIntUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(float key)` Type Specific method to reduce boxing/unboxing of values
`FloatNavigableSet`	`descendingKeySet()`
`Float2IntNavigableMap`	`descendingMap()`
`Float2IntMap.Entry`	`firstEntry()`
`float`	`firstFloatKey()` A method to get the first Key of a Map.
`int`	`firstIntValue()` A method to get the first Value of a Map.
`ObjectSet<Float2IntMap.Entry>`	`float2IntEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Float2IntMap.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.
`int`	`getAndMoveToFirst(float key)` A Specific get method that allows to move teh given key/value int the first index.
`int`	`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.
`int`	`getInt(float key)` A Type Specific get method to reduce boxing/unboxing
`int`	`getOrDefault(float key, int defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Float2IntNavigableMap`	`headMap(float toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Float2IntMap.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()`
`Float2IntMap.Entry`	`lastEntry()`
`float`	`lastFloatKey()` A method to get the last Key of a Map.
`int`	`lastIntValue()` A method to get the last Value of a Map.
`Float2IntMap.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`	`mergeAllInt(Float2IntMap m, IntIntUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`int`	`mergeInt(float key, int value, IntIntUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`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()`
`Float2IntMap.Entry`	`pollFirstEntry()`
`float`	`pollFirstFloatKey()` A method to get and remove the first Key of a Map.
`Float2IntMap.Entry`	`pollLastEntry()`
`float`	`pollLastFloatKey()` A method to get and remove the last Key of a Map.
`int`	`put(float key, int value)` Type Specific method to reduce boxing/unboxing of values
`int`	`putAndMoveToFirst(float key, int value)` A customized put method that allows you to insert into the first index.
`int`	`putAndMoveToLast(float key, int value)` A customized put method that allows you to insert into the last index.
`int`	`putIfAbsent(float key, int value)` Type Specific method to reduce boxing/unboxing of values
`int`	`remFloat(float key)` Type Specific remove function to reduce boxing/unboxing
`int`	`remFloatOrDefault(float key, int defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(float key, int value)` Type Specific remove function to reduce boxing/unboxing
`int`	`replace(float key, int value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(float key, int oldValue, int newValue)` A Type Specific replace method to replace an existing value
`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()`
`Float2IntNavigableMap`	`subMap(float fromKey, boolean fromInclusive, float toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`Float2IntNavigableMap`	`tailMap(float fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`IntCollection`	`values()`

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2IntMap
addToAll, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceInts, replaceInts, 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.Float2IntNavigableMap
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.Float2IntSortedMap
firstKey, lastKey

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2IntMap
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, replaceInts, replaceInts, setDefaultReturnValue

Methods inherited from interface java.util.SortedMap
entrySet

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

- Constructor Detail
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap()
```
    Default Constructor
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(FloatComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(java.lang.Float[] keys,
                          java.lang.Integer[] values)
```
    Helper constructor that allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(java.lang.Float[] keys,
                          java.lang.Integer[] 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
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(float[] keys,
                          int[] values)
```
    Helper constructor that allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(float[] keys,
                          int[] 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
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Integer> map)
```
    A Helper constructor that allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Integer> 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
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(Float2IntMap map)
```
    A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Float2IntRBTreeMap
```
public Float2IntRBTreeMap(Float2IntMap 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: Float2IntNavigableMap
    
    A Helper method to set the max value for SubMaps. (Default: float.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface Float2IntNavigableMap
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public float getDefaultMaxValue()
```
    Description copied from interface: Float2IntNavigableMap
    
    A Helper method to get the max value for SubMaps.
    
    Specified by:
    
    getDefaultMaxValue in interface Float2IntNavigableMap
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(float value)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Helper method to set the min value for SubMaps. (Default: float.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface Float2IntNavigableMap
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public float getDefaultMinValue()
```
    Description copied from interface: Float2IntNavigableMap
    
    A Helper method to get the min value for SubMaps.
    
    Specified by:
    
    getDefaultMinValue in interface Float2IntNavigableMap
    
    Returns:
    
    the default min value.
  - put
```
public int put(float key,
               int value)
```
    Description copied from interface: Float2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Float2IntMap
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.put(Object, Object)
  - putIfAbsent
```
public int putIfAbsent(float key,
                       int value)
```
    Description copied from interface: Float2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Float2IntMap
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.putIfAbsent(Object, Object)
  - addTo
```
public int addTo(float key,
                 int value)
```
    Description copied from interface: Float2IntMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Float2IntMap
    
    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 int putAndMoveToFirst(float key,
                             int value)
```
    Description copied from interface: Float2IntSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Float2IntSortedMap
    
    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 int putAndMoveToLast(float key,
                            int value)
```
    Description copied from interface: Float2IntSortedMap
    
    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 Float2IntSortedMap
    
    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: Float2IntSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Float2IntSortedMap
    
    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: Float2IntSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Float2IntSortedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public int getAndMoveToFirst(float key)
```
    Description copied from interface: Float2IntSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Float2IntSortedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public int getAndMoveToLast(float key)
```
    Description copied from interface: Float2IntSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Float2IntSortedMap
    
    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.Integer>
    
    Specified by:
    
    comparator in interface Float2IntSortedMap
  - containsKey
```
public boolean containsKey(float key)
```
    Description copied from interface: Float2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Float2IntMap
    
    Overrides:
    
    containsKey in class AbstractFloat2IntMap
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - getInt
```
public int getInt(float key)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getInt in interface Float2IntFunction
    
    Specified by:
    
    getInt in interface Float2IntMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public int getOrDefault(float key,
                        int defaultValue)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Float2IntMap
    
    Overrides:
    
    getOrDefault in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the key that is searched for
    
    defaultValue - the value that should be returned if the key is not present
    
    Returns:
    
    the searched value or defaultValue value
  - firstFloatKey
```
public float firstFloatKey()
```
    Description copied from interface: Float2IntSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstFloatKey in interface Float2IntSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstFloatKey
```
public float pollFirstFloatKey()
```
    Description copied from interface: Float2IntSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstFloatKey in interface Float2IntSortedMap
    
    Returns:
    
    the first key in the map
  - lastFloatKey
```
public float lastFloatKey()
```
    Description copied from interface: Float2IntSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastFloatKey in interface Float2IntSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastFloatKey
```
public float pollLastFloatKey()
```
    Description copied from interface: Float2IntSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastFloatKey in interface Float2IntSortedMap
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Float2IntMap.Entry firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    firstEntry in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Float2IntMap.Entry lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    lastEntry in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Float2IntMap.Entry pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    pollFirstEntry in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Float2IntMap.Entry pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    pollLastEntry in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstIntValue
```
public int firstIntValue()
```
    Description copied from interface: Float2IntSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstIntValue in interface Float2IntSortedMap
    
    Returns:
    
    the first key in the map
  - lastIntValue
```
public int lastIntValue()
```
    Description copied from interface: Float2IntSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastIntValue in interface Float2IntSortedMap
    
    Returns:
    
    the last key in the map
  - remFloat
```
public int remFloat(float key)
```
    Description copied from interface: Float2IntMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remFloat in interface Float2IntMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remFloatOrDefault
```
public int remFloatOrDefault(float key,
                             int defaultValue)
```
    Description copied from interface: Float2IntMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    remFloatOrDefault in interface Float2IntMap
    
    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,
                      int value)
```
    Description copied from interface: Float2IntMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2IntMap
    
    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,
                       int oldValue,
                       int newValue)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Float2IntMap
    
    Overrides:
    
    replace in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the element that should be searched for
    
    oldValue - the expected value to be replaced
    
    newValue - the value to replace the oldValue with.
    
    Returns:
    
    true if the value got replaced
  - replace
```
public int replace(float key,
                   int value)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Float2IntMap
    
    Overrides:
    
    replace in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeInt
```
public int computeInt(float key,
                      FloatIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeInt in interface Float2IntMap
    
    Overrides:
    
    computeInt in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeIntIfAbsent
```
public int computeIntIfAbsent(float key,
                              Float2IntFunction mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfAbsent in interface Float2IntMap
    
    Overrides:
    
    computeIntIfAbsent in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeIntIfPresent
```
public int computeIntIfPresent(float key,
                               FloatIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfPresent in interface Float2IntMap
    
    Overrides:
    
    computeIntIfPresent in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if present
    
    Returns:
    
    the result of the default return value or present value
  - mergeInt
```
public int mergeInt(float key,
                    int value,
                    IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeInt in interface Float2IntMap
    
    Overrides:
    
    mergeInt in class AbstractFloat2IntMap
    
    Parameters:
    
    key - the key that should be be searched for
    
    value - the value that should be merged with
    
    mappingFunction - the operator that should generate the new Value
    
    Returns:
    
    the result of the merge
  - mergeAllInt
```
public void mergeAllInt(Float2IntMap m,
                        IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Float2IntMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllInt in interface Float2IntMap
    
    Overrides:
    
    mergeAllInt in class AbstractFloat2IntMap
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Float,java.lang.Integer>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Float,java.lang.Integer>
  - keySet
```
public FloatSortedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    keySet in interface Float2IntMap
    
    Specified by:
    
    keySet in interface Float2IntSortedMap
    
    Overrides:
    
    keySet in class AbstractFloat2IntMap
  - float2IntEntrySet
```
public ObjectSet<Float2IntMap.Entry> float2IntEntrySet()
```
    Description copied from interface: Float2IntMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    float2IntEntrySet in interface Float2IntMap
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public IntCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    values in interface Float2IntMap
    
    Specified by:
    
    values in interface Float2IntSortedMap
    
    Overrides:
    
    values in class AbstractFloat2IntMap
  - navigableKeySet
```
public FloatNavigableSet navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    navigableKeySet in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Float2IntNavigableMap descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    descendingMap in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public FloatNavigableSet descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<java.lang.Float,java.lang.Integer>
    
    Specified by:
    
    descendingKeySet in interface Float2IntNavigableMap
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Float2IntNavigableMap subMap(float fromKey,
                                    boolean fromInclusive,
                                    float toKey,
                                    boolean toInclusive)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Float2IntNavigableMap
    
    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 Float2IntNavigableMap headMap(float toKey,
                                     boolean inclusive)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Float2IntNavigableMap
    
    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 Float2IntNavigableMap tailMap(float fromKey,
                                     boolean inclusive)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Float2IntNavigableMap
    
    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: Float2IntNavigableMap
    
    A Type Specific lowerKey method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerKey in interface Float2IntNavigableMap
    
    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: Float2IntNavigableMap
    
    A Type Specific floorKey method to reduce boxing/unboxing.
    
    Specified by:
    
    floorKey in interface Float2IntNavigableMap
    
    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: Float2IntNavigableMap
    
    A Type Specific higherKey method to reduce boxing/unboxing.
    
    Specified by:
    
    higherKey in interface Float2IntNavigableMap
    
    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: Float2IntNavigableMap
    
    A Type Specific ceilingKey method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingKey in interface Float2IntNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - lowerEntry
```
public Float2IntMap.Entry lowerEntry(float key)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific lowerEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerEntry in interface Float2IntNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower entry that can be found, or null
  - higherEntry
```
public Float2IntMap.Entry higherEntry(float key)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific higherEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    higherEntry in interface Float2IntNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher entry that can be found, or null
  - floorEntry
```
public Float2IntMap.Entry floorEntry(float key)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific floorEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    floorEntry in interface Float2IntNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower or equal entry that can be found, or null
  - ceilingEntry
```
public Float2IntMap.Entry ceilingEntry(float key)
```
    Description copied from interface: Float2IntNavigableMap
    
    A Type Specific ceilingEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingEntry in interface Float2IntNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher or equal entry that can be found, or null

Class Float2IntRBTreeMap

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Float2IntRBTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

addTo

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

containsKey

getInt

getOrDefault

firstFloatKey

pollFirstFloatKey

lastFloatKey

pollLastFloatKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstIntValue

lastIntValue

remFloat

remFloatOrDefault

remove

replace

replace

computeInt

computeIntIfAbsent

computeIntIfPresent

mergeInt

mergeAllInt

size

clear

keySet

float2IntEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey