ShortHeapPriorityQueue (Primitive-Collections 0.2.0 API)

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

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, ObjectPriorityQueue<java.lang.Short>, ShortIterable, ShortPriorityQueue
```
public class ShortHeapPriorityQueue
extends java.lang.Object
implements ShortPriorityQueue
```
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()`
`short`	`dequeueShort()` Method to extract a element from the PriorityQueue
`void`	`enqueueShort(short e)` Method to insert a element into the PriorityQueue
`ShortIterator`	`iterator()` Returns an iterator over elements of type `T`.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`short`	`peekShort(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeLastShort(short e)` Removes the last found element in the queue
`boolean`	`removeShort(short e)` Removes the first found element in the queue
`int`	`size()`
`java.lang.Short[]`	`toArray(java.lang.Short[] input)` A method to drop the contents of the Queue without clearing the queue
`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 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityQueue
dequeue, enqueue, first, firstShort, peek, remove, removeLast, toArray, toShortArray

Methods inherited from interface speiger.src.collections.objects.queues.ObjectPriorityQueue
isEmpty

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable
forEach, forEach, 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()
```
    Specified by:
    
    size in interface ObjectPriorityQueue<java.lang.Short>
    
    Returns:
    
    the amount of elements that are stored in the PriorityQueue
  - clear
```
public void clear()
```
    Description copied from interface: ObjectPriorityQueue
    
    clears all elements within the PriorityQueue, this does not resize the backing arrays
    
    Specified by:
    
    clear in interface ObjectPriorityQueue<java.lang.Short>
  - iterator
```
public ShortIterator iterator()
```
    Description copied from interface: ShortIterable
    
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Short>
    
    Specified by:
    
    iterator in interface ShortIterable
    
    Returns:
    
    an Iterator.
  - enqueueShort
```
public void enqueueShort(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueueShort in interface ShortPriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - dequeueShort
```
public short dequeueShort()
```
    Description copied from interface: ShortPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeueShort in interface ShortPriorityQueue
    
    Returns:
    
    a element from the Queue
  - peekShort
```
public short peekShort(int index)
```
    Description copied from interface: ShortPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peekShort in interface ShortPriorityQueue
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - removeShort
```
public boolean removeShort(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    removeShort in interface ShortPriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLastShort
```
public boolean removeLastShort(short e)
```
    Description copied from interface: ShortPriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLastShort in interface ShortPriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
public void onChanged()
```
    Description copied from interface: ShortPriorityQueue
    
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface ObjectPriorityQueue<java.lang.Short>
    
    Specified by:
    
    onChanged in interface ShortPriorityQueue
  - comparator
```
public ShortComparator comparator()
```
    Specified by:
    
    comparator in interface ObjectPriorityQueue<java.lang.Short>
    
    Specified by:
    
    comparator in interface ShortPriorityQueue
    
    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
    
    Specified by:
    
    toShortArray in interface ShortPriorityQueue
    
    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.
  - toArray
```
public java.lang.Short[] toArray(java.lang.Short[] input)
```
    Description copied from interface: ObjectPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toArray in interface ObjectPriorityQueue<java.lang.Short>
    
    Specified by:
    
    toArray in interface ShortPriorityQueue
    
    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 java.lang.Object

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

Methods inherited from interface speiger.src.collections.objects.queues.ObjectPriorityQueue

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

enqueueShort

dequeueShort

peekShort

removeShort

removeLastShort

onChanged

comparator

toShortArray

toArray