com.badlogic.gdx.math

Class FloatCounter

java.lang.Object

com.badlogic.gdx.math.FloatCounter

public class FloatCounter
extends Object

Track properties of a stream of float values. The properties (total value, minimum, etc) are updated as values are put(float) into the stream.

Author:

xoppa

Field Summary

Fields

Modifier and Type	Field and Description
float	average The average value (total / count)
int	count The amount of values added
float	latest The latest raw value
float	max The largest value
WindowedMean	mean Provides access to the WindowedMean if any (can be null)
float	min The smallest value
float	total The sum of all values
float	value The current windowed mean value

Constructor Summary

Constructors

Constructor and Description
FloatCounter(int windowSize) Construct a new FloatCounter

Method Summary

Modifier and Type	Method and Description
void	put(float value) Add a value and update all fields.
void	reset() Reset all values to their default value.

Methods inherited from class java.lang.Object

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

Field Detail

count

public int count

The amount of values added

total

public float total

The sum of all values

min

public float min

The smallest value

max

public float max

The largest value

average

public float average

The average value (total / count)

latest

public float latest

The latest raw value

value

public float value

The current windowed mean value

mean

public final WindowedMean mean

Provides access to the WindowedMean if any (can be null)

Constructor Detail

FloatCounter

public FloatCounter(int windowSize)

Construct a new FloatCounter

Parameters:

windowSize - The size of the mean window or 1 or below to not use a windowed mean.

Method Detail

put

public void put(float value)

Add a value and update all fields.

Parameters:

value - The value to add

reset

public void reset()

Reset all values to their default value.