Class CircularArray<T>

java.lang.Object

org.ddogleg.struct.CircularArrayBase

org.ddogleg.struct.CircularArray<T>

public class CircularArray<T>
extends CircularArrayBase

A circular queue which can grow as needed.

Field Summary

Fields

Modifier and Type	Field	Description
T[]	data

Fields inherited from class CircularArrayBase

size, start

Constructor Summary

Constructors

Constructor	Description
CircularArray(Class<T> type)
CircularArray(Class<T> type, int maxSize)

Method Summary

Modifier and Type	Method	Description
void	add(T value)	Adds a new element to the queue.
void	addW(T value)	Adds a new element to the queue, but if the queue is full write over the oldest element.
protected T	createInstance()
T	get(int index)	Returns the element in the queue at index.
int	getMaxSize()	Number of elements in the inner array
T	grow()	Adds a new element to the end of the list and returns it.
T	growW()	Adds a new element to the end of the list and returns it.
T	head()	Value of the first element in the queue
<A> A	innerArray()	Reference to the inner array
T	popHead()	Returns and removes the first element from the queue.
T	popTail()	Returns and removes the last element from the queue.
protected void	shiftElements(int src0, int dst0, int length)	Copies the value in the src into dst inside the inner array.
T	tail()	Value of the last element in the queue

Methods inherited from class CircularArrayBase

arrayIndex, isEmpty, isFull, remove, removeHead, removeTail, reset, size

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

data

public T[] data

Constructor Details

CircularArray

public CircularArray(Class<T> type)

CircularArray

public CircularArray(Class<T> type,
 int maxSize)

Method Details

popHead

public T popHead()

Returns and removes the first element from the queue.

Returns:

first element in the queue

popTail

public T popTail()

Returns and removes the last element from the queue.

Returns:

last element in the queue

head

public T head()

Value of the first element in the queue

tail

public T tail()

Value of the last element in the queue

get

public T get(int index)

Returns the element in the queue at index. No bounds check is performed and a garbage value might be returned.

Parameters:

index - Which element in the queue you wish to access

Returns:

the element's value

grow

public T grow()

Adds a new element to the end of the list and returns it. If the inner array isn't large enough then it will grow.

Returns:

instance at the tail

growW

public T growW()

Adds a new element to the end of the list and returns it. If the inner array isn't large enough then the oldest element will be written over.

Returns:

instance at the tail

add

public void add(T value)

Adds a new element to the queue. If the queue isn't large enough to store this value then its internal data array will grow

Parameters:

value - Value which is to be added

addW

public void addW(T value)

Adds a new element to the queue, but if the queue is full write over the oldest element.

Parameters:

value - Value which is to be added

shiftElements

protected void shiftElements(int src0,
 int dst0,
 int length)

Description copied from class: CircularArrayBase

Copies the value in the src into dst inside the inner array. Needs to handle wrap around

Specified by:

shiftElements in class CircularArrayBase

getMaxSize

public int getMaxSize()

Description copied from class: CircularArrayBase

Number of elements in the inner array

Specified by:

getMaxSize in class CircularArrayBase

innerArray

public <A> A innerArray()

Description copied from class: CircularArrayBase

Reference to the inner array

Specified by:

innerArray in class CircularArrayBase

createInstance

protected T createInstance()