IntHeapPriorityQueue (Primitive-Collections 0.2.0 API)

java.lang.Object
- speiger.src.collections.ints.queues.IntHeapPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>, IntIterable, IntPriorityQueue, ObjectPriorityQueue<java.lang.Integer>
```
public class IntHeapPriorityQueue
extends java.lang.Object
implements IntPriorityQueue
```
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
`IntHeapPriorityQueue()` Default Constructor
`IntHeapPriorityQueue(int size)` Constructor with a Min Capacity
`IntHeapPriorityQueue(int[] array)` Constructor using a initial array
`IntHeapPriorityQueue(int[] array, int size)` Constructor using a initial array
`IntHeapPriorityQueue(int[] array, IntComparator comp)` Constructor using a initial array and a custom sorter
`IntHeapPriorityQueue(int[] array, int size, IntComparator comp)` Constructor using a initial array and a custom sorter
`IntHeapPriorityQueue(IntCollection c)` Constructor using a Collection
`IntHeapPriorityQueue(IntCollection c, IntComparator comp)` Constructor using a Collection and a custom sorter
`IntHeapPriorityQueue(IntComparator comp)` Constructor using custom sorter
`IntHeapPriorityQueue(int size, IntComparator 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
`IntComparator`	`comparator()`
`int`	`dequeueInt()` Method to extract a element from the PriorityQueue
`void`	`enqueueInt(int e)` Method to insert a element into the PriorityQueue
`IntIterator`	`iterator()` Returns an iterator over elements of type `T`.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`int`	`peekInt(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeInt(int e)` Removes the first found element in the queue
`boolean`	`removeLastInt(int e)` Removes the last found element in the queue
`int`	`size()`
`java.lang.Integer[]`	`toArray(java.lang.Integer[] input)` A method to drop the contents of the Queue without clearing the queue
`int[]`	`toIntArray(int[] input)` A method to drop the contents of the Queue without clearing the queue
`static IntHeapPriorityQueue`	`wrap(int[] array)` Wrapping method to help serialization
`static IntHeapPriorityQueue`	`wrap(int[] array, int size)` Wrapping method to help serialization
`static IntHeapPriorityQueue`	`wrap(int[] array, IntComparator comp)` Wrapping method to help serialization, using a custom sorter
`static IntHeapPriorityQueue`	`wrap(int[] array, int size, IntComparator 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.ints.queues.IntPriorityQueue
dequeue, enqueue, first, firstInt, peek, remove, removeLast, toArray, toIntArray

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

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable
forEach, forEach, spliterator

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.ints.queues.IntPriorityQueue

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

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

Constructor Detail

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

IntHeapPriorityQueue

Method Detail

wrap

wrap

wrap

wrap

size

clear

iterator

enqueueInt

dequeueInt

peekInt

removeInt

removeLastInt

onChanged

comparator

toIntArray

toArray