ShortHeapPriorityQueue (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.shorts.queues.AbstractShortPriorityQueue
- - speiger.src.collections.shorts.queues.ShortHeapPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, ShortIterable, ShortPriorityQueue
```
public class ShortHeapPriorityQueue
extends AbstractShortPriorityQueue
```
A Simple Heap base Priority Queue implementation It is a ArrayBased Alternative to TreeSets that has less object allocations

Constructor Summary

Constructors
Constructor and Description
`ShortHeapPriorityQueue()` Default Constructor
`ShortHeapPriorityQueue(int size)` Constructor with a Min Capacity
`ShortHeapPriorityQueue(int size, ShortComparator comp)` Constructor with a Min Capacity and custom Sorter
`ShortHeapPriorityQueue(short[] array)` Constructor using a initial array
`ShortHeapPriorityQueue(short[] array, int size)` Constructor using a initial array
`ShortHeapPriorityQueue(short[] array, int size, ShortComparator comp)` Constructor using a initial array and a custom sorter
`ShortHeapPriorityQueue(short[] array, ShortComparator comp)` Constructor using a initial array and a custom sorter
`ShortHeapPriorityQueue(ShortCollection c)` Constructor using a Collection
`ShortHeapPriorityQueue(ShortCollection c, ShortComparator comp)` Constructor using a Collection and a custom sorter
`ShortHeapPriorityQueue(ShortComparator comp)` Constructor using custom sorter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` clears all elements within the PriorityQueue, this does not resize the backing arrays
`ShortComparator`	`comparator()`
`ShortHeapPriorityQueue`	`copy()` A Function that does a shallow clone of the PriorityQueue itself.
`int`	`count(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to count the valid elements.
`short`	`dequeue()` Method to extract a element from the PriorityQueue
`void`	`enqueue(short e)` Method to insert a element into the PriorityQueue
`short`	`findFirst(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for the first match.
`<E> void`	`forEach(E input, ObjectShortConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`void`	`forEach(ShortConsumer action)` A Type Specific foreach function that reduces (un)boxing
`ShortIterator`	`iterator()` Returns an iterator over elements of type `T`.
`boolean`	`matchesAll(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(Short2BooleanFunction filter)` Helper function to reduce stream usage that allows to filter for no matches.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`short`	`peek(int index)` Peeking function to see whats inside the queue.
`short`	`reduce(short identity, ShortShortUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`short`	`reduce(ShortShortUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`boolean`	`removeFirst(short e)` Removes the first found element in the queue
`boolean`	`removeLast(short e)` Removes the last found element in the queue
`int`	`size()`
`short[]`	`toShortArray(short[] input)` A method to drop the contents of the Queue without clearing the queue
`static ShortHeapPriorityQueue`	`wrap(short[] array)` Wrapping method to help serialization
`static ShortHeapPriorityQueue`	`wrap(short[] array, int size)` Wrapping method to help serialization
`static ShortHeapPriorityQueue`	`wrap(short[] array, int size, ShortComparator comp)` Wrapping method to help serialization, using a custom sorter
`static ShortHeapPriorityQueue`	`wrap(short[] array, ShortComparator comp)` Wrapping method to help serialization, using a custom sorter

Methods inherited from class speiger.src.collections.shorts.queues.AbstractShortPriorityQueue
equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityQueue
enqueueAll, enqueueAll, enqueueAll, enqueueAll, first, isEmpty, synchronizeQueue, synchronizeQueue, toShortArray

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable
arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pour, pourAsList, pourAsSet, sorted, spliterator

- Constructor Detail
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue()
```
    Default Constructor
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(ShortComparator comp)
```
    Constructor using custom sorter
    
    Parameters:
    
    comp - Comparator to sort the Array. Can be null
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(int size)
```
    Constructor with a Min Capacity
    
    Parameters:
    
    size - the initial capacity of the backing array
    
    Throws:
    
    java.lang.IllegalStateException - if the initial size is smaller 0
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(int size,
                              ShortComparator comp)
```
    Constructor with a Min Capacity and custom Sorter
    
    Parameters:
    
    size - the initial capacity of the backing array
    
    comp - Comparator to sort the Array. Can be null
    
    Throws:
    
    java.lang.IllegalStateException - if the initial size is smaller 0
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(short[] array)
```
    Constructor using a initial array
    
    Parameters:
    
    array - the Array that should be used
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(short[] array,
                              int size)
```
    Constructor using a initial array
    
    Parameters:
    
    array - the Array that should be used
    
    size - the amount of elements found within the array
    
    Throws:
    
    java.lang.NegativeArraySizeException - if size is smaller then 0
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(short[] array,
                              ShortComparator comp)
```
    Constructor using a initial array and a custom sorter
    
    Parameters:
    
    array - the Array that should be used
    
    comp - Comparator to sort the Array. Can be null
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(short[] array,
                              int size,
                              ShortComparator comp)
```
    Constructor using a initial array and a custom sorter
    
    Parameters:
    
    array - the Array that should be used
    
    size - the amount of elements found within the array
    
    comp - Comparator to sort the Array. Can be null
    
    Throws:
    
    java.lang.NegativeArraySizeException - if size is smaller then 0
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(ShortCollection c)
```
    Constructor using a Collection
    
    Parameters:
    
    c - the Collection that should be used
  - ShortHeapPriorityQueue
```
public ShortHeapPriorityQueue(ShortCollection c,
                              ShortComparator comp)
```
    Constructor using a Collection and a custom sorter
    
    Parameters:
    
    c - the Collection that should be used
    
    comp - Comparator to sort the Array. Can be null
- Method Detail
  - wrap
```
public static ShortHeapPriorityQueue wrap(short[] array)
```
    Wrapping method to help serialization
    
    Parameters:
    
    array - the array that should be used
    
    Returns:
    
    a HeapPriorityQueue containing the original input array
  - wrap
```
public static ShortHeapPriorityQueue wrap(short[] array,
                                          int size)
```
    Wrapping method to help serialization
    
    Parameters:
    
    array - the array that should be used
    
    size - the amount of elements within the array
    
    Returns:
    
    a HeapPriorityQueue containing the original input array
  - wrap
```
public static ShortHeapPriorityQueue wrap(short[] array,
                                          ShortComparator comp)
```
    Wrapping method to help serialization, using a custom sorter
    
    Parameters:
    
    array - the array that should be used
    
    comp - Comparator to sort the Array. Can be null
    
    Returns:
    
    a HeapPriorityQueue containing the original input array
  - wrap
```
public static ShortHeapPriorityQueue wrap(short[] array,
                                          int size,
                                          ShortComparator comp)
```
    Wrapping method to help serialization, using a custom sorter
    
    Parameters:
    
    array - the array that should be used
    
    size - the amount of elements within the array
    
    comp - Comparator to sort the Array. Can be null
    
    Returns:
    
    a HeapPriorityQueue containing the original input array
  - size
```
public int size()
```
    Returns:
    
    the amount of elements that are stored in the PriorityQueue
  - clear
```
public void clear()
```
    Description copied from interface: ShortPriorityQueue
    
    clears all elements within the PriorityQueue, this does not resize the backing arrays
  - iterator
```
public ShortIterator iterator()
```
    Description copied from interface: ShortIterable
    
    Returns an iterator over elements of type T.
    
    Returns:
    
    an Iterator.
  - enqueue
```
public void enqueue(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - dequeue
```
public short dequeue()
```
    Description copied from interface: ShortPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Returns:
    
    a element from the Queue
  - peek
```
public short peek(int index)
```
    Description copied from interface: ShortPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - removeFirst
```
public boolean removeFirst(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Removes the first found element in the queue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLast
```
public boolean removeLast(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Removes the last found element in the queue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - forEach
```
public void forEach(ShortConsumer action)
```
    Description copied from interface: ShortIterable
    
    A Type Specific foreach function that reduces (un)boxing
    
    Parameters:
    
    action - The action to be performed for each element
    
    See Also:
    
    Iterable.forEach(Consumer)
  - forEach
```
public <E> void forEach(E input,
                        ObjectShortConsumer<E> action)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
  - matchesAny
```
public boolean matchesAny(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - reduce
```
public short reduce(short identity,
                    ShortShortUnaryOperator operator)
```
    Description copied from interface: ShortIterable
    
    Performs a reduction on the elements of this Iterable
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public short reduce(ShortShortUnaryOperator operator)
```
    Description copied from interface: ShortIterable
    
    Performs a reduction on the elements of this Iterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - findFirst
```
public short findFirst(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - count
```
public int count(Short2BooleanFunction filter)
```
    Description copied from interface: ShortIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - onChanged
```
public void onChanged()
```
    Description copied from interface: ShortPriorityQueue
    
    Allows to notify the Queue to be revalidate its data
  - copy
```
public ShortHeapPriorityQueue copy()
```
    Description copied from interface: 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
    
    Returns:
    
    a Shallow Copy of the PriorityQueue
  - comparator
```
public ShortComparator comparator()
```
    Returns:
    
    the sorter of the Queue, can be null
  - toShortArray
```
public short[] toShortArray(short[] input)
```
    Description copied from interface: ShortPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Parameters:
    
    input - where the elements should be inserted to. If it does not fit then it creates a new appropiatly created array
    
    Returns:
    
    the contents of the queue into a seperate array.

Class ShortHeapPriorityQueue

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.shorts.queues.AbstractShortPriorityQueue

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityQueue

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

Constructor Detail

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

ShortHeapPriorityQueue

Method Detail

wrap

wrap

wrap

wrap

size

clear

iterator

enqueue

dequeue

peek

removeFirst

removeLast

forEach

forEach

matchesAny

matchesNone

matchesAll

reduce

reduce

findFirst

count

onChanged

copy

comparator

toShortArray