DoubleHeapPriorityQueue (Primitive-Collections 0.2.0 API)

java.lang.Object
- speiger.src.collections.doubles.queues.DoubleHeapPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Double>, DoubleIterable, DoublePriorityQueue, ObjectPriorityQueue<java.lang.Double>
```
public class DoubleHeapPriorityQueue
extends java.lang.Object
implements DoublePriorityQueue
```
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
`DoubleHeapPriorityQueue()` Default Constructor
`DoubleHeapPriorityQueue(double[] array)` Constructor using a initial array
`DoubleHeapPriorityQueue(double[] array, DoubleComparator comp)` Constructor using a initial array and a custom sorter
`DoubleHeapPriorityQueue(double[] array, int size)` Constructor using a initial array
`DoubleHeapPriorityQueue(double[] array, int size, DoubleComparator comp)` Constructor using a initial array and a custom sorter
`DoubleHeapPriorityQueue(DoubleCollection c)` Constructor using a Collection
`DoubleHeapPriorityQueue(DoubleCollection c, DoubleComparator comp)` Constructor using a Collection and a custom sorter
`DoubleHeapPriorityQueue(DoubleComparator comp)` Constructor using custom sorter
`DoubleHeapPriorityQueue(int size)` Constructor with a Min Capacity
`DoubleHeapPriorityQueue(int size, DoubleComparator comp)` Constructor with a Min Capacity and 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
`DoubleComparator`	`comparator()`
`double`	`dequeueDouble()` Method to extract a element from the PriorityQueue
`void`	`enqueueDouble(double e)` Method to insert a element into the PriorityQueue
`DoubleIterator`	`iterator()` Returns an iterator over elements of type `T`.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`double`	`peekDouble(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeDouble(double e)` Removes the first found element in the queue
`boolean`	`removeLastDouble(double e)` Removes the last found element in the queue
`int`	`size()`
`java.lang.Double[]`	`toArray(java.lang.Double[] input)` A method to drop the contents of the Queue without clearing the queue
`double[]`	`toDoubleArray(double[] input)` A method to drop the contents of the Queue without clearing the queue
`static DoubleHeapPriorityQueue`	`wrap(double[] array)` Wrapping method to help serialization
`static DoubleHeapPriorityQueue`	`wrap(double[] array, DoubleComparator comp)` Wrapping method to help serialization, using a custom sorter
`static DoubleHeapPriorityQueue`	`wrap(double[] array, int size)` Wrapping method to help serialization
`static DoubleHeapPriorityQueue`	`wrap(double[] array, int size, DoubleComparator 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.doubles.queues.DoublePriorityQueue
dequeue, enqueue, first, firstDouble, peek, remove, removeLast, toArray, toDoubleArray

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

Methods inherited from interface speiger.src.collections.doubles.collections.DoubleIterable
forEach, forEach, spliterator

- Constructor Detail
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue()
```
    Default Constructor
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(DoubleComparator comp)
```
    Constructor using custom sorter
    
    Parameters:
    
    comp - Comparator to sort the Array. Can be null
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(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
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(int size,
                               DoubleComparator 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
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(double[] array)
```
    Constructor using a initial array
    
    Parameters:
    
    array - the Array that should be used
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(double[] 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
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(double[] array,
                               DoubleComparator 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
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(double[] array,
                               int size,
                               DoubleComparator 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
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(DoubleCollection c)
```
    Constructor using a Collection
    
    Parameters:
    
    c - the Collection that should be used
  - DoubleHeapPriorityQueue
```
public DoubleHeapPriorityQueue(DoubleCollection c,
                               DoubleComparator 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 DoubleHeapPriorityQueue wrap(double[] 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 DoubleHeapPriorityQueue wrap(double[] 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 DoubleHeapPriorityQueue wrap(double[] array,
                                           DoubleComparator 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 DoubleHeapPriorityQueue wrap(double[] array,
                                           int size,
                                           DoubleComparator 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.Double>
    
    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.Double>
  - iterator
```
public DoubleIterator iterator()
```
    Description copied from interface: DoubleIterable
    
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Double>
    
    Specified by:
    
    iterator in interface DoubleIterable
    
    Returns:
    
    an Iterator.
  - enqueueDouble
```
public void enqueueDouble(double e)
```
    Description copied from interface: DoublePriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueueDouble in interface DoublePriorityQueue
    
    Parameters:
    
    e - the element that should be inserted
  - dequeueDouble
```
public double dequeueDouble()
```
    Description copied from interface: DoublePriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeueDouble in interface DoublePriorityQueue
    
    Returns:
    
    a element from the Queue
  - peekDouble
```
public double peekDouble(int index)
```
    Description copied from interface: DoublePriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peekDouble in interface DoublePriorityQueue
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - removeDouble
```
public boolean removeDouble(double e)
```
    Description copied from interface: DoublePriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    removeDouble in interface DoublePriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLastDouble
```
public boolean removeLastDouble(double e)
```
    Description copied from interface: DoublePriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLastDouble in interface DoublePriorityQueue
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
public void onChanged()
```
    Description copied from interface: DoublePriorityQueue
    
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface DoublePriorityQueue
    
    Specified by:
    
    onChanged in interface ObjectPriorityQueue<java.lang.Double>
  - comparator
```
public DoubleComparator comparator()
```
    Specified by:
    
    comparator in interface DoublePriorityQueue
    
    Specified by:
    
    comparator in interface ObjectPriorityQueue<java.lang.Double>
    
    Returns:
    
    the sorter of the Queue, can be null
  - toDoubleArray
```
public double[] toDoubleArray(double[] input)
```
    Description copied from interface: DoublePriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toDoubleArray in interface DoublePriorityQueue
    
    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.Double[] toArray(java.lang.Double[] input)
```
    Description copied from interface: ObjectPriorityQueue
    
    A method to drop the contents of the Queue without clearing the queue
    
    Specified by:
    
    toArray in interface DoublePriorityQueue
    
    Specified by:
    
    toArray in interface ObjectPriorityQueue<java.lang.Double>
    
    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 DoubleHeapPriorityQueue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.doubles.queues.DoublePriorityQueue

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

Methods inherited from interface speiger.src.collections.doubles.collections.DoubleIterable

Constructor Detail

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

DoubleHeapPriorityQueue

Method Detail

wrap

wrap

wrap

wrap

size

clear

iterator

enqueueDouble

dequeueDouble

peekDouble

removeDouble

removeLastDouble

onChanged

comparator

toDoubleArray

toArray