ikr.simlib.statistics

Class Summation

java.lang.Object

ikr.simlib.statistics.Summation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class Summation
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

A summation of samples.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Summation() Constructs a new summation.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	exportSum(java.lang.String name, ResultWriter writer) Exports a summation as a result node.
double	getCoefficientOfVariation() Returns the coefficient of variation of this sum.
double	getConfidenceInterval() Returns the confidence interval of this sum.
double	getMean() Returns the mean of all samples added to this sum.
long	getNumberOfSamples() Returns the number of samples added to this sum.
double	getStandardDeviation() Returns the standard deviation of this sum.
double	getSum() Returns the sum of all samples.
double	getVariance() Returns the variation of this sum.
int	hashCode()
void	importSum(ResultReader reader) Imports a summation from a result node.
void	reset() Resets this summation.
java.lang.String	toString()
void	update(double sample) Adds a sample to this sum.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Summation

public Summation()

Constructs a new summation.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

exportSum

public void exportSum(java.lang.String name,
             ResultWriter writer)
               throws ResultException

Exports a summation as a result node.

Throws:

ResultException

importSum

public void importSum(ResultReader reader)
               throws ResultException

Imports a summation from a result node.

Throws:

ResultException

update

public void update(double sample)

Adds a sample to this sum.

Parameters:

sample - value to be added

reset

public void reset()

Resets this summation.

getSum

public double getSum()

Returns the sum of all samples.

Returns:

sum of all samples

getMean

public double getMean()

Returns the mean of all samples added to this sum.

Returns:

mean of the added samples or NaN

getVariance

public double getVariance()

Returns the variation of this sum.

Returns:

variation of this sum or NaN

getCoefficientOfVariation

public double getCoefficientOfVariation()

Returns the coefficient of variation of this sum.

Returns:

coefficient of variation of this sum or NaN

getStandardDeviation

public double getStandardDeviation()

Returns the standard deviation of this sum.

Returns:

standard deviation of this sum or NaN

getNumberOfSamples

public long getNumberOfSamples()

Returns the number of samples added to this sum.

Returns:

number of samples added

getConfidenceInterval

public double getConfidenceInterval()

Returns the confidence interval of this sum.

Returns:

confidence interval of this sum