speiger.src.collections.ints.queues

Class IntArrayFIFOQueue

java.lang.Object

speiger.src.collections.ints.queues.IntArrayFIFOQueue

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>, IntIterable, IntPriorityDequeue, IntPriorityQueue, ObjectPriorityQueue<java.lang.Integer>, ITrimmable

public class IntArrayFIFOQueue
extends java.lang.Object
implements IntPriorityDequeue, 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
IntArrayFIFOQueue() Default Construtor
IntArrayFIFOQueue(int capacity) Constructor with a Min Capacity
IntArrayFIFOQueue(int[] values) Constructor using a initial array
IntArrayFIFOQueue(int[] values, int size) Constructor using a initial array
IntArrayFIFOQueue(int[] 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
IntComparator	comparator()
int	dequeueInt() Method to extract a element from the PriorityQueue
int	dequeueLastInt() A Method to remove a element from the last place instead of the first
void	enqueueFirstInt(int e) Method to insert a element into the first Index instead of the last.
void	enqueueInt(int e) Method to insert a element into the PriorityQueue
IntIterator	iterator() Returns an iterator over elements of type T.
void	onChanged() Allows to notify the Queue to be revalidate its data
int	peekInt(int index) Peeking function to see whats inside the queue.
boolean	removeInt(int e) Removes the first found element in the queue
boolean	removeLastInt(int e) Removes the last found element in the queue
int	size()
java.lang.Integer[]	toArray(java.lang.Integer[] input) A method to drop the contents of the Queue without clearing the queue
int[]	toIntArray(int[] 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.ints.queues.IntPriorityDequeue

dequeueLast, enqueueFirst, last, lastInt

Methods inherited from interface speiger.src.collections.ints.queues.IntPriorityQueue

dequeue, enqueue, first, firstInt, peek, remove, removeLast, toArray, toIntArray

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

isEmpty

Methods inherited from interface speiger.src.collections.ints.collections.IntIterable

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

IntArrayFIFOQueue

public IntArrayFIFOQueue(int[] values)

Constructor using a initial array

Parameters:

values - the Array that should be used

IntArrayFIFOQueue

public IntArrayFIFOQueue(int[] 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

IntArrayFIFOQueue

public IntArrayFIFOQueue(int[] 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

IntArrayFIFOQueue

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

IntArrayFIFOQueue

public IntArrayFIFOQueue()

Default Construtor

Method Detail

iterator

public IntIterator iterator()

Description copied from interface: IntIterable

Returns an iterator over elements of type T.

Specified by:

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

Specified by:

iterator in interface IntIterable

Returns:

an Iterator.

size

public int size()

Specified by:

size in interface ObjectPriorityQueue<java.lang.Integer>

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

enqueueInt

public void enqueueInt(int e)

Description copied from interface: IntPriorityQueue

Method to insert a element into the PriorityQueue

Specified by:

enqueueInt in interface IntPriorityQueue

Parameters:

e - the element that should be inserted

enqueueFirstInt

public void enqueueFirstInt(int e)

Description copied from interface: IntPriorityDequeue

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

Specified by:

enqueueFirstInt in interface IntPriorityDequeue

Parameters:

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

dequeueInt

public int dequeueInt()

Description copied from interface: IntPriorityQueue

Method to extract a element from the PriorityQueue

Specified by:

dequeueInt in interface IntPriorityQueue

Returns:

a element from the Queue

dequeueLastInt

public int dequeueLastInt()

Description copied from interface: IntPriorityDequeue

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

Specified by:

dequeueLastInt in interface IntPriorityDequeue

Returns:

the last element inserted

peekInt

public int peekInt(int index)

Description copied from interface: IntPriorityQueue

Peeking function to see whats inside the queue.

Specified by:

peekInt in interface IntPriorityQueue

Parameters:

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

Returns:

the element that is requested

removeInt

public boolean removeInt(int e)

Description copied from interface: IntPriorityQueue

Removes the first found element in the queue

Specified by:

removeInt in interface IntPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

removeLastInt

public boolean removeLastInt(int e)

Description copied from interface: IntPriorityQueue

Removes the last found element in the queue

Specified by:

removeLastInt in interface IntPriorityQueue

Parameters:

e - the element that should be removed

Returns:

if a searched element was removed

onChanged

public void onChanged()

Description copied from interface: IntPriorityQueue

Allows to notify the Queue to be revalidate its data

Specified by:

onChanged in interface IntPriorityQueue

Specified by:

onChanged in interface ObjectPriorityQueue<java.lang.Integer>

comparator

public IntComparator comparator()

Specified by:

comparator in interface IntPriorityQueue

Specified by:

comparator in interface ObjectPriorityQueue<java.lang.Integer>

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

toIntArray

public int[] toIntArray(int[] input)

Description copied from interface: IntPriorityQueue

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

Specified by:

toIntArray in interface IntPriorityQueue

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

Description copied from interface: ObjectPriorityQueue

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

Specified by:

toArray in interface IntPriorityQueue

Specified by:

toArray in interface ObjectPriorityQueue<java.lang.Integer>

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.