Samples (Broadwick 1.2 API)

java.lang.Object
- broadwick.statistics.Samples

All Implemented Interfaces:

Serializable
```
public class Samples
extends Object
implements Serializable
```
This class collects data values and calculates their mean and variance.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

private double product

private double sum

private double sumInv

private double sumSqr

private int total

Fields
Modifier and Type	Field and Description
`private double`	`product`
`private double`	`sum`
`private double`	`sumInv`
`private double`	`sumSqr`
`private int`	`total`

Constructor Summary

Constructors
Constructor and Description
`Samples()` Empty object where the internal values are initialised to 0.
`Samples(double value)` Initialise the internal values of the accumulator with the argument given.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Samples`	`add(double value)` Add an observable (value) to the accumulator.
`Samples`	`add(Samples value)` Add the contents of anther accumulator to this accumulator.
`void`	`clear()` Clear the contents of the accumulator.
`double`	`getGeometricMean()` Obtain the geometric mean of the set of observables in the accumulator.
`double`	`getHarmonicMean()` Obtain the harmonic mean of the set of observables in the accumulator.
`double`	`getMean()` Obtain the mean of the set of observables in the accumulator.
`double`	`getRootMeanSquare()` Obtain the root mean square of the set of observables in the accumulator.
`int`	`getSize()` Get the number of items added to the Accumulator.
`double`	`getStdDev()` Obtain the standard deviation (error in the mean) of the set of observeables in the accumulator.
`double`	`getSum()` Get the sum of the values held in the accumulator.
`String`	`getSummary()` Get a tab delimited string of the mean and standard deviation of the values in the accumulator.
`double`	`getVariance()` Default sample variance implementation based on the second moment \f$ M_n^{(2)} \f$ moment<2>, mean and count.

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

- Field Detail
  - sum
```
private double sum
```
  - sumSqr
```
private double sumSqr
```
  - product
```
private double product
```
  - sumInv
```
private double sumInv
```
  - total
```
private int total
```
- Constructor Detail
  - Samples
```
public Samples()
```
    Empty object where the internal values are initialised to 0. Getting any statistics from this object will result in a divide by zero exceptions since there are zero elements in the accumulator.
  - Samples
```
public Samples(double value)
```
    Initialise the internal values of the accumulator with the argument given.
    
    Parameters:
    
    value - the value to initialise the internal variables.
- Method Detail
  - add
```
public final Samples add(double value)
```
    Add an observable (value) to the accumulator.
    
    Parameters:
    
    value - add the value to the accumulated values.
    
    Returns:
    
    the current accumulator object.
  - add
```
public final Samples add(Samples value)
```
    Add the contents of anther accumulator to this accumulator.
    
    Parameters:
    
    value - add the value to the accumulated values.
    
    Returns:
    
    the current accumulator object.
  - getMean
```
public final double getMean()
```
    Obtain the mean of the set of observables in the accumulator.
    
    Returns:
    
    double the mean in the observed values.
  - getRootMeanSquare
```
public final double getRootMeanSquare()
```
    Obtain the root mean square of the set of observables in the accumulator.
    
    Returns:
    
    double the root mean square in the observed values.
  - getGeometricMean
```
public final double getGeometricMean()
```
    Obtain the geometric mean of the set of observables in the accumulator.
    
    Returns:
    
    double the geometric mean in the observed values.
  - getHarmonicMean
```
public final double getHarmonicMean()
```
    Obtain the harmonic mean of the set of observables in the accumulator.
    
    Returns:
    
    double the harmonic mean in the observed values.
  - getSum
```
public final double getSum()
```
    Get the sum of the values held in the accumulator.
    
    Returns:
    
    the sum of all the values added to the accumulator.
  - getSize
```
public final int getSize()
```
    Get the number of items added to the Accumulator.
    
    Returns:
    
    the number of items added to the Accumulator.
  - getVariance
```
public final double getVariance()
```
    Default sample variance implementation based on the second moment \f$ M_n^{(2)} \f$ moment<2>, mean and count. \f[ \sigma_n^2 = M_n^{(2)} - \mu_n^2. \f] where \f[ \mu_n = \frac{1}{n} \sum_{i = 1}^n x_i. \f] is the estimate of the sample mean and \f$n\f$ is the number of samples.
    
    Returns:
    
    double the variance of the observed values.
  - getStdDev
```
public final double getStdDev()
```
    Obtain the standard deviation (error in the mean) of the set of observeables in the accumulator.
    
    Returns:
    
    double the standard deviation in the observed values.
  - clear
```
public final void clear()
```
    Clear the contents of the accumulator. Sets all the internal counts back to zero.
  - getSummary
```
public final String getSummary()
```
    Get a tab delimited string of the mean and standard deviation of the values in the accumulator.
    
    Returns:
    
    a string in the form "\tmean\tdev"

Class Samples

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sum

sumSqr

product

sumInv

total

Constructor Detail

Samples

Samples

Method Detail

add

add

getMean

getRootMeanSquare

getGeometricMean

getHarmonicMean

getSum

getSize

getVariance

getStdDev

clear

getSummary