Modul speiger.src.collections
Package speiger.src.collections.shorts.queues

Klasse ShortArrayFIFOQueue

java.lang.Object
speiger.src.collections.shorts.queues.AbstractShortPriorityQueue
speiger.src.collections.shorts.queues.ShortArrayFIFOQueue
Alle implementierten Schnittstellen:
Iterable<Short>, ShortIterable, ShortPriorityDequeue, ShortPriorityQueue, ITrimmable
public class ShortArrayFIFOQueue extends AbstractShortPriorityQueue implements ShortPriorityDequeue, ITrimmable
A Simple First In First Out Priority Queue that is a Good Replacement for a linked list (or ArrayDequeue) Its specific implementation uses a backing array that grows and shrinks as it is needed.

  • Felddetails

    • MIN_CAPACITY

      public static final int MIN_CAPACITY
      The Minimum Capacity that is allowed
      Siehe auch:

  • Konstruktordetails

    • ShortArrayFIFOQueue

      public ShortArrayFIFOQueue(short[] values)
      Constructor using a initial array
      Parameter:
      values - the Array that should be used

    • ShortArrayFIFOQueue

      public ShortArrayFIFOQueue(short[] values, int size)
      Constructor using a initial array
      Parameter:
      values - the Array that should be used
      size - the amount of elements that are in the initial array
      Löst aus:
      IllegalStateException - if values is smaller then size

    • ShortArrayFIFOQueue

      public ShortArrayFIFOQueue(short[] values, int offset, int size)
      Constructor using a initial array
      Parameter:
      values - the Array that should be used
      offset - where to begin in the initial array
      size - the amount of elements that are in the initial array
      Löst aus:
      IllegalStateException - if values is smaller then size

    • ShortArrayFIFOQueue

      public ShortArrayFIFOQueue(int capacity)
      Constructor with a Min Capacity
      Parameter:
      capacity - the initial capacity of the backing array
      Löst aus:
      IllegalStateException - if the initial size is smaller 0

    • ShortArrayFIFOQueue

      public ShortArrayFIFOQueue()
      Default Construtor

  • Methodendetails

    • iterator

      public ShortIterator iterator()
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Returns an iterator over elements of type T.
      Angegeben von:
      iterator in Schnittstelle Iterable<Short>
      Angegeben von:
      iterator in Schnittstelle ShortIterable
      Gibt zurück:
      an Iterator.

    • size

      public int size()
      Angegeben von:
      size in Schnittstelle ShortPriorityQueue
      Gibt zurück:
      the amount of elements that are stored in the PriorityQueue

    • clear

      public void clear()
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      clears all elements within the PriorityQueue, this does not resize the backing arrays
      Angegeben von:
      clear in Schnittstelle ShortPriorityQueue

    • enqueue

      public void enqueue(short e)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Method to insert a element into the PriorityQueue
      Angegeben von:
      enqueue in Schnittstelle ShortPriorityQueue
      Parameter:
      e - the element that should be inserted

    • enqueueFirst

      public void enqueueFirst(short e)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityDequeue
      Method to insert a element into the first Index instead of the last.
      Angegeben von:
      enqueueFirst in Schnittstelle ShortPriorityDequeue
      Parameter:
      e - the element that should be inserted into the first place

    • dequeue

      public short dequeue()
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Method to extract a element from the PriorityQueue
      Angegeben von:
      dequeue in Schnittstelle ShortPriorityQueue
      Gibt zurück:
      a element from the Queue

    • dequeueLast

      public short dequeueLast()
      Beschreibung aus Schnittstelle kopiert: ShortPriorityDequeue
      A Method to remove a element from the last place instead of the first
      Angegeben von:
      dequeueLast in Schnittstelle ShortPriorityDequeue
      Gibt zurück:
      the last element inserted

    • peek

      public short peek(int index)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Peeking function to see whats inside the queue.
      Angegeben von:
      peek in Schnittstelle ShortPriorityQueue
      Parameter:
      index - of the element that is requested to be viewed.
      Gibt zurück:
      the element that is requested

    • contains

      public boolean contains(short e)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Method to find out if a element is part of the queue
      Angegeben von:
      contains in Schnittstelle ShortPriorityQueue
      Parameter:
      e - the element that is searched for
      Gibt zurück:
      true if the element is in the queue

    • removeFirst

      public boolean removeFirst(short e)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Removes the first found element in the queue
      Angegeben von:
      removeFirst in Schnittstelle ShortPriorityQueue
      Parameter:
      e - the element that should be removed
      Gibt zurück:
      if a searched element was removed

    • removeLast

      public boolean removeLast(short e)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Removes the last found element in the queue
      Angegeben von:
      removeLast in Schnittstelle ShortPriorityQueue
      Parameter:
      e - the element that should be removed
      Gibt zurück:
      if a searched element was removed

    • onChanged

      public void onChanged()
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      Allows to notify the Queue to be revalidate its data
      Angegeben von:
      onChanged in Schnittstelle ShortPriorityQueue

    • copy

      public ShortArrayFIFOQueue copy()
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      A Function that does a shallow clone of the PriorityQueue itself. This function is more optimized then a copy constructor since the PriorityQueue does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
      Angegeben von:
      copy in Schnittstelle ShortPriorityDequeue
      Angegeben von:
      copy in Schnittstelle ShortPriorityQueue
      Gibt zurück:
      a Shallow Copy of the PriorityQueue

    • comparator

      public ShortComparator comparator()
      Angegeben von:
      comparator in Schnittstelle ShortPriorityQueue
      Gibt zurück:
      the sorter of the Queue, can be null

    • forEach

      public void forEach(ShortConsumer action)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      A Type Specific foreach function that reduces (un)boxing
      Angegeben von:
      forEach in Schnittstelle ShortIterable
      Parameter:
      action - The action to be performed for each element
      Siehe auch:

    • forEachIndexed

      public void forEachIndexed(IntShortConsumer action)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
      Angegeben von:
      forEachIndexed in Schnittstelle ShortIterable
      Parameter:
      action - The action to be performed for each element

    • forEach

      public <E> void forEach(E input, ObjectShortConsumer<E> action)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
      Angegeben von:
      forEach in Schnittstelle ShortIterable
      Typparameter:
      E - the generic type of the Object
      Parameter:
      input - the object that should be included
      action - The action to be performed for each element

    • matchesAny

      public boolean matchesAny(ShortPredicate filter)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Helper function to reduce stream usage that allows to filter for any matches.
      Angegeben von:
      matchesAny in Schnittstelle ShortIterable
      Parameter:
      filter - that should be applied
      Gibt zurück:
      true if any matches were found

    • matchesNone

      public boolean matchesNone(ShortPredicate filter)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Helper function to reduce stream usage that allows to filter for no matches.
      Angegeben von:
      matchesNone in Schnittstelle ShortIterable
      Parameter:
      filter - that should be applied
      Gibt zurück:
      true if no matches were found

    • matchesAll

      public boolean matchesAll(ShortPredicate filter)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Helper function to reduce stream usage that allows to filter for all matches.
      Angegeben von:
      matchesAll in Schnittstelle ShortIterable
      Parameter:
      filter - that should be applied
      Gibt zurück:
      true if all matches.

    • findFirst

      public short findFirst(ShortPredicate filter)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Helper function to reduce stream usage that allows to filter for the first match.
      Angegeben von:
      findFirst in Schnittstelle ShortIterable
      Parameter:
      filter - that should be applied
      Gibt zurück:
      the found value or the null equivalent variant.

    • reduce

      public short reduce(short identity, ShortShortUnaryOperator operator)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Performs a reduction on the elements of this Iterable
      Angegeben von:
      reduce in Schnittstelle ShortIterable
      Parameter:
      identity - the start value
      operator - the operation that should be applied
      Gibt zurück:
      the reduction result, returns identity if nothing was found

    • reduce

      public short reduce(ShortShortUnaryOperator operator)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Performs a reduction on the elements of this Iterable
      Angegeben von:
      reduce in Schnittstelle ShortIterable
      Parameter:
      operator - the operation that should be applied
      Gibt zurück:
      the reduction result, returns null value if nothing was found

    • count

      public int count(ShortPredicate filter)
      Beschreibung aus Schnittstelle kopiert: ShortIterable
      Helper function to reduce stream usage that allows to count the valid elements.
      Angegeben von:
      count in Schnittstelle ShortIterable
      Parameter:
      filter - that should be applied
      Gibt zurück:
      the amount of Valid Elements

    • 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)
      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
      Note:
      this will enforce minimum size of the collection itself

    • toShortArray

      public short[] toShortArray(short[] input)
      Beschreibung aus Schnittstelle kopiert: ShortPriorityQueue
      A method to drop the contents of the Queue without clearing the queue
      Angegeben von:
      toShortArray in Schnittstelle ShortPriorityQueue
      Parameter:
      input - where the elements should be inserted to. If it does not fit then it creates a new appropiatly created array
      Gibt zurück:
      the contents of the queue into a seperate array.