Package org.hipparchus.stat.descriptive.vector

Class VectorialStorelessStatistic

java.lang.Object

org.hipparchus.stat.descriptive.vector.VectorialStorelessStatistic

All Implemented Interfaces:

java.io.Serializable, StorelessMultivariateStatistic

public class VectorialStorelessStatistic
extends java.lang.Object
implements StorelessMultivariateStatistic, java.io.Serializable

Uses an independent StorelessUnivariateStatistic instance for each component of a vector.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
VectorialStorelessStatistic(int dimension, StorelessUnivariateStatistic univariateStatistic)	Create a new VectorialStorelessStatistic with the given dimension and statistic implementation.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the internal state of the statistic.
boolean	equals(java.lang.Object obj)
int	getDimension()	Returns the dimension of the statistic.
long	getN()	Returns the number of values that have been added.
double[]	getResult()	Returns the current value of the Statistic.
int	hashCode()
void	increment(double[] d)	Updates the internal state of the statistic to reflect the addition of the new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorialStorelessStatistic

public VectorialStorelessStatistic(int dimension,
                                   StorelessUnivariateStatistic univariateStatistic)

Create a new VectorialStorelessStatistic with the given dimension and statistic implementation. A copy of the provided statistic will be created for each component of the vector.

Parameters:

dimension - the vector dimension

univariateStatistic - the prototype statistic

Throws:

MathIllegalArgumentException - if dimension < 1

Method Detail

increment

public void increment(double[] d)

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

Specified by:

increment in interface StorelessMultivariateStatistic

Parameters:

d - the new value

getResult

public double[] getResult()

Returns the current value of the Statistic.

Specified by:

getResult in interface StorelessMultivariateStatistic

Returns:

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

getN

public long getN()

Returns the number of values that have been added.

Specified by:

getN in interface StorelessMultivariateStatistic

Returns:

the number of values.

clear

public void clear()

Clears the internal state of the statistic.

Specified by:

clear in interface StorelessMultivariateStatistic

getDimension

public int getDimension()

Returns the dimension of the statistic.

Specified by:

getDimension in interface StorelessMultivariateStatistic

Returns:

the dimension of the statistic

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object