speiger.src.collections.shorts.queues

Class ShortArrayFIFOQueue

java.lang.Object

speiger.src.collections.shorts.queues.ShortArrayFIFOQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Short>, ObjectPriorityQueue<java.lang.Short>, ShortIterable, ShortPriorityDequeue, ShortPriorityQueue, ITrimmable

public class ShortArrayFIFOQueue
extends java.lang.Object
implements ShortPriorityDequeue, 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
ShortArrayFIFOQueue() Default Construtor
ShortArrayFIFOQueue(int capacity) Constructor with a Min Capacity
ShortArrayFIFOQueue(short[] values) Constructor using a initial array
ShortArrayFIFOQueue(short[] values, int size) Constructor using a initial array
ShortArrayFIFOQueue(short[] 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
ShortComparator	comparator()
short	dequeueLastShort() A Method to remove a element from the last place instead of the first
short	dequeueShort() Method to extract a element from the PriorityQueue
void	enqueueFirstShort(short e) Method to insert a element into the first Index instead of the last.
void	enqueueShort(short e) Method to insert a element into the PriorityQueue
ShortIterator	iterator() Returns an iterator over elements of type T.
void	onChanged() Allows to notify the Queue to be revalidate its data
short	peekShort(int index) Peeking function to see whats inside the queue.
boolean	removeLastShort(short e) Removes the last found element in the queue
boolean	removeShort(short e) Removes the first found element in the queue
int	size()
java.lang.Short[]	toArray(java.lang.Short[] input) A method to drop the contents of the Queue without clearing the queue
short[]	toShortArray(short[] 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.shorts.queues.ShortPriorityDequeue

dequeueLast, enqueueFirst, last, lastShort

Methods inherited from interface speiger.src.collections.shorts.queues.ShortPriorityQueue

dequeue, enqueue, first, firstShort, peek, remove, removeLast, toArray, toShortArray

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

isEmpty

Methods inherited from interface speiger.src.collections.shorts.collections.ShortIterable

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

ShortArrayFIFOQueue

public ShortArrayFIFOQueue(short[] values)

Constructor using a initial array

Parameters:

values - the Array that should be used

ShortArrayFIFOQueue

public ShortArrayFIFOQueue(short[] 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

ShortArrayFIFOQueue

public ShortArrayFIFOQueue(short[] 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

ShortArrayFIFOQueue

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

ShortArrayFIFOQueue

public ShortArrayFIFOQueue()

Default Construtor

Method Detail

iterator

public ShortIterator iterator()

Description copied from interface: ShortIterable

Returns an iterator over elements of type T.

Specified by:

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

Specified by:

iterator in interface ShortIterable

Returns:

an Iterator.

size

public int size()

Specified by:

size in interface ObjectPriorityQueue<java.lang.Short>

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

enqueueShort

public void enqueueShort(short e)

Description copied from interface: ShortPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueueShort in interface ShortPriorityQueue

Parameters:

e - the element that should be inserted

enqueueFirstShort

public void enqueueFirstShort(short e)

Description copied from interface: ShortPriorityDequeue

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

Specified by:

enqueueFirstShort in interface ShortPriorityDequeue

Parameters:

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

dequeueShort

public short dequeueShort()

Description copied from interface: ShortPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeueShort in interface ShortPriorityQueue

Returns:

a element from the Queue

dequeueLastShort

public short dequeueLastShort()

Description copied from interface: ShortPriorityDequeue

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

Specified by:

dequeueLastShort in interface ShortPriorityDequeue

Returns:

the last element inserted

peekShort

public short peekShort(int index)

Description copied from interface: ShortPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peekShort in interface ShortPriorityQueue

Parameters:

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

Returns:

the element that is requested

removeShort

public boolean removeShort(short e)

Description copied from interface: ShortPriorityQueue

Removes the first found element in the queue

Specified by:

removeShort in interface ShortPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLastShort

public boolean removeLastShort(short e)

Description copied from interface: ShortPriorityQueue

Removes the last found element in the queue

Specified by:

removeLastShort in interface ShortPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

onChanged

public void onChanged()

Description copied from interface: ShortPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface ObjectPriorityQueue<java.lang.Short>

Specified by:

onChanged in interface ShortPriorityQueue

comparator

public ShortComparator comparator()

Specified by:

comparator in interface ObjectPriorityQueue<java.lang.Short>

Specified by:

comparator in interface ShortPriorityQueue

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

toShortArray

public short[] toShortArray(short[] input)

Description copied from interface: ShortPriorityQueue

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

Specified by:

toShortArray in interface ShortPriorityQueue

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

Description copied from interface: ObjectPriorityQueue

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

Specified by:

toArray in interface ObjectPriorityQueue<java.lang.Short>

Specified by:

toArray in interface ShortPriorityQueue

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.