Float2CharRBTreeMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Float,java.lang.Character>
- - speiger.src.collections.floats.maps.abstracts.AbstractFloat2CharMap
  - - speiger.src.collections.floats.maps.impl.tree.Float2CharRBTreeMap

All Implemented Interfaces:

java.util.Map<java.lang.Float,java.lang.Character>, java.util.NavigableMap<java.lang.Float,java.lang.Character>, java.util.SortedMap<java.lang.Float,java.lang.Character>, Float2CharFunction, Float2CharMap, Float2CharNavigableMap, Float2CharSortedMap
```
public class Float2CharRBTreeMap
extends AbstractFloat2CharMap
implements Float2CharNavigableMap
```
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.AbstractFloat2CharMap
  AbstractFloat2CharMap.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.Float2CharSortedMap
  Float2CharSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2CharMap
  Float2CharMap.BuilderCache, Float2CharMap.Entry, Float2CharMap.FastEntrySet, Float2CharMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Float2CharRBTreeMap()` Default Constructor
`Float2CharRBTreeMap(float[] keys, char[] values)` Helper constructor that allow to create a map from unboxed values
`Float2CharRBTreeMap(float[] keys, char[] values, FloatComparator comp)` Helper constructor that has a custom sorter and allow to create a map from unboxed values
`Float2CharRBTreeMap(java.lang.Float[] keys, java.lang.Character[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Float2CharRBTreeMap(java.lang.Float[] keys, java.lang.Character[] values, FloatComparator comp)` Helper constructor that has a custom sorter and allow to create a map from boxed values (it will unbox them)
`Float2CharRBTreeMap(Float2CharMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Float2CharRBTreeMap(Float2CharMap 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.
`Float2CharRBTreeMap(FloatComparator comp)` Constructor that allows to define the sorter
`Float2CharRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Character> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Float2CharRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Character> 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
`char`	`addTo(float key, char value)` A Helper method to add a primitives together.
`Float2CharMap.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()`
`char`	`computeChar(float key, FloatCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfAbsent(float key, Float2CharFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfPresent(float key, FloatCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(float key)` Type Specific method to reduce boxing/unboxing of values
`Float2CharRBTreeMap`	`copy()` A Function that does a shallow clone of the Map itself.
`FloatNavigableSet`	`descendingKeySet()`
`Float2CharNavigableMap`	`descendingMap()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`Float2CharMap.Entry`	`firstEntry()`
`float`	`firstFloatKey()` A method to get the first Key of a Map.
`ObjectSet<Float2CharMap.Entry>`	`float2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Float2CharMap.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.
`void`	`forEach(FloatCharConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`char`	`get(float key)` A Type Specific get method to reduce boxing/unboxing
`float`	`getDefaultMaxValue()` A Helper method to get the max value for SubMaps.
`float`	`getDefaultMinValue()` A Helper method to get the min value for SubMaps.
`char`	`getOrDefault(float key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`Float2CharNavigableMap`	`headMap(float toKey, boolean inclusive)` A Type Specific HeadMap method to reduce boxing/unboxing
`Float2CharMap.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.
`FloatNavigableSet`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`Float2CharMap.Entry`	`lastEntry()`
`float`	`lastFloatKey()` A method to get the last Key of a Map.
`Float2CharMap.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`	`mergeAllChar(Float2CharMap m, CharCharUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`char`	`mergeChar(float key, char value, CharCharUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`FloatNavigableSet`	`navigableKeySet()`
`Float2CharMap.Entry`	`pollFirstEntry()`
`float`	`pollFirstFloatKey()` A method to get and remove the first Key of a Map.
`Float2CharMap.Entry`	`pollLastEntry()`
`float`	`pollLastFloatKey()` A method to get and remove the last Key of a Map.
`char`	`put(float key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`putIfAbsent(float key, char value)` Type Specific method to reduce boxing/unboxing of values
`char`	`remove(float key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remove(float key, char value)` Type Specific remove function to reduce boxing/unboxing
`char`	`removeOrDefault(float key, char defaultValue)` Type-Specific Remove function with a default return value if wanted.
`char`	`replace(float key, char value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(float key, char oldValue, char 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()`
`char`	`subFrom(float key, char value)` A Helper method to subtract from primitive from each other.
`Float2CharNavigableMap`	`subMap(float fromKey, boolean fromInclusive, float toKey, boolean toInclusive)` A Type Specific SubMap method to reduce boxing/unboxing
`char`	`supplyCharIfAbsent(float key, CharSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`Float2CharNavigableMap`	`tailMap(float fromKey, boolean inclusive)` A Type Specific TailMap method to reduce boxing/unboxing
`CharCollection`	`values()`

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2CharMap
addToAll, containsValue, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
containsKey, containsValue, 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.Float2CharNavigableMap
ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, subMap, synchronize, synchronize, tailMap, tailMap, tailMap, unmodifiable

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

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

Methods inherited from interface java.util.SortedMap
entrySet

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

- Constructor Detail
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap()
```
    Default Constructor
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(FloatComparator comp)
```
    Constructor that allows to define the sorter
    
    Parameters:
    
    comp - the function that decides how the tree is sorted, can be null
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(java.lang.Float[] keys,
                           java.lang.Character[] 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(java.lang.Float[] keys,
                           java.lang.Character[] 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(float[] keys,
                           char[] 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(float[] keys,
                           char[] 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Character> 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(java.util.Map<? extends java.lang.Float,? extends java.lang.Character> 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(Float2CharMap 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
  - Float2CharRBTreeMap
```
public Float2CharRBTreeMap(Float2CharMap 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: Float2CharNavigableMap
    
    A Helper method to set the max value for SubMaps. (Default: float.MIN_VALUE)
    
    Specified by:
    
    setDefaultMaxValue in interface Float2CharNavigableMap
    
    Parameters:
    
    value - the new max value
  - getDefaultMaxValue
```
public float getDefaultMaxValue()
```
    Description copied from interface: Float2CharNavigableMap
    
    A Helper method to get the max value for SubMaps.
    
    Specified by:
    
    getDefaultMaxValue in interface Float2CharNavigableMap
    
    Returns:
    
    the default max value.
  - setDefaultMinValue
```
public void setDefaultMinValue(float value)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Helper method to set the min value for SubMaps. (Default: float.MAX_VALUE)
    
    Specified by:
    
    setDefaultMinValue in interface Float2CharNavigableMap
    
    Parameters:
    
    value - the new min value
  - getDefaultMinValue
```
public float getDefaultMinValue()
```
    Description copied from interface: Float2CharNavigableMap
    
    A Helper method to get the min value for SubMaps.
    
    Specified by:
    
    getDefaultMinValue in interface Float2CharNavigableMap
    
    Returns:
    
    the default min value.
  - put
```
public char put(float key,
                char value)
```
    Description copied from interface: Float2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    put in interface Float2CharMap
    
    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 char putIfAbsent(float key,
                        char value)
```
    Description copied from interface: Float2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    putIfAbsent in interface Float2CharMap
    
    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 char addTo(float key,
                  char value)
```
    Description copied from interface: Float2CharMap
    
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Specified by:
    
    addTo in interface Float2CharMap
    
    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 char subFrom(float key,
                    char value)
```
    Description copied from interface: Float2CharMap
    
    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 Float2CharMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
    
    Specified by:
    
    subFrom in interface Float2CharMap
    
    Parameters:
    
    key - that should be subtract from
    
    value - that should be subtract
    
    Returns:
    
    the last present or default return value
  - comparator
```
public FloatComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    comparator in interface Float2CharSortedMap
  - containsKey
```
public boolean containsKey(float key)
```
    Description copied from interface: Float2CharMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsKey in interface Float2CharMap
    
    Overrides:
    
    containsKey in class AbstractFloat2CharMap
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - get
```
public char get(float key)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    get in interface Float2CharMap
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public char getOrDefault(float key,
                         char defaultValue)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Specified by:
    
    getOrDefault in interface Float2CharMap
    
    Overrides:
    
    getOrDefault in class AbstractFloat2CharMap
    
    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: Float2CharSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstFloatKey in interface Float2CharSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstFloatKey
```
public float pollFirstFloatKey()
```
    Description copied from interface: Float2CharSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstFloatKey in interface Float2CharSortedMap
    
    Returns:
    
    the first key in the map
  - lastFloatKey
```
public float lastFloatKey()
```
    Description copied from interface: Float2CharSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastFloatKey in interface Float2CharSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastFloatKey
```
public float pollLastFloatKey()
```
    Description copied from interface: Float2CharSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastFloatKey in interface Float2CharSortedMap
    
    Returns:
    
    the last key in the map
  - firstEntry
```
public Float2CharMap.Entry firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    firstEntry in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific firstEntry
  - lastEntry
```
public Float2CharMap.Entry lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    lastEntry in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific lastEntry
  - pollFirstEntry
```
public Float2CharMap.Entry pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    pollFirstEntry in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific pollFirstEntry
  - pollLastEntry
```
public Float2CharMap.Entry pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    pollLastEntry in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific pollLastEntry
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Float2CharSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Float2CharSortedMap
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Float2CharSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Float2CharSortedMap
    
    Returns:
    
    the last key in the map
  - remove
```
public char remove(float key)
```
    Description copied from interface: Float2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2CharMap
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - removeOrDefault
```
public char removeOrDefault(float key,
                            char defaultValue)
```
    Description copied from interface: Float2CharMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Specified by:
    
    removeOrDefault in interface Float2CharMap
    
    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,
                      char value)
```
    Description copied from interface: Float2CharMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Specified by:
    
    remove in interface Float2CharMap
    
    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,
                       char oldValue,
                       char newValue)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Float2CharMap
    
    Overrides:
    
    replace in class AbstractFloat2CharMap
    
    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 char replace(float key,
                    char value)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Float2CharMap
    
    Overrides:
    
    replace in class AbstractFloat2CharMap
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeChar
```
public char computeChar(float key,
                        FloatCharUnaryOperator mappingFunction)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeChar in interface Float2CharMap
    
    Overrides:
    
    computeChar in class AbstractFloat2CharMap
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeCharIfAbsent
```
public char computeCharIfAbsent(float key,
                                Float2CharFunction mappingFunction)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfAbsent in interface Float2CharMap
    
    Overrides:
    
    computeCharIfAbsent in class AbstractFloat2CharMap
    
    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
  - supplyCharIfAbsent
```
public char supplyCharIfAbsent(float key,
                               CharSupplier valueProvider)
```
    Description copied from interface: Float2CharMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyCharIfAbsent in interface Float2CharMap
    
    Overrides:
    
    supplyCharIfAbsent in class AbstractFloat2CharMap
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeCharIfPresent
```
public char computeCharIfPresent(float key,
                                 FloatCharUnaryOperator mappingFunction)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeCharIfPresent in interface Float2CharMap
    
    Overrides:
    
    computeCharIfPresent in class AbstractFloat2CharMap
    
    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
  - mergeChar
```
public char mergeChar(float key,
                      char value,
                      CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Float2CharMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeChar in interface Float2CharMap
    
    Overrides:
    
    mergeChar in class AbstractFloat2CharMap
    
    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
  - mergeAllChar
```
public void mergeAllChar(Float2CharMap m,
                         CharCharUnaryOperator mappingFunction)
```
    Description copied from interface: Float2CharMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllChar in interface Float2CharMap
    
    Overrides:
    
    mergeAllChar in class AbstractFloat2CharMap
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - forEach
```
public void forEach(FloatCharConsumer action)
```
    Description copied from interface: Float2CharMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Float2CharMap
    
    Overrides:
    
    forEach in class AbstractFloat2CharMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.Float,java.lang.Character>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Float,java.lang.Character>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Float,java.lang.Character>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Float,java.lang.Character>
  - copy
```
public Float2CharRBTreeMap copy()
```
    Description copied from interface: Float2CharMap
    
    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 Float2CharMap
    
    Specified by:
    
    copy in interface Float2CharNavigableMap
    
    Specified by:
    
    copy in interface Float2CharSortedMap
    
    Overrides:
    
    copy in class AbstractFloat2CharMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public FloatNavigableSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    keySet in interface Float2CharMap
    
    Specified by:
    
    keySet in interface Float2CharNavigableMap
    
    Specified by:
    
    keySet in interface Float2CharSortedMap
    
    Overrides:
    
    keySet in class AbstractFloat2CharMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - float2CharEntrySet
```
public ObjectSet<Float2CharMap.Entry> float2CharEntrySet()
```
    Description copied from interface: Float2CharMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    float2CharEntrySet in interface Float2CharMap
    
    Returns:
    
    a EntrySet of the collection
  - values
```
public CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    values in interface Float2CharMap
    
    Specified by:
    
    values in interface Float2CharSortedMap
    
    Overrides:
    
    values in class AbstractFloat2CharMap
  - navigableKeySet
```
public FloatNavigableSet navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    navigableKeySet in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific Navigable Key Set
  - descendingMap
```
public Float2CharNavigableMap descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    descendingMap in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific desendingMap
  - descendingKeySet
```
public FloatNavigableSet descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<java.lang.Float,java.lang.Character>
    
    Specified by:
    
    descendingKeySet in interface Float2CharNavigableMap
    
    Returns:
    
    a Type Specific Desending Key Set
  - subMap
```
public Float2CharNavigableMap subMap(float fromKey,
                                     boolean fromInclusive,
                                     float toKey,
                                     boolean toInclusive)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Float2CharNavigableMap
    
    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 Float2CharNavigableMap headMap(float toKey,
                                      boolean inclusive)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Float2CharNavigableMap
    
    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 Float2CharNavigableMap tailMap(float fromKey,
                                      boolean inclusive)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Float2CharNavigableMap
    
    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: Float2CharNavigableMap
    
    A Type Specific lowerKey method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerKey in interface Float2CharNavigableMap
    
    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: Float2CharNavigableMap
    
    A Type Specific floorKey method to reduce boxing/unboxing.
    
    Specified by:
    
    floorKey in interface Float2CharNavigableMap
    
    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: Float2CharNavigableMap
    
    A Type Specific higherKey method to reduce boxing/unboxing.
    
    Specified by:
    
    higherKey in interface Float2CharNavigableMap
    
    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: Float2CharNavigableMap
    
    A Type Specific ceilingKey method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingKey in interface Float2CharNavigableMap
    
    Parameters:
    
    e - that should be compared with.
    
    Returns:
    
    the lowest higher or equal key that can be found
  - lowerEntry
```
public Float2CharMap.Entry lowerEntry(float key)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific lowerEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    lowerEntry in interface Float2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower entry that can be found, or null
  - higherEntry
```
public Float2CharMap.Entry higherEntry(float key)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific higherEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    higherEntry in interface Float2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher entry that can be found, or null
  - floorEntry
```
public Float2CharMap.Entry floorEntry(float key)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific floorEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    floorEntry in interface Float2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the greatest lower or equal entry that can be found, or null
  - ceilingEntry
```
public Float2CharMap.Entry ceilingEntry(float key)
```
    Description copied from interface: Float2CharNavigableMap
    
    A Type Specific ceilingEntry method to reduce boxing/unboxing.
    
    Specified by:
    
    ceilingEntry in interface Float2CharNavigableMap
    
    Parameters:
    
    key - that should be compared with.
    
    Returns:
    
    the lowest higher or equal entry that can be found, or null

Class Float2CharRBTreeMap

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Float2CharRBTreeMap

Method Detail

setDefaultMaxValue

getDefaultMaxValue

setDefaultMinValue

getDefaultMinValue

put

putIfAbsent

addTo

subFrom

comparator

containsKey

get

getOrDefault

firstFloatKey

pollFirstFloatKey

lastFloatKey

pollLastFloatKey

firstEntry

lastEntry

pollFirstEntry

pollLastEntry

firstCharValue

lastCharValue

remove

removeOrDefault

remove

replace

replace

computeChar

computeCharIfAbsent

supplyCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

forEach

size

clear

copy

keySet

float2CharEntrySet

values

navigableKeySet

descendingMap

descendingKeySet

subMap

headMap

tailMap

lowerKey

floorKey

higherKey

ceilingKey

lowerEntry

higherEntry