speiger.src.collections.booleans.queues

Class BooleanHeapPriorityQueue

java.lang.Object

speiger.src.collections.booleans.queues.BooleanHeapPriorityQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Boolean>, BooleanIterable, BooleanPriorityQueue, ObjectPriorityQueue<java.lang.Boolean>

public class BooleanHeapPriorityQueue
extends java.lang.Object
implements BooleanPriorityQueue

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
BooleanHeapPriorityQueue() Default Constructor
BooleanHeapPriorityQueue(boolean[] array) Constructor using a initial array
BooleanHeapPriorityQueue(boolean[] array, BooleanComparator comp) Constructor using a initial array and a custom sorter
BooleanHeapPriorityQueue(boolean[] array, int size) Constructor using a initial array
BooleanHeapPriorityQueue(boolean[] array, int size, BooleanComparator comp) Constructor using a initial array and a custom sorter
BooleanHeapPriorityQueue(BooleanCollection c) Constructor using a Collection
BooleanHeapPriorityQueue(BooleanCollection c, BooleanComparator comp) Constructor using a Collection and a custom sorter
BooleanHeapPriorityQueue(BooleanComparator comp) Constructor using custom sorter
BooleanHeapPriorityQueue(int size) Constructor with a Min Capacity
BooleanHeapPriorityQueue(int size, BooleanComparator comp) Constructor with a Min Capacity and custom Sorter

Method Summary

Modifier and Type	Method and Description
void	clear() clears all elements within the PriorityQueue, this does not resize the backing arrays
BooleanComparator	comparator()
boolean	dequeueBoolean() Method to extract a element from the PriorityQueue
void	enqueueBoolean(boolean e) Method to insert a element into the PriorityQueue
BooleanIterator	iterator() Returns an iterator over elements of type T.
void	onChanged() Allows to notify the Queue to be revalidate its data
boolean	peekBoolean(int index) Peeking function to see whats inside the queue.
boolean	removeBoolean(boolean e) Removes the first found element in the queue
boolean	removeLastBoolean(boolean e) Removes the last found element in the queue
int	size()
java.lang.Boolean[]	toArray(java.lang.Boolean[] input) A method to drop the contents of the Queue without clearing the queue
boolean[]	toBooleanArray(boolean[] input) A method to drop the contents of the Queue without clearing the queue
static BooleanHeapPriorityQueue	wrap(boolean[] array) Wrapping method to help serialization
static BooleanHeapPriorityQueue	wrap(boolean[] array, BooleanComparator comp) Wrapping method to help serialization, using a custom sorter
static BooleanHeapPriorityQueue	wrap(boolean[] array, int size) Wrapping method to help serialization
static BooleanHeapPriorityQueue	wrap(boolean[] array, int size, BooleanComparator 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.booleans.queues.BooleanPriorityQueue

dequeue, enqueue, first, firstBoolean, peek, remove, removeLast, toArray, toBooleanArray

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

isEmpty

Methods inherited from interface speiger.src.collections.booleans.collections.BooleanIterable

forEach, forEach, spliterator

Constructor Detail

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue()

Default Constructor

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(BooleanComparator comp)

Constructor using custom sorter

Parameters:

comp - Comparator to sort the Array. Can be null

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(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

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(int size,
                                BooleanComparator 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

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(boolean[] array)

Constructor using a initial array

Parameters:

array - the Array that should be used

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(boolean[] 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

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(boolean[] array,
                                BooleanComparator 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

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(boolean[] array,
                                int size,
                                BooleanComparator 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

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(BooleanCollection c)

Constructor using a Collection

Parameters:

c - the Collection that should be used

BooleanHeapPriorityQueue

public BooleanHeapPriorityQueue(BooleanCollection c,
                                BooleanComparator 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 BooleanHeapPriorityQueue wrap(boolean[] 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 BooleanHeapPriorityQueue wrap(boolean[] 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 BooleanHeapPriorityQueue wrap(boolean[] array,
                                            BooleanComparator 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 BooleanHeapPriorityQueue wrap(boolean[] array,
                                            int size,
                                            BooleanComparator 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.Boolean>

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.Boolean>

iterator

public BooleanIterator iterator()

Description copied from interface: BooleanIterable

Returns an iterator over elements of type T.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Boolean>

Specified by:

iterator in interface BooleanIterable

Returns:

an Iterator.

enqueueBoolean

public void enqueueBoolean(boolean e)

Description copied from interface: BooleanPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueueBoolean in interface BooleanPriorityQueue

Parameters:

e - the element that should be inserted

dequeueBoolean

public boolean dequeueBoolean()

Description copied from interface: BooleanPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeueBoolean in interface BooleanPriorityQueue

Returns:

a element from the Queue

peekBoolean

public boolean peekBoolean(int index)

Description copied from interface: BooleanPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peekBoolean in interface BooleanPriorityQueue

Parameters:

index - of the element that is requested to be viewed.

Returns:

the element that is requested

removeBoolean

public boolean removeBoolean(boolean e)

Description copied from interface: BooleanPriorityQueue

Removes the first found element in the queue

Specified by:

removeBoolean in interface BooleanPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLastBoolean

public boolean removeLastBoolean(boolean e)

Description copied from interface: BooleanPriorityQueue

Removes the last found element in the queue

Specified by:

removeLastBoolean in interface BooleanPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

onChanged

public void onChanged()

Description copied from interface: BooleanPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface BooleanPriorityQueue

Specified by:

onChanged in interface ObjectPriorityQueue<java.lang.Boolean>

comparator

public BooleanComparator comparator()

Specified by:

comparator in interface BooleanPriorityQueue

Specified by:

comparator in interface ObjectPriorityQueue<java.lang.Boolean>

Returns:

the sorter of the Queue, can be null

toBooleanArray

public boolean[] toBooleanArray(boolean[] input)

Description copied from interface: BooleanPriorityQueue

A method to drop the contents of the Queue without clearing the queue

Specified by:

toBooleanArray in interface BooleanPriorityQueue

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.Boolean[] toArray(java.lang.Boolean[] input)

Description copied from interface: ObjectPriorityQueue

A method to drop the contents of the Queue without clearing the queue

Specified by:

toArray in interface BooleanPriorityQueue

Specified by:

toArray in interface ObjectPriorityQueue<java.lang.Boolean>

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.