speiger.src.collections.booleans.queues

Class BooleanArrayFIFOQueue

java.lang.Object

speiger.src.collections.booleans.queues.AbstractBooleanPriorityQueue

speiger.src.collections.booleans.queues.BooleanArrayFIFOQueue

All Implemented Interfaces:

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

public class BooleanArrayFIFOQueue
extends AbstractBooleanPriorityQueue
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()
BooleanArrayFIFOQueue	copy() A Function that does a shallow clone of the PriorityQueue itself.
int	count(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
boolean	dequeue() Method to extract a element from the PriorityQueue
boolean	dequeueLast() A Method to remove a element from the last place instead of the first
void	enqueue(boolean e) Method to insert a element into the PriorityQueue
void	enqueueFirst(boolean e) Method to insert a element into the first Index instead of the last.
boolean	findFirst(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
void	forEach(BooleanConsumer action) A Type Specific foreach function that reduces (un)boxing
<E> void	forEach(E input, ObjectBooleanConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
BooleanIterator	iterator() Returns an iterator over elements of type T.
boolean	matchesAll(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
void	onChanged() Allows to notify the Queue to be revalidate its data
boolean	peek(int index) Peeking function to see whats inside the queue.
boolean	reduce(boolean identity, BooleanBooleanUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	reduce(BooleanBooleanUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	removeFirst(boolean e) Removes the first found element in the queue
boolean	removeLast(boolean e) Removes the last found element in the queue
int	size()
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 speiger.src.collections.booleans.queues.AbstractBooleanPriorityQueue

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.booleans.queues.BooleanPriorityDequeue

enqueueAllFirst, enqueueAllFirst, enqueueAllFirst, enqueueAllFirst, last, synchronizeQueue, synchronizeQueue

Methods inherited from interface speiger.src.collections.booleans.queues.BooleanPriorityQueue

enqueueAll, enqueueAll, enqueueAll, enqueueAll, first, isEmpty, toBooleanArray

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

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pour, pourAsList, sorted, 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 BooleanPriorityQueue

Returns:

the amount of elements that are stored in the PriorityQueue

clear

public void clear()

Description copied from interface: BooleanPriorityQueue

clears all elements within the PriorityQueue, this does not resize the backing arrays

Specified by:

clear in interface BooleanPriorityQueue

enqueue

public void enqueue(boolean e)

Description copied from interface: BooleanPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueue in interface BooleanPriorityQueue

Parameters:

e - the element that should be inserted

enqueueFirst

public void enqueueFirst(boolean e)

Description copied from interface: BooleanPriorityDequeue

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

Specified by:

enqueueFirst in interface BooleanPriorityDequeue

Parameters:

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

dequeue

public boolean dequeue()

Description copied from interface: BooleanPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeue in interface BooleanPriorityQueue

Returns:

a element from the Queue

dequeueLast

public boolean dequeueLast()

Description copied from interface: BooleanPriorityDequeue

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

Specified by:

dequeueLast in interface BooleanPriorityDequeue

Returns:

the last element inserted

peek

public boolean peek(int index)

Description copied from interface: BooleanPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peek in interface BooleanPriorityQueue

Parameters:

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

Returns:

the element that is requested

removeFirst

public boolean removeFirst(boolean e)

Description copied from interface: BooleanPriorityQueue

Removes the first found element in the queue

Specified by:

removeFirst in interface BooleanPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLast

public boolean removeLast(boolean e)

Description copied from interface: BooleanPriorityQueue

Removes the last found element in the queue

Specified by:

removeLast 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

copy

public BooleanArrayFIFOQueue copy()

Description copied from interface: BooleanPriorityQueue

A Function that does a shallow clone of the PriorityQueue itself. This function is more optimized then a copy constructor since the PriorityQueue does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface BooleanPriorityDequeue

Specified by:

copy in interface BooleanPriorityQueue

Returns:

a Shallow Copy of the PriorityQueue

comparator

public BooleanComparator comparator()

Specified by:

comparator in interface BooleanPriorityQueue

Returns:

the sorter of the Queue, can be null

forEach

public void forEach(BooleanConsumer action)

Description copied from interface: BooleanIterable

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface BooleanIterable

Parameters:

action - The action to be performed for each element

See Also:

Iterable.forEach(Consumer)

forEach

public <E> void forEach(E input,
                        ObjectBooleanConsumer<E> action)

Description copied from interface: BooleanIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface BooleanIterable

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public boolean findFirst(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

reduce

public boolean reduce(boolean identity,
                      BooleanBooleanUnaryOperator operator)

Description copied from interface: BooleanIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface BooleanIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public boolean reduce(BooleanBooleanUnaryOperator operator)

Description copied from interface: BooleanIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface BooleanIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

count

public int count(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

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.