Modul speiger.src.collections
Package speiger.src.collections.longs.maps.interfaces

Schnittstelle Long2DoubleMap

Alle Superschnittstellen:
Long2DoubleFunction, LongToDoubleFunction, Map<Long,Double>
Alle bekannten Unterschnittstellen:
Long2DoubleConcurrentMap, Long2DoubleNavigableMap, Long2DoubleOrderedMap, Long2DoubleSortedMap
Alle bekannten Implementierungsklassen:
AbstractLong2DoubleMap, ImmutableLong2DoubleOpenHashMap, Long2DoubleArrayMap, Long2DoubleAVLTreeMap, Long2DoubleConcurrentOpenHashMap, Long2DoubleLinkedOpenCustomHashMap, Long2DoubleLinkedOpenHashMap, Long2DoubleMaps.EmptyMap, Long2DoubleMaps.SingletonMap, Long2DoubleMaps.SynchronizedMap, Long2DoubleMaps.SynchronizedNavigableMap, Long2DoubleMaps.SynchronizedOrderedMap, Long2DoubleMaps.SynchronizedSortedMap, Long2DoubleMaps.UnmodifyableMap, Long2DoubleMaps.UnmodifyableNavigableMap, Long2DoubleMaps.UnmodifyableOrderedMap, Long2DoubleMaps.UnmodifyableSortedMap, Long2DoubleOpenCustomHashMap, Long2DoubleOpenHashMap, Long2DoubleRBTreeMap
public interface Long2DoubleMap extends Map<Long,Double>, Long2DoubleFunction
A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

  • Methodendetails

    • builder

      static Long2DoubleMap.MapBuilder builder()
      Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
      Gibt zurück:
      a MapBuilder

    • getDefaultReturnValue

      double getDefaultReturnValue()
      Method to see what the default return value is.
      Gibt zurück:
      default return value

    • setDefaultReturnValue

      Long2DoubleMap setDefaultReturnValue(double v)
      Method to define the default return value if a requested key isn't present
      Parameter:
      v - value that should be the default return value
      Gibt zurück:
      itself

    • copy

      Long2DoubleMap copy()
      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
      Gibt zurück:
      a Shallow Copy of the Map
      Note:
      Wrappers and view Maps will not support this feature

    • put

      double put(long key, double value)
      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:

    • put

      default double put(Long2DoubleMap.Entry entry)
      A Helper method that allows to put int a Long2DoubleMap.Entry into a map.
      Parameter:
      entry - then Entry that should be inserted.
      Gibt zurück:
      the last present value or default return value.

    • put

      default Double put(Map.Entry<Long,Double> entry)
      A Helper method that allows to put int a Map.Entry into a map.
      Parameter:
      entry - then Entry that should be inserted.
      Gibt zurück:
      the last present value or default return value.

    • putAll

      default void putAll(long[] keys, double[] values)
      Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      Löst aus:
      IllegalStateException - if the arrays are not the same size
      Siehe auch:

    • putAll

      void putAll(long[] keys, double[] values, int offset, int size)
      Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      offset - where the to start in the array
      size - how many elements should be added
      Löst aus:
      IllegalStateException - if the arrays are not within the range
      Siehe auch:

    • putAll

      default void putAll(Long[] keys, Double[] values)
      Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      Löst aus:
      IllegalStateException - if the arrays are not the same size
      Siehe auch:

    • putAll

      void putAll(Long[] keys, Double[] values, int offset, int size)
      Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      offset - where the to start in the array
      size - how many elements should be added
      Löst aus:
      IllegalStateException - if the arrays are not within the range
      Siehe auch:

    • putIfAbsent

      double putIfAbsent(long key, double value)
      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:

    • putAllIfAbsent

      void putAllIfAbsent(Long2DoubleMap m)
      Type-Specific bulk put method put elements into the map if not present.
      Parameter:
      m - elements that should be added if not present.

    • addTo

      double addTo(long key, double value)
      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.

    • addToAll

      void addToAll(Long2DoubleMap m)
      A Helper method to bulk add primitives together.
      Parameter:
      m - the values that should be added/inserted

    • subFrom

      double subFrom(long key, double value)
      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 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

    • putAll

      void putAll(Long2DoubleMap m)
      Type Specific function for the bull putting of values
      Parameter:
      m - the elements that should be inserted

    • containsKey

      boolean containsKey(long key)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      key - element that is searched for
      Gibt zurück:
      if the key is present

    • containsKey

      default boolean containsKey(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<Long,Double>
      Parameter:
      key - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:
      Note:
      in some implementations key does not have to be Long but just have to support equals with Long.

    • containsValue

      boolean containsValue(double value)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      value - element that is searched for
      Gibt zurück:
      if the value is present

    • containsValue

      default boolean containsValue(Object value)
      Angegeben von:
      containsValue in Schnittstelle Map<Long,Double>
      Parameter:
      value - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:
      Note:
      in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.

    • remove

      double remove(long key)
      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

    • remove

      default Double remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<Long,Double>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value
      Siehe auch:
      Note:
      in some implementations key does not have to be Long but just have to support equals with Long.

    • remove

      boolean remove(long key, double value)
      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:

    • remove

      default boolean remove(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<Long,Double>
      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:

    • removeOrDefault

      double removeOrDefault(long key, double defaultValue)
      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:

    • replace

      boolean replace(long key, double oldValue, double newValue)
      A Type Specific replace method to replace an existing value
      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
      Note:
      this fails if the value is not present even if it matches the oldValue

    • replace

      double replace(long key, double value)
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      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
      Note:
      this fails if the value is not present

    • replaceDoubles

      void replaceDoubles(Long2DoubleMap m)
      Type-Specific bulk replace method. Could be seen as putAllIfPresent
      Parameter:
      m - elements that should be replaced.

    • replaceDoubles

      void replaceDoubles(LongDoubleUnaryOperator mappingFunction)
      A Type Specific mass replace method to reduce boxing/unboxing
      Parameter:
      mappingFunction - operation to replace all values

    • computeDouble

      double computeDouble(long key, LongDoubleUnaryOperator mappingFunction)
      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.
      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

      double computeDoubleIfAbsent(long key, Long2DoubleFunction mappingFunction)
      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.
      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

      double supplyDoubleIfAbsent(long key, DoubleSupplier valueProvider)
      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.
      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

      double computeDoubleIfPresent(long key, LongDoubleUnaryOperator mappingFunction)
      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.
      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
      Note:
      if not present then compute is not executed

    • computeDoubleNonDefault

      double computeDoubleNonDefault(long key, LongDoubleUnaryOperator mappingFunction)
      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.
      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

      double computeDoubleIfAbsentNonDefault(long key, Long2DoubleFunction mappingFunction)
      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.
      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

      double supplyDoubleIfAbsentNonDefault(long key, DoubleSupplier valueProvider)
      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.
      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

      double computeDoubleIfPresentNonDefault(long key, LongDoubleUnaryOperator mappingFunction)
      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.
      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
      Note:
      if not present then compute is not executed

    • mergeDouble

      double mergeDouble(long key, double value, DoubleDoubleUnaryOperator mappingFunction)
      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.
      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
      Note:
      if the result matches the default return value then the key is removed from the map

    • mergeAllDouble

      void mergeAllDouble(Long2DoubleMap m, DoubleDoubleUnaryOperator mappingFunction)
      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.
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value
      Note:
      if the result matches the default return value then the key is removed from the map

    • replace

      @Deprecated default boolean replace(Long key, Double oldValue, Double newValue)
      Veraltet.
      Angegeben von:
      replace in Schnittstelle Map<Long,Double>

    • replace

      @Deprecated default Double replace(Long key, Double value)
      Veraltet.
      Angegeben von:
      replace in Schnittstelle Map<Long,Double>

    • applyAsDouble

      default double applyAsDouble(long key)
      Beschreibung aus Schnittstelle kopiert: Long2DoubleFunction
      Type Specific get function to reduce boxing/unboxing
      Angegeben von:
      applyAsDouble in Schnittstelle Long2DoubleFunction
      Angegeben von:
      applyAsDouble in Schnittstelle LongToDoubleFunction
      Parameter:
      key - the value that should be processed
      Gibt zurück:
      the result of the function

    • get

      double get(long key)
      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

      double getOrDefault(long key, double defaultValue)
      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

    • get

      @Deprecated default Double get(Object key)
      Veraltet.
      Angegeben von:
      get in Schnittstelle Map<Long,Double>

    • getOrDefault

      @Deprecated default Double getOrDefault(Object key, Double defaultValue)
      Veraltet.
      Angegeben von:
      getOrDefault in Schnittstelle Map<Long,Double>

    • replaceAll

      @Deprecated default void replaceAll(BiFunction<? super Long,? super Double,? extends Double> mappingFunction)
      Veraltet.
      Angegeben von:
      replaceAll in Schnittstelle Map<Long,Double>

    • compute

      @Deprecated default Double compute(Long key, BiFunction<? super Long,? super Double,? extends Double> mappingFunction)
      Veraltet.
      Angegeben von:
      compute in Schnittstelle Map<Long,Double>

    • computeIfAbsent

      @Deprecated default Double computeIfAbsent(Long key, Function<? super Long,? extends Double> mappingFunction)
      Veraltet.
      Angegeben von:
      computeIfAbsent in Schnittstelle Map<Long,Double>

    • computeIfPresent

      @Deprecated default Double computeIfPresent(Long key, BiFunction<? super Long,? super Double,? extends Double> mappingFunction)
      Veraltet.
      Angegeben von:
      computeIfPresent in Schnittstelle Map<Long,Double>

    • merge

      @Deprecated default Double merge(Long key, Double value, BiFunction<? super Double,? super Double,? extends Double> mappingFunction)
      Veraltet.
      Angegeben von:
      merge in Schnittstelle Map<Long,Double>

    • forEach

      void forEach(LongDoubleConsumer action)
      Type Specific forEach method to reduce boxing/unboxing
      Parameter:
      action - processor of the values that are iterator over

    • forEach

      @Deprecated default void forEach(BiConsumer<? super Long,? super Double> action)
      Veraltet.
      Angegeben von:
      forEach in Schnittstelle Map<Long,Double>

    • keySet

      LongSet keySet()
      Angegeben von:
      keySet in Schnittstelle Map<Long,Double>

    • values

      DoubleCollection values()
      Angegeben von:
      values in Schnittstelle Map<Long,Double>

    • entrySet

      @Deprecated ObjectSet<Map.Entry<Long,Double>> entrySet()
      Veraltet.
      Angegeben von:
      entrySet in Schnittstelle Map<Long,Double>

    • long2DoubleEntrySet

      ObjectSet<Long2DoubleMap.Entry> long2DoubleEntrySet()
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Gibt zurück:
      a EntrySet of the collection

    • synchronize

      default Long2DoubleMap synchronize()
      Creates a Wrapped Map that is Synchronized
      Gibt zurück:
      a new Map that is synchronized
      Siehe auch:

    • synchronize

      default Long2DoubleMap synchronize(Object mutex)
      Creates a Wrapped Map that is Synchronized
      Parameter:
      mutex - is the controller of the synchronization block
      Gibt zurück:
      a new Map Wrapper that is synchronized
      Siehe auch:

    • unmodifiable

      default Long2DoubleMap unmodifiable()
      Creates a Wrapped Map that is unmodifiable
      Gibt zurück:
      a new Map Wrapper that is unmodifiable
      Siehe auch:

    • put

      @Deprecated default Double put(Long key, Double value)
      Veraltet.
      Angegeben von:
      put in Schnittstelle Map<Long,Double>

    • putIfAbsent

      @Deprecated default Double putIfAbsent(Long key, Double value)
      Veraltet.
      Angegeben von:
      putIfAbsent in Schnittstelle Map<Long,Double>