SmoothedAverage (box-core 2.0.3 API)

java.lang.Object
- edu.byu.hbll.box.internal.util.SmoothedAverage

public class SmoothedAverage
extends Object

Used for statistics.

Author:: Charles Draper

Field Summary

Fields
Modifier and Type Field Description

static double DEFAULT_SMOOTHING_FACTOR

Constructor Summary

Constructors
Constructor	Description
`SmoothedAverage()`	Creates a new `SmoothedAverage` with the default smoothing factor.
`SmoothedAverage(double smoothingFactor)`	Creates a new `SmoothedAverage` with the given smoothing factor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(double addend)`	Adds a new value to this statistic.
`double`	`get()`	Returns the smoothed average.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SMOOTHING_FACTOR
```
public static final double DEFAULT_SMOOTHING_FACTOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SmoothedAverage
```
public SmoothedAverage()
```
    Creates a new SmoothedAverage with the default smoothing factor.
  - SmoothedAverage
```
public SmoothedAverage(double smoothingFactor)
```
    Creates a new SmoothedAverage with the given smoothing factor.
    
    Parameters:
    
    smoothingFactor - the smoothing factor
- Method Detail
  - add
```
public void add(double addend)
```
    Adds a new value to this statistic.
    
    Parameters:
    
    addend - the value to add
  - get
```
public double get()
```
    Returns the smoothed average.
    
    Returns:
    
    the smoothed average