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

Klasse Short2IntArrayMap

java.lang.Object
java.util.AbstractMap<Short,Integer>
speiger.src.collections.shorts.maps.abstracts.AbstractShort2IntMap
speiger.src.collections.shorts.maps.impl.misc.Short2IntArrayMap
Alle implementierten Schnittstellen:
Map<Short,Integer>, Short2IntFunction, Short2IntMap, Short2IntOrderedMap
public class Short2IntArrayMap extends AbstractShort2IntMap implements Short2IntOrderedMap
A Very Specific Type Specific implementation of a ArrayMap. This type of map is for very specific use cases that usaully would have lead to Tupled Lists otherwise. It also does not allow duplication (except for array constructors) and checks from last to first. It is not designed to be used as a HashMap replacement due to the poor performance it would cause.
Note:
in this implementation SubMaps do NOT keep track of parent changes fully. For performance reasons it will just have a start/end index and not values Anything within that range will be updated appropiatly a shrink/growth of elements will break SubMaps in some ways. This can be useful but be careful, this implementation does not shrink and only grows.

  • Konstruktordetails

    • Short2IntArrayMap

      public Short2IntArrayMap()
      Default Constructor

    • Short2IntArrayMap

      public Short2IntArrayMap(int minCapacity)
      Constructor that defines the minimum capacity
      Parameter:
      minCapacity - the minimum capacity the HashMap is allowed to be.
      Löst aus:
      IllegalStateException - if the minimum capacity is negative

    • Short2IntArrayMap

      public Short2IntArrayMap(Short[] keys, Integer[] values)
      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.
      Löst aus:
      IllegalStateException - if the keys and values do not match in length

    • Short2IntArrayMap

      public Short2IntArrayMap(Short[] keys, Integer[] values, int length)
      Helper constructor that allow to create a map from boxed values (it will unbox them) with a custom length
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      length - the amount of values that should be pulled from the array
      Löst aus:
      IllegalStateException - if the keys and values do not match in length

    • Short2IntArrayMap

      public Short2IntArrayMap(short[] keys, int[] values)
      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.
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • Short2IntArrayMap

      public Short2IntArrayMap(short[] keys, int[] values, int length)
      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.
      length - the amount of values that should be pulled from the array
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • Short2IntArrayMap

      public Short2IntArrayMap(Map<? extends Short,? extends Integer> map)
      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

    • Short2IntArrayMap

      public Short2IntArrayMap(Short2IntMap map)
      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

  • Methodendetails

    • put

      public int put(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Short2IntMap
      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 int putIfAbsent(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Short2IntMap
      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 int addTo(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Angegeben von:
      addTo in Schnittstelle Short2IntMap
      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 int subFrom(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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 Short2IntMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Angegeben von:
      subFrom in Schnittstelle Short2IntMap
      Parameter:
      key - that should be subtract from
      value - that should be subtract
      Gibt zurück:
      the last present or default return value

    • putAndMoveToFirst

      public int putAndMoveToFirst(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A customized put method that allows you to insert into the first index.
      Angegeben von:
      putAndMoveToFirst in Schnittstelle Short2IntOrderedMap
      Parameter:
      key - the key that should be inserted
      value - the value that should be inserted
      Gibt zurück:
      the previous present or default return value
      Siehe auch:

    • putAndMoveToLast

      public int putAndMoveToLast(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
      Angegeben von:
      putAndMoveToLast in Schnittstelle Short2IntOrderedMap
      Parameter:
      key - the key that should be inserted
      value - the value that should be inserted
      Gibt zurück:
      the previous present or default return value
      Siehe auch:

    • moveToFirst

      public boolean moveToFirst(short key)
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A specific move method to move a given key/value to the first index.
      Angegeben von:
      moveToFirst in Schnittstelle Short2IntOrderedMap
      Parameter:
      key - that should be moved to the first index
      Gibt zurück:
      true if the value was moved.

    • moveToLast

      public boolean moveToLast(short key)
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A specific move method to move a given key/value to the last index.
      Angegeben von:
      moveToLast in Schnittstelle Short2IntOrderedMap
      Parameter:
      key - that should be moved to the first last
      Gibt zurück:
      true if the value was moved.

    • containsKey

      public boolean containsKey(short key)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsKey in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      containsKey in Klasse AbstractShort2IntMap
      Parameter:
      key - element that is searched for
      Gibt zurück:
      if the key is present

    • containsValue

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

    • containsKey

      public boolean containsKey(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<Short,Integer>
      Angegeben von:
      containsKey in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      containsKey in Klasse AbstractMap<Short,Integer>
      Parameter:
      key - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:

    • containsValue

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

    • get

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

    • getOrDefault

      public int getOrDefault(short key, int defaultValue)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Angegeben von:
      getOrDefault in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      getOrDefault in Klasse AbstractShort2IntMap
      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

    • getAndMoveToFirst

      public int getAndMoveToFirst(short key)
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A Specific get method that allows to move teh given key/value int the first index.
      Angegeben von:
      getAndMoveToFirst in Schnittstelle Short2IntOrderedMap
      Parameter:
      key - that is searched for
      Gibt zurück:
      the given value for the requested key or default return value

    • getAndMoveToLast

      public int getAndMoveToLast(short key)
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A Specific get method that allows to move teh given key/value int the last index.
      Angegeben von:
      getAndMoveToLast in Schnittstelle Short2IntOrderedMap
      Parameter:
      key - that is searched for
      Gibt zurück:
      the given value for the requested key or default return value

    • firstShortKey

      public short firstShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A method to get the first Key of a Map.
      Angegeben von:
      firstShortKey in Schnittstelle Short2IntOrderedMap
      Gibt zurück:
      the first key in the map

    • lastShortKey

      public short lastShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A method to get the last Key of a Map.
      Angegeben von:
      lastShortKey in Schnittstelle Short2IntOrderedMap
      Gibt zurück:
      the last key in the map

    • firstIntValue

      public int firstIntValue()
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A method to get the first Value of a Map.
      Angegeben von:
      firstIntValue in Schnittstelle Short2IntOrderedMap
      Gibt zurück:
      the first key in the map

    • lastIntValue

      public int lastIntValue()
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A method to get the last Value of a Map.
      Angegeben von:
      lastIntValue in Schnittstelle Short2IntOrderedMap
      Gibt zurück:
      the last key in the map

    • pollFirstShortKey

      public short pollFirstShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A method to get and remove the first Key of a Map.
      Angegeben von:
      pollFirstShortKey in Schnittstelle Short2IntOrderedMap
      Gibt zurück:
      the first key in the map

    • pollLastShortKey

      public short pollLastShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2IntOrderedMap
      A method to get and remove the last Key of a Map.
      Angegeben von:
      pollLastShortKey in Schnittstelle Short2IntOrderedMap
      Gibt zurück:
      the last key in the map

    • remove

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

    • removeOrDefault

      public int removeOrDefault(short key, int defaultValue)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      removeOrDefault in Schnittstelle Short2IntMap
      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(short key, int value)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Short2IntMap
      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 Integer remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<Short,Integer>
      Angegeben von:
      remove in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      remove in Klasse AbstractShort2IntMap
      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(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<Short,Integer>
      Angegeben von:
      remove in Schnittstelle Short2IntMap
      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:

    • forEach

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

    • keySet

      public ShortOrderedSet keySet()
      Angegeben von:
      keySet in Schnittstelle Map<Short,Integer>
      Angegeben von:
      keySet in Schnittstelle Short2IntMap
      Angegeben von:
      keySet in Schnittstelle Short2IntOrderedMap
      Setzt außer Kraft:
      keySet in Klasse AbstractShort2IntMap

    • values

      public IntCollection values()
      Angegeben von:
      values in Schnittstelle Map<Short,Integer>
      Angegeben von:
      values in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      values in Klasse AbstractShort2IntMap

    • short2IntEntrySet

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

    • replace

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

    • computeInt

      public int computeInt(short key, ShortIntUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      computeInt in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      computeInt in Klasse AbstractShort2IntMap
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeIntIfAbsent

      public int computeIntIfAbsent(short key, Short2IntFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      computeIntIfAbsent in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      computeIntIfAbsent in Klasse AbstractShort2IntMap
      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

    • supplyIntIfAbsent

      public int supplyIntIfAbsent(short key, IntSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      supplyIntIfAbsent in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      supplyIntIfAbsent in Klasse AbstractShort2IntMap
      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

    • computeIntIfPresent

      public int computeIntIfPresent(short key, ShortIntUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      computeIntIfPresent in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      computeIntIfPresent in Klasse AbstractShort2IntMap
      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

    • computeIntNonDefault

      public int computeIntNonDefault(short key, ShortIntUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      computeIntNonDefault in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      computeIntNonDefault in Klasse AbstractShort2IntMap
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeIntIfAbsentNonDefault

      public int computeIntIfAbsentNonDefault(short key, Short2IntFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      computeIntIfAbsentNonDefault in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      computeIntIfAbsentNonDefault in Klasse AbstractShort2IntMap
      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

    • supplyIntIfAbsentNonDefault

      public int supplyIntIfAbsentNonDefault(short key, IntSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      supplyIntIfAbsentNonDefault in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      supplyIntIfAbsentNonDefault in Klasse AbstractShort2IntMap
      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

    • computeIntIfPresentNonDefault

      public int computeIntIfPresentNonDefault(short key, ShortIntUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      computeIntIfPresentNonDefault in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      computeIntIfPresentNonDefault in Klasse AbstractShort2IntMap
      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

    • mergeInt

      public int mergeInt(short key, int value, IntIntUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      mergeInt in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      mergeInt in Klasse AbstractShort2IntMap
      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

    • mergeAllInt

      public void mergeAllInt(Short2IntMap m, IntIntUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2IntMap
      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:
      mergeAllInt in Schnittstelle Short2IntMap
      Setzt außer Kraft:
      mergeAllInt in Klasse AbstractShort2IntMap
      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<Short,Integer>
      Setzt außer Kraft:
      size in Klasse AbstractMap<Short,Integer>

    • clear

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

    • copy

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