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

Klasse Enum2DoubleMap<T extends Enum<T>>

java.lang.Object
java.util.AbstractMap<T,Double>
speiger.src.collections.objects.maps.abstracts.AbstractObject2DoubleMap<T>
speiger.src.collections.objects.maps.impl.misc.Enum2DoubleMap<T>
Typparameter:
T - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
ToDoubleFunction<T>, Map<T,Double>, ToDoubleFunction<T>, Object2DoubleMap<T>
Bekannte direkte Unterklassen:
LinkedEnum2DoubleMap
public class Enum2DoubleMap<T extends Enum<T>> extends AbstractObject2DoubleMap<T>
A Type Specific EnumMap implementation that allows for Primitive Values. Unlike javas implementation this one does not jump around between a single long or long array implementation based around the enum size This will cause a bit more memory usage but allows for a simpler implementation.

  • Konstruktordetails

    • Enum2DoubleMap

      public Enum2DoubleMap(Class<T> keyType)
      Default Constructor
      Parameter:
      keyType - the type of Enum that should be used

    • Enum2DoubleMap

      public Enum2DoubleMap(T[] keys, Double[] values)
      Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)
      Parameter:
      keys - the keys that should be put into the EnumMap
      values - the values that should be put into the EnumMap.
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • Enum2DoubleMap

      public Enum2DoubleMap(T[] keys, double[] values)
      Helper constructor that allow to create a EnumMap from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • Enum2DoubleMap

      public Enum2DoubleMap(Map<? extends T,? extends Double> map)
      A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map

    • Enum2DoubleMap

      public Enum2DoubleMap(Object2DoubleMap<T> map)
      A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map

  • Methodendetails

    • put

      public double put(T key, double value)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      Type Specific method to reduce boxing/unboxing of values
      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 double putIfAbsent(T key, double value)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      Type Specific method to reduce boxing/unboxing of values
      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 double addTo(T key, double value)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      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 double subFrom(T key, double value)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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 Object2DoubleMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      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 extends Enum<T>,Double>
      Setzt außer Kraft:
      containsKey in Klasse AbstractObject2DoubleMap<T extends Enum<T>>

    • containsValue

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

    • remove

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

    • rem

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

    • remOrDefault

      public double remOrDefault(T key, double defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      Type-Specific Remove function with a default return value if wanted.
      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 boolean remove(T key, double value)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      Type Specific remove function to reduce boxing/unboxing
      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:

    • getDouble

      public double getDouble(T key)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      A Type Specific get method to reduce boxing/unboxing
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • getOrDefault

      public double getOrDefault(T key, double defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      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 Enum2DoubleMap<T> copy()
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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 Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      copy in Klasse AbstractObject2DoubleMap<T extends Enum<T>>
      Gibt zurück:
      a Shallow Copy of the Map

    • object2DoubleEntrySet

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

    • keySet

      public ObjectSet<T> keySet()
      Angegeben von:
      keySet in Schnittstelle Map<T extends Enum<T>,Double>
      Angegeben von:
      keySet in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      keySet in Klasse AbstractObject2DoubleMap<T extends Enum<T>>

    • values

      public DoubleCollection values()
      Angegeben von:
      values in Schnittstelle Map<T extends Enum<T>,Double>
      Angegeben von:
      values in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      values in Klasse AbstractObject2DoubleMap<T extends Enum<T>>

    • forEach

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

    • replace

      public boolean replace(T key, double oldValue, double newValue)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2DoubleMap<T extends Enum<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 double replace(T key, double value)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • computeDouble

      public double computeDouble(T key, ObjectDoubleUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      computeDouble in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeDouble in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • computeDoubleIfAbsent

      public double computeDoubleIfAbsent(T key, ToDoubleFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      computeDoubleIfAbsent in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeDoubleIfAbsent in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • supplyDoubleIfAbsent

      public double supplyDoubleIfAbsent(T key, DoubleSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      supplyDoubleIfAbsent in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      supplyDoubleIfAbsent in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • computeDoubleIfPresent

      public double computeDoubleIfPresent(T key, ObjectDoubleUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      computeDoubleIfPresent in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeDoubleIfPresent in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • computeDoubleNonDefault

      public double computeDoubleNonDefault(T key, ObjectDoubleUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      computeDoubleNonDefault in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeDoubleNonDefault in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • computeDoubleIfAbsentNonDefault

      public double computeDoubleIfAbsentNonDefault(T key, ToDoubleFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      computeDoubleIfAbsentNonDefault in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeDoubleIfAbsentNonDefault in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • supplyDoubleIfAbsentNonDefault

      public double supplyDoubleIfAbsentNonDefault(T key, DoubleSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      supplyDoubleIfAbsentNonDefault in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      supplyDoubleIfAbsentNonDefault in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • computeDoubleIfPresentNonDefault

      public double computeDoubleIfPresentNonDefault(T key, ObjectDoubleUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      computeDoubleIfPresentNonDefault in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeDoubleIfPresentNonDefault in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • mergeDouble

      public double mergeDouble(T key, double value, DoubleDoubleUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      mergeDouble in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      mergeDouble in Klasse AbstractObject2DoubleMap<T extends Enum<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

    • mergeAllDouble

      public void mergeAllDouble(Object2DoubleMap<T> m, DoubleDoubleUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2DoubleMap
      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:
      mergeAllDouble in Schnittstelle Object2DoubleMap<T extends Enum<T>>
      Setzt außer Kraft:
      mergeAllDouble in Klasse AbstractObject2DoubleMap<T extends Enum<T>>
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value

    • clear

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

    • size

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