Modul speiger.src.collections
Package speiger.src.collections.objects.maps.impl.customHash

Klasse Object2FloatOpenCustomHashMap<T>

java.lang.Object
java.util.AbstractMap<T,Float>
speiger.src.collections.objects.maps.abstracts.AbstractObject2FloatMap<T>
speiger.src.collections.objects.maps.impl.customHash.Object2FloatOpenCustomHashMap<T>
Typparameter:
T - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Map<T,Float>, ToFloatFunction<T>, Object2FloatMap<T>, ITrimmable
Bekannte direkte Unterklassen:
Object2FloatLinkedOpenCustomHashMap
public class Object2FloatOpenCustomHashMap<T> extends AbstractObject2FloatMap<T> implements ITrimmable
A Type Specific HashMap that allows for custom HashControl. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control.

  • Konstruktordetails

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(ObjectStrategy<? super T> strategy)
      Default Contstructor
      Parameter:
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(int minCapacity, ObjectStrategy<? super T> strategy)
      Constructor that defines the minimum capacity
      Parameter:
      minCapacity - the minimum capacity the HashMap is allowed to be.
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the minimum capacity is negative

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(int minCapacity, float loadFactor, ObjectStrategy<? super T> strategy)
      Constructor that defines the minimum capacity and load factor
      Parameter:
      minCapacity - the minimum capacity the HashMap is allowed to be.
      loadFactor - the percentage of how full the backing array can be before they resize
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the minimum capacity is negative
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(T[] keys, Float[] values, ObjectStrategy<? super T> strategy)
      Helper constructor that allow to create a map from boxed values (it will unbox them)
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the keys and values do not match in lenght

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(T[] keys, Float[] values, float loadFactor, ObjectStrategy<? super T> strategy)
      Helper constructor that allow to create a map from boxed values (it will unbox them)
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      loadFactor - the percentage of how full the backing array can be before they resize
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the keys and values do not match in lenght
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(T[] keys, float[] values, ObjectStrategy<? super T> strategy)
      Helper constructor that allow to create a map from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the keys and values do not match in lenght

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(T[] keys, float[] values, float loadFactor, ObjectStrategy<? super T> strategy)
      Helper constructor that allow to create a map from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      loadFactor - the percentage of how full the backing array can be before they resize
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the keys and values do not match in lenght
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(Map<? extends T,? extends Float> map, ObjectStrategy<? super T> strategy)
      A Helper constructor that allows to create a Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(Map<? extends T,? extends Float> map, float loadFactor, ObjectStrategy<? super T> strategy)
      A Helper constructor that allows to create a Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map
      loadFactor - the percentage of how full the backing array can be before they resize
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(Object2FloatMap<T> map, ObjectStrategy<? super T> strategy)
      A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Object2FloatOpenCustomHashMap

      public Object2FloatOpenCustomHashMap(Object2FloatMap<T> map, float loadFactor, ObjectStrategy<? super T> strategy)
      A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map
      loadFactor - the percentage of how full the backing array can be before they resize
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

  • Methodendetails

    • put

      public float put(T key, float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • putIfAbsent

      public float putIfAbsent(T key, float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • addTo

      public float addTo(T key, float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Angegeben von:
      addTo in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted / added
      Gibt zurück:
      the last present value or default return value.

    • subFrom

      public float subFrom(T key, float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      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 Object2FloatMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Angegeben von:
      subFrom in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - that should be subtract from
      value - that should be subtract
      Gibt zurück:
      the last present or default return value

    • containsKey

      public boolean containsKey(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<T,Float>
      Setzt außer Kraft:
      containsKey in Klasse AbstractObject2FloatMap<T>

    • containsValue

      public boolean containsValue(float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsValue in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      containsValue in Klasse AbstractObject2FloatMap<T>
      Parameter:
      value - element that is searched for
      Gibt zurück:
      if the value is present

    • containsValue

      @Deprecated public boolean containsValue(Object value)
      Veraltet.
      Angegeben von:
      containsValue in Schnittstelle Map<T,Float>
      Angegeben von:
      containsValue in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      containsValue in Klasse AbstractMap<T,Float>
      Parameter:
      value - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:

    • rem

      public float rem(T key)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      rem in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value

    • remOrDefault

      public float remOrDefault(T key, float defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      remOrDefault in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the element that should be removed
      defaultValue - the value that should be returned if the entry doesn't exist
      Gibt zurück:
      the value that was removed or default value
      Siehe auch:

    • remove

      public Float remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<T,Float>
      Angegeben von:
      remove in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      remove in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value
      Siehe auch:

    • remove

      public boolean remove(T key, float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the element that should be removed
      value - the expected value that should be found
      Gibt zurück:
      true if the key and value was found and removed
      Siehe auch:

    • remove

      public boolean remove(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<T,Float>
      Angegeben von:
      remove in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the element that should be removed
      value - the expected value that should be found
      Gibt zurück:
      true if the key and value was found and removed
      Siehe auch:

    • getFloat

      public float getFloat(T key)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific get method to reduce boxing/unboxing
      Angegeben von:
      getFloat in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • get

      public Float get(Object key)
      Angegeben von:
      get in Schnittstelle Map<T,Float>
      Angegeben von:
      get in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      get in Klasse AbstractObject2FloatMap<T>

    • getOrDefault

      public float getOrDefault(T key, float defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Angegeben von:
      getOrDefault in Schnittstelle Object2FloatMap<T>
      Parameter:
      key - the key that is searched for
      defaultValue - the value that should be returned if the key is not present
      Gibt zurück:
      the searched value or defaultValue value

    • copy

      public Object2FloatOpenCustomHashMap<T> copy()
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      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
      Angegeben von:
      copy in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      copy in Klasse AbstractObject2FloatMap<T>
      Gibt zurück:
      a Shallow Copy of the Map

    • object2FloatEntrySet

      public ObjectSet<Object2FloatMap.Entry<T>> object2FloatEntrySet()
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Angegeben von:
      object2FloatEntrySet in Schnittstelle Object2FloatMap<T>
      Gibt zurück:
      a EntrySet of the collection

    • keySet

      public ObjectSet<T> keySet()
      Angegeben von:
      keySet in Schnittstelle Map<T,Float>
      Angegeben von:
      keySet in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      keySet in Klasse AbstractObject2FloatMap<T>

    • values

      public FloatCollection values()
      Angegeben von:
      values in Schnittstelle Map<T,Float>
      Angegeben von:
      values in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      values in Klasse AbstractObject2FloatMap<T>

    • forEach

      public void forEach(ObjectFloatConsumer<T> action)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      Type Specific forEach method to reduce boxing/unboxing
      Angegeben von:
      forEach in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      forEach in Klasse AbstractObject2FloatMap<T>
      Parameter:
      action - processor of the values that are iterator over

    • replace

      public boolean replace(T key, float oldValue, float newValue)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the element that should be searched for
      oldValue - the expected value to be replaced
      newValue - the value to replace the oldValue with.
      Gibt zurück:
      true if the value got replaced

    • replace

      public float replace(T key, float value)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the element that should be searched for
      value - the value to replace with.
      Gibt zurück:
      the present value or default return value

    • computeFloat

      public float computeFloat(T key, ObjectFloatUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeFloat in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      computeFloat in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeFloatIfAbsent

      public float computeFloatIfAbsent(T key, ToFloatFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeFloatIfAbsent in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      computeFloatIfAbsent in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • supplyFloatIfAbsent

      public float supplyFloatIfAbsent(T key, FloatSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      supplyFloatIfAbsent in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      supplyFloatIfAbsent in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      valueProvider - the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • computeFloatIfPresent

      public float computeFloatIfPresent(T key, ObjectFloatUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeFloatIfPresent in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      computeFloatIfPresent in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if present
      Gibt zurück:
      the result of the default return value or present value

    • computeFloatNonDefault

      public float computeFloatNonDefault(T key, ObjectFloatUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeFloatNonDefault in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      computeFloatNonDefault in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeFloatIfAbsentNonDefault

      public float computeFloatIfAbsentNonDefault(T key, ToFloatFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeFloatIfAbsentNonDefault in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      computeFloatIfAbsentNonDefault in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • supplyFloatIfAbsentNonDefault

      public float supplyFloatIfAbsentNonDefault(T key, FloatSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      supplyFloatIfAbsentNonDefault in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      supplyFloatIfAbsentNonDefault in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      valueProvider - the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • computeFloatIfPresentNonDefault

      public float computeFloatIfPresentNonDefault(T key, ObjectFloatUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeFloatIfPresentNonDefault in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      computeFloatIfPresentNonDefault in Klasse AbstractObject2FloatMap<T>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if present
      Gibt zurück:
      the result of the default return value or present value

    • mergeFloat

      public float mergeFloat(T key, float value, FloatFloatUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Type Specific merge method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      mergeFloat in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      mergeFloat in Klasse AbstractObject2FloatMap<T>
      Parameter:
      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
      Gibt zurück:
      the result of the merge

    • mergeAllFloat

      public void mergeAllFloat(Object2FloatMap<T> m, FloatFloatUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2FloatMap
      A Bulk method for merging Maps. If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      mergeAllFloat in Schnittstelle Object2FloatMap<T>
      Setzt außer Kraft:
      mergeAllFloat in Klasse AbstractObject2FloatMap<T>
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value

    • size

      public int size()
      Angegeben von:
      size in Schnittstelle Map<T,Float>
      Setzt außer Kraft:
      size in Klasse AbstractMap<T,Float>

    • clear

      public void clear()
      Angegeben von:
      clear in Schnittstelle Map<T,Float>
      Setzt außer Kraft:
      clear in Klasse AbstractMap<T,Float>

    • trim

      public boolean trim(int size)
      Beschreibung aus Schnittstelle kopiert: ITrimmable
      Trims the original collection down to the size of the current elements or the requested size depending which is bigger
      Angegeben von:
      trim in Schnittstelle ITrimmable
      Parameter:
      size - the requested trim size.
      Gibt zurück:
      if the internal array has been trimmed.

    • clearAndTrim

      public void clearAndTrim(int size)
      Beschreibung aus Schnittstelle kopiert: ITrimmable
      Trims the collection down to the requested size and clears all elements while doing so
      Angegeben von:
      clearAndTrim in Schnittstelle ITrimmable
      Parameter:
      size - the amount of elements that should be allowed