io.spokestack.spokestack

Class RingBuffer

java.lang.Object

io.spokestack.spokestack.RingBuffer

public final class RingBuffer
extends Object

a simple circular buffer of floating point values.

Constructor Summary

Constructors

Constructor and Description
RingBuffer(int capacity) constructs a new ring buffer instance.

Method Summary

Modifier and Type	Method and Description
int	capacity()
RingBuffer	fill(float value) fills the remaining positions in the buffer with the specified value.
boolean	isEmpty()
boolean	isFull()
float	read() reads the next value from the buffer.
RingBuffer	reset() resets the read head buffer, marking the buffer empty, but not modifying any elements.
RingBuffer	rewind() seeks the read head to the beginning, marking it full and allowing all elements to be read.
RingBuffer	seek(int elems) seeks the read head forward.
void	write(float value) writes the next value to the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

RingBuffer

public RingBuffer(int capacity)

constructs a new ring buffer instance.

Parameters:

capacity - the maximum number of elements to store

Method Detail

capacity

public int capacity()

Returns:

the maximum number of elements that can be stored

isEmpty

public boolean isEmpty()

Returns:

true if no elements can be read, false otherwise

isFull

public boolean isFull()

Returns:

true if no elements can be written, false otherwise

rewind

public RingBuffer rewind()

seeks the read head to the beginning, marking it full and allowing all elements to be read.

Returns:

this

seek

public RingBuffer seek(int elems)

seeks the read head forward. care must be taken by the caller to avoid read overflow

Parameters:

elems - the number of elements to move forward/backward

Returns:

this

reset

public RingBuffer reset()

resets the read head buffer, marking the buffer empty, but not modifying any elements.

Returns:

this

fill

public RingBuffer fill(float value)

fills the remaining positions in the buffer with the specified value.

Parameters:

value - the value to write

Returns:

this

read

public float read()

reads the next value from the buffer.

Returns:

the value that was read

write

public void write(float value)

writes the next value to the buffer.

Parameters:

value - the value to write