com.qualcomm.robotcore.util

Class RollingAverage

java.lang.Object

com.qualcomm.robotcore.util.RollingAverage

public class RollingAverage
extends java.lang.Object

Calculate a rolling average from a stream of numbers. Only the last 'size' elements will be considered.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SIZE

Constructor Summary

Constructors

Constructor and Description
RollingAverage() Constructor, with default size
RollingAverage(int size) Constructor, with given size

Method Summary

Modifier and Type	Method and Description
void	addNumber(int number) Add a number to the rolling average
int	getAverage() Get the rolling average
void	reset() Reset the rolling average
void	resize(int size) Resize the rolling average
int	size() Get the size

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

Constructor Detail

RollingAverage

public RollingAverage()

Constructor, with default size

RollingAverage

public RollingAverage(int size)

Constructor, with given size

Parameters:

size -

Method Detail

size

public int size()

Get the size

Returns:

Size

resize

public void resize(int size)

Resize the rolling average

Side Effect: the rolling average is reset

Parameters:

size -

addNumber

public void addNumber(int number)

Add a number to the rolling average

Parameters:

number -

getAverage

public int getAverage()

Get the rolling average

Returns:

rolling average, if available; otherwise 0

reset

public void reset()

Reset the rolling average