ObjectHeapPriorityQueue (Primitive-Collections 0.2.0 API)

java.lang.Object
- speiger.src.collections.objects.queues.ObjectHeapPriorityQueue<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.lang.Iterable<T>, ObjectPriorityQueue<T>
```
public class ObjectHeapPriorityQueue<T>
extends java.lang.Object
implements ObjectPriorityQueue<T>
```
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
`ObjectHeapPriorityQueue()` Default Constructor
`ObjectHeapPriorityQueue(java.util.Comparator<? super T> comp)` Constructor using custom sorter
`ObjectHeapPriorityQueue(int size)` Constructor with a Min Capacity
`ObjectHeapPriorityQueue(int size, java.util.Comparator<? super T> comp)` Constructor with a Min Capacity and custom Sorter
`ObjectHeapPriorityQueue(ObjectCollection<T> c)` Constructor using a Collection
`ObjectHeapPriorityQueue(ObjectCollection<T> c, java.util.Comparator<? super T> comp)` Constructor using a Collection and a custom sorter
`ObjectHeapPriorityQueue(T[] array)` Constructor using a initial array
`ObjectHeapPriorityQueue(T[] array, java.util.Comparator<? super T> comp)` Constructor using a initial array and a custom sorter
`ObjectHeapPriorityQueue(T[] array, int size)` Constructor using a initial array
`ObjectHeapPriorityQueue(T[] array, int size, java.util.Comparator<? super T> comp)` Constructor using a initial array and a 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
`java.util.Comparator<? super T>`	`comparator()`
`T`	`dequeue()` Method to extract a element from the PriorityQueue
`void`	`enqueue(T e)` Method to insert a element into the PriorityQueue
`ObjectIterator<T>`	`iterator()`
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`T`	`peek(int index)` Peeking function to see whats inside the queue.
`boolean`	`remove(T e)` Removes the first found element in the queue
`boolean`	`removeLast(T e)` Removes the last found element in the queue
`int`	`size()`
`T[]`	`toArray(T[] input)` A method to drop the contents of the Queue without clearing the queue
`static <T> ObjectHeapPriorityQueue<T>`	`wrap(T[] array)` Wrapping method to help serialization
`static <T> ObjectHeapPriorityQueue<T>`	`wrap(T[] array, java.util.Comparator<? super T> comp)` Wrapping method to help serialization, using a custom sorter
`static <T> ObjectHeapPriorityQueue<T>`	`wrap(T[] array, int size)` Wrapping method to help serialization
`static <T> ObjectHeapPriorityQueue<T>`	`wrap(T[] array, int size, java.util.Comparator<? super T> 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.objects.queues.ObjectPriorityQueue
first, isEmpty, toArray

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue()
```
    Default Constructor
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(java.util.Comparator<? super T> comp)
```
    Constructor using custom sorter
    
    Parameters:
    
    comp - Comparator to sort the Array. Can be null
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(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
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(int size,
                               java.util.Comparator<? super T> 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
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(T[] array)
```
    Constructor using a initial array
    
    Parameters:
    
    array - the Array that should be used
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(T[] 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
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(T[] array,
                               java.util.Comparator<? super T> 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
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(T[] array,
                               int size,
                               java.util.Comparator<? super T> 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
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(ObjectCollection<T> c)
```
    Constructor using a Collection
    
    Parameters:
    
    c - the Collection that should be used
  - ObjectHeapPriorityQueue
```
public ObjectHeapPriorityQueue(ObjectCollection<T> c,
                               java.util.Comparator<? super T> 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 <T> ObjectHeapPriorityQueue<T> wrap(T[] array)
```
    Wrapping method to help serialization
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    Parameters:
    
    array - the array that should be used
    
    Returns:
    
    a HeapPriorityQueue containing the original input array
  - wrap
```
public static <T> ObjectHeapPriorityQueue<T> wrap(T[] array,
                                                  int size)
```
    Wrapping method to help serialization
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectHeapPriorityQueue<T> wrap(T[] array,
                                                  java.util.Comparator<? super T> comp)
```
    Wrapping method to help serialization, using a custom sorter
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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 <T> ObjectHeapPriorityQueue<T> wrap(T[] array,
                                                  int size,
                                                  java.util.Comparator<? super T> comp)
```
    Wrapping method to help serialization, using a custom sorter
    
    Type Parameters:
    
    T - the type of elements maintained by this Collection
    
    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<T>
    
    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<T>
  - iterator
```
public ObjectIterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - enqueue
```
public void enqueue(T e)
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to insert a element into the PriorityQueue
    
    Specified by:
    
    enqueue in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    e - the element that should be inserted
  - dequeue
```
public T dequeue()
```
    Description copied from interface: ObjectPriorityQueue
    
    Method to extract a element from the PriorityQueue
    
    Specified by:
    
    dequeue in interface ObjectPriorityQueue<T>
    
    Returns:
    
    a element from the Queue
  - peek
```
public T peek(int index)
```
    Description copied from interface: ObjectPriorityQueue
    
    Peeking function to see whats inside the queue.
    
    Specified by:
    
    peek in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    index - of the element that is requested to be viewed.
    
    Returns:
    
    the element that is requested
  - remove
```
public boolean remove(T e)
```
    Description copied from interface: ObjectPriorityQueue
    
    Removes the first found element in the queue
    
    Specified by:
    
    remove in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - removeLast
```
public boolean removeLast(T e)
```
    Description copied from interface: ObjectPriorityQueue
    
    Removes the last found element in the queue
    
    Specified by:
    
    removeLast in interface ObjectPriorityQueue<T>
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    if a searched element was removed
  - onChanged
```
public void onChanged()
```
    Description copied from interface: ObjectPriorityQueue
    
    Allows to notify the Queue to be revalidate its data
    
    Specified by:
    
    onChanged in interface ObjectPriorityQueue<T>
  - comparator
```
public java.util.Comparator<? super T> comparator()
```
    Specified by:
    
    comparator in interface ObjectPriorityQueue<T>
    
    Returns:
    
    the sorter of the Queue, can be null
  - toArray
```
public T[] toArray(T[] 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<T>
    
    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 ObjectHeapPriorityQueue<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Constructor Detail

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

ObjectHeapPriorityQueue

Method Detail

wrap

wrap

wrap

wrap

size

clear

iterator

enqueue

dequeue

peek

remove

removeLast

onChanged

comparator

toArray