speiger.src.collections.longs.queues

Class LongArrayFIFOQueue

java.lang.Object

speiger.src.collections.longs.queues.LongArrayFIFOQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>, LongIterable, LongPriorityDequeue, LongPriorityQueue, ObjectPriorityQueue<java.lang.Long>, ITrimmable

public class LongArrayFIFOQueue
extends java.lang.Object
implements LongPriorityDequeue, 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
LongArrayFIFOQueue() Default Construtor
LongArrayFIFOQueue(int capacity) Constructor with a Min Capacity
LongArrayFIFOQueue(long[] values) Constructor using a initial array
LongArrayFIFOQueue(long[] values, int size) Constructor using a initial array
LongArrayFIFOQueue(long[] values, int offset, int size) Constructor using a initial array

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
LongComparator	comparator()
long	dequeueLastLong() A Method to remove a element from the last place instead of the first
long	dequeueLong() Method to extract a element from the PriorityQueue
void	enqueueFirstLong(long e) Method to insert a element into the first Index instead of the last.
void	enqueueLong(long e) Method to insert a element into the PriorityQueue
LongIterator	iterator() Returns an iterator over elements of type T.
void	onChanged() Allows to notify the Queue to be revalidate its data
long	peekLong(int index) Peeking function to see whats inside the queue.
boolean	removeLastLong(long e) Removes the last found element in the queue
boolean	removeLong(long e) Removes the first found element in the queue
int	size()
java.lang.Long[]	toArray(java.lang.Long[] input) A method to drop the contents of the Queue without clearing the queue
long[]	toLongArray(long[] 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.longs.queues.LongPriorityDequeue

dequeueLast, enqueueFirst, last, lastLong

Methods inherited from interface speiger.src.collections.longs.queues.LongPriorityQueue

dequeue, enqueue, first, firstLong, peek, remove, removeLast, toArray, toLongArray

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

isEmpty

Methods inherited from interface speiger.src.collections.longs.collections.LongIterable

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

LongArrayFIFOQueue

public LongArrayFIFOQueue(long[] values)

Constructor using a initial array

Parameters:

values - the Array that should be used

LongArrayFIFOQueue

public LongArrayFIFOQueue(long[] 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

LongArrayFIFOQueue

public LongArrayFIFOQueue(long[] 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

LongArrayFIFOQueue

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

LongArrayFIFOQueue

public LongArrayFIFOQueue()

Default Construtor

Method Detail

iterator

public LongIterator iterator()

Description copied from interface: LongIterable

Returns an iterator over elements of type T.

Specified by:

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

Specified by:

iterator in interface LongIterable

Returns:

an Iterator.

size

public int size()

Specified by:

size in interface ObjectPriorityQueue<java.lang.Long>

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

enqueueLong

public void enqueueLong(long e)

Description copied from interface: LongPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueueLong in interface LongPriorityQueue

Parameters:

e - the element that should be inserted

enqueueFirstLong

public void enqueueFirstLong(long e)

Description copied from interface: LongPriorityDequeue

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

Specified by:

enqueueFirstLong in interface LongPriorityDequeue

Parameters:

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

dequeueLong

public long dequeueLong()

Description copied from interface: LongPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeueLong in interface LongPriorityQueue

Returns:

a element from the Queue

dequeueLastLong

public long dequeueLastLong()

Description copied from interface: LongPriorityDequeue

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

Specified by:

dequeueLastLong in interface LongPriorityDequeue

Returns:

the last element inserted

peekLong

public long peekLong(int index)

Description copied from interface: LongPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peekLong in interface LongPriorityQueue

Parameters:

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

Returns:

the element that is requested

removeLong

public boolean removeLong(long e)

Description copied from interface: LongPriorityQueue

Removes the first found element in the queue

Specified by:

removeLong in interface LongPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLastLong

public boolean removeLastLong(long e)

Description copied from interface: LongPriorityQueue

Removes the last found element in the queue

Specified by:

removeLastLong in interface LongPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

onChanged

public void onChanged()

Description copied from interface: LongPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface LongPriorityQueue

Specified by:

onChanged in interface ObjectPriorityQueue<java.lang.Long>

comparator

public LongComparator comparator()

Specified by:

comparator in interface LongPriorityQueue

Specified by:

comparator in interface ObjectPriorityQueue<java.lang.Long>

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

toLongArray

public long[] toLongArray(long[] input)

Description copied from interface: LongPriorityQueue

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

Specified by:

toLongArray in interface LongPriorityQueue

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

Description copied from interface: ObjectPriorityQueue

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

Specified by:

toArray in interface LongPriorityQueue

Specified by:

toArray in interface ObjectPriorityQueue<java.lang.Long>

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.