org.matheclipse.core.stat.descriptive

Interface StorelessSymbolicUnivariateStatistic

All Superinterfaces:

SymbolicUnivariateStatistic

All Known Implementing Classes:

AbstractSymbolicStorelessUnivariateStatistic, SymbolicGeometricMean, SymbolicProduct, SymbolicSum, SymbolicSumOfLogs

public interface StorelessSymbolicUnivariateStatistic
extends SymbolicUnivariateStatistic

Extends the definition of SymbolicUnivariateStatistic with increment(org.matheclipse.core.interfaces.IExpr) and #incrementAll(double[]) methods for adding values and updating internal state.

This interface is designed to be used for calculating statistics that can be computed in one pass through the data without storing the full array of sample values.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the internal state of the Statistic
long	getN() Returns the number of values that have been added.
IExpr	getResult() Returns the current value of the Statistic.
void	increment(IExpr d) Updates the internal state of the statistic to reflect the addition of the new value.
void	incrementAll(IAST values) Updates the internal state of the statistic to reflect addition of all values in the values array.
void	incrementAll(IAST values, int start, int length) Updates the internal state of the statistic to reflect addition of the values in the designated portion of the values array.

Methods inherited from interface org.matheclipse.core.stat.descriptive.SymbolicUnivariateStatistic

evaluate, evaluate

Method Detail

increment

void increment(IExpr d)

Updates the internal state of the statistic to reflect the addition of the new value.

Parameters:

d - the new value.

incrementAll

void incrementAll(IAST values)

Updates the internal state of the statistic to reflect addition of all values in the values array. Does not clear the statistic first -- i.e., the values are added incrementally to the dataset.

Parameters:

values - array holding the new values to add

Throws:

java.lang.IllegalArgumentException - if the array is null

incrementAll

void incrementAll(IAST values,
                  int start,
                  int length)

Updates the internal state of the statistic to reflect addition of the values in the designated portion of the values array. Does not clear the statistic first -- i.e., the values are added incrementally to the dataset.

Parameters:

values - array holding the new values to add

start - the array index of the first value to add

length - the number of elements to add

Throws:

java.lang.IllegalArgumentException - if the array is null or the index

getResult

IExpr getResult()

Returns the current value of the Statistic.

Returns:

value of the statistic, Double.NaN if it has been cleared or just instantiated.

getN

long getN()

Returns the number of values that have been added.

Returns:

the number of values.

clear

void clear()

Clears the internal state of the Statistic