speiger.src.collections.booleans.queues

Class BooleanArrayFIFOQueue

java.lang.Object

speiger.src.collections.booleans.queues.BooleanArrayFIFOQueue

All Implemented Interfaces:

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

public class BooleanArrayFIFOQueue
extends java.lang.Object
implements BooleanPriorityDequeue, ITrimmable

A Simple First In First Out Priority Queue that is a Good Replacement for a linked list (or ArrayDequeue) Its specific implementation uses a backing array that grows and shrinks as it is needed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_CAPACITY The Minimum Capacity that is allowed

Constructor Summary

Constructors

Constructor and Description
BooleanArrayFIFOQueue() Default Construtor
BooleanArrayFIFOQueue(boolean[] values) Constructor using a initial array
BooleanArrayFIFOQueue(boolean[] values, int size) Constructor using a initial array
BooleanArrayFIFOQueue(boolean[] values, int offset, int size) Constructor using a initial array
BooleanArrayFIFOQueue(int capacity) Constructor with a Min Capacity

Method Summary

Modifier and Type	Method and Description
void	clear() clears all elements within the PriorityQueue, this does not resize the backing arrays
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
BooleanComparator	comparator()
boolean	dequeueBoolean() Method to extract a element from the PriorityQueue
boolean	dequeueLastBoolean() A Method to remove a element from the last place instead of the first
void	enqueueBoolean(boolean e) Method to insert a element into the PriorityQueue
void	enqueueFirstBoolean(boolean e) Method to insert a element into the first Index instead of the last.
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
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger

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

dequeueLast, enqueueFirst, last, lastBoolean

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

Methods inherited from interface speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

Field Detail

MIN_CAPACITY

public static final int MIN_CAPACITY

The Minimum Capacity that is allowed

See Also:

Constant Field Values

Constructor Detail

BooleanArrayFIFOQueue

public BooleanArrayFIFOQueue(boolean[] values)

Constructor using a initial array

Parameters:

values - the Array that should be used

BooleanArrayFIFOQueue

public BooleanArrayFIFOQueue(boolean[] values,
                             int size)

Constructor using a initial array

Parameters:

values - the Array that should be used

size - the amount of elements that are in the initial array

Throws:

java.lang.IllegalStateException - if values is smaller then size

BooleanArrayFIFOQueue

public BooleanArrayFIFOQueue(boolean[] values,
                             int offset,
                             int size)

Constructor using a initial array

Parameters:

values - the Array that should be used

offset - where to begin in the initial array

size - the amount of elements that are in the initial array

Throws:

java.lang.IllegalStateException - if values is smaller then size

BooleanArrayFIFOQueue

public BooleanArrayFIFOQueue(int capacity)

Constructor with a Min Capacity

Parameters:

capacity - the initial capacity of the backing array

Throws:

java.lang.IllegalStateException - if the initial size is smaller 0

BooleanArrayFIFOQueue

public BooleanArrayFIFOQueue()

Default Construtor

Method Detail

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.

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>

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

enqueueFirstBoolean

public void enqueueFirstBoolean(boolean e)

Description copied from interface: BooleanPriorityDequeue

Method to insert a element into the first Index instead of the last.

Specified by:

enqueueFirstBoolean in interface BooleanPriorityDequeue

Parameters:

e - the element that should be inserted into the first place

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

dequeueLastBoolean

public boolean dequeueLastBoolean()

Description copied from interface: BooleanPriorityDequeue

A Method to remove a element from the last place instead of the first

Specified by:

dequeueLastBoolean in interface BooleanPriorityDequeue

Returns:

the last element inserted

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

trim

public boolean trim(int size)

Description copied from interface: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Specified by:

trim in interface ITrimmable

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

clearAndTrim

public void clearAndTrim(int size)

Trims the collection down to the requested size and clears all elements while doing so

Specified by:

clearAndTrim in interface ITrimmable

Parameters:

size - the amount of elements that should be allowed

Note:

this will enforce minimum size of the collection itself

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.