CharHeapPriorityQueue (Primitive-Collections 0.2.0 API)

java.lang.Object
- speiger.src.collections.chars.queues.CharHeapPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, CharIterable, CharPriorityQueue, ObjectPriorityQueue<java.lang.Character>
```
public class CharHeapPriorityQueue
extends java.lang.Object
implements CharPriorityQueue
```
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
`CharHeapPriorityQueue()` Default Constructor
`CharHeapPriorityQueue(char[] array)` Constructor using a initial array
`CharHeapPriorityQueue(char[] array, CharComparator comp)` Constructor using a initial array and a custom sorter
`CharHeapPriorityQueue(char[] array, int size)` Constructor using a initial array
`CharHeapPriorityQueue(char[] array, int size, CharComparator comp)` Constructor using a initial array and a custom sorter
`CharHeapPriorityQueue(CharCollection c)` Constructor using a Collection
`CharHeapPriorityQueue(CharCollection c, CharComparator comp)` Constructor using a Collection and a custom sorter
`CharHeapPriorityQueue(CharComparator comp)` Constructor using custom sorter
`CharHeapPriorityQueue(int size)` Constructor with a Min Capacity
`CharHeapPriorityQueue(int size, CharComparator 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
`CharComparator`	`comparator()`
`char`	`dequeueChar()` Method to extract a element from the PriorityQueue
`void`	`enqueueChar(char e)` Method to insert a element into the PriorityQueue
`CharIterator`	`iterator()` Returns an iterator over elements of type `T`.
`void`	`onChanged()` Allows to notify the Queue to be revalidate its data
`char`	`peekChar(int index)` Peeking function to see whats inside the queue.
`boolean`	`removeChar(char e)` Removes the first found element in the queue
`boolean`	`removeLastChar(char e)` Removes the last found element in the queue
`int`	`size()`
`java.lang.Character[]`	`toArray(java.lang.Character[] input)` A method to drop the contents of the Queue without clearing the queue
`char[]`	`toCharArray(char[] input)` A method to drop the contents of the Queue without clearing the queue
`static CharHeapPriorityQueue`	`wrap(char[] array)` Wrapping method to help serialization
`static CharHeapPriorityQueue`	`wrap(char[] array, CharComparator comp)` Wrapping method to help serialization, using a custom sorter
`static CharHeapPriorityQueue`	`wrap(char[] array, int size)` Wrapping method to help serialization
`static CharHeapPriorityQueue`	`wrap(char[] array, int size, CharComparator 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.chars.queues.CharPriorityQueue
dequeue, enqueue, first, firstChar, peek, remove, removeLast, toArray, toCharArray

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

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable
forEach, forEach, spliterator

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.queues.CharPriorityQueue

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

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

Constructor Detail

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

CharHeapPriorityQueue

Method Detail

wrap

wrap

wrap

wrap

size

clear

iterator

enqueueChar

dequeueChar

peekChar

removeChar

removeLastChar

onChanged

comparator

toCharArray

toArray