xal.tools.statistics

Class UnivariateStatistics

java.lang.Object

xal.tools.statistics.UnivariateStatistics

Direct Known Subclasses:

MutableUnivariateStatistics, RunningWeightedStatistics

public class UnivariateStatistics
extends java.lang.Object

UnivariateStatistics calculates statistics of a series of measurements. UnivariateStatistics is immutable. Use MutableUnivariateStatistics if you need to update the statistics with measurements. Only simple statistics are generated (mean and standard deviation).

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_mean the mean and mean square of the samples
protected double	_meanSquare the mean and mean square of the samples
protected int	_population the number of samples

Constructor Summary

Constructors

Constructor and Description
UnivariateStatistics() Constructor with no samples.
UnivariateStatistics(int size, double average, double averageSquare) Primary Constructor with a starting set of statistics.
UnivariateStatistics(UnivariateStatistics stats) Copy constructor
UnivariateStatistics(UnivariateStatistics stats, double scale) Constructor which scales the samples from an existing set of statistics.

Method Summary

Modifier and Type	Method and Description
double	mean() Get the mean of the samples.
double	meanSquare() Get the mean square of the samples.
int	population() Get the population of the samples (i.e.
double	sampleStandardDeviation() Get the sample standard deviation of the measurements (implies a random subset of all data).
double	sampleStandardDeviationOfMean() Get the standard deviation of the mean from the actual value assuming the supporting data is a random subset of all the data.
double	sampleVariance() Get the sample variance of the measurements (implies a random subset of all data).
double	sampleVarianceOfMean() Get the variance of the mean from the actual value assuming the supporting data is a random subset of all the data.
double	standardDeviation() Get the standard deviation of the samples.
double	standardDeviationOfMean() Get the standard deviation of the mean from the actual value.
double	variance() Get the variance of the samples.
double	varianceOfMean() Get the variance of the mean from the actual value.

Methods inherited from class java.lang.Object

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

Field Detail

_population

protected int _population

the number of samples

_mean

protected double _mean

the mean and mean square of the samples

_meanSquare

protected double _meanSquare

the mean and mean square of the samples

Constructor Detail

UnivariateStatistics

public UnivariateStatistics()

Constructor with no samples.

UnivariateStatistics

public UnivariateStatistics(UnivariateStatistics stats)

Copy constructor

Parameters:

stats - the statistics to copy

UnivariateStatistics

public UnivariateStatistics(UnivariateStatistics stats,
                            double scale)

Constructor which scales the samples from an existing set of statistics.

Parameters:

stats - the statistics against which to scale

scale - factor which is used to scale the copied statistics

UnivariateStatistics

public UnivariateStatistics(int size,
                            double average,
                            double averageSquare)

Primary Constructor with a starting set of statistics.

Parameters:

size - the number of samples

average - the mean

averageSquare - the mean square of the samples

Method Detail

population

public int population()

Get the population of the samples (i.e. the number of samples)

Returns:

the number of samples

mean

public double mean()

Get the mean of the samples.

Returns:

the mean of the samples

meanSquare

public double meanSquare()

Get the mean square of the samples.

Returns:

the mean of the samples

standardDeviation

public double standardDeviation()

Get the standard deviation of the samples.

Returns:

the standard deviation of the samples

variance

public double variance()

Get the variance of the samples.

Returns:

the variance of the samples

sampleStandardDeviation

public double sampleStandardDeviation()

Get the sample standard deviation of the measurements (implies a random subset of all data).

Returns:

the sample standard deviation

sampleVariance

public double sampleVariance()

Get the sample variance of the measurements (implies a random subset of all data).

Returns:

the sample variance of the measurements

varianceOfMean

public double varianceOfMean()

Get the variance of the mean from the actual value.

Returns:

the variance of the mean from the actual value

standardDeviationOfMean

public double standardDeviationOfMean()

Get the standard deviation of the mean from the actual value.

Returns:

the standard deviation of the mean from the actual value

sampleVarianceOfMean

public double sampleVarianceOfMean()

Get the variance of the mean from the actual value assuming the supporting data is a random subset of all the data.

Returns:

the sample variance of the mean

sampleStandardDeviationOfMean

public double sampleStandardDeviationOfMean()

Get the standard deviation of the mean from the actual value assuming the supporting data is a random subset of all the data.

Returns:

the sample standard deviation of the mean