com.github.signaflo.data

Class DoubleDataSet

java.lang.Object

com.github.signaflo.data.DoubleDataSet

All Implemented Interfaces:

DataSet

public final class DoubleDataSet
extends Object
implements DataSet

A collection of numerical observations represented as primitive doubles. This class is immutable and thread-safe.

Constructor Summary

Constructors

Constructor and Description
DoubleDataSet(double... data) Construct a new data set from the given data.

Method Summary

Modifier and Type	Method and Description
double[]	asArray() The observations.
double	correlation(DataSet otherData) The unbiased sample correlation of these observations with the observations contained in the given data set.
double	covariance(DataSet otherData) The unbiased sample covariance of these observations with the observations contained in the given data set.
boolean	equals(Object obj)
int	hashCode()
double	mean() The mean of the observations.
double	median() The median value of the observations.
DataSet	plus(DataSet otherData) Add every element of this data set to the corresponding element of the given data set.
int	size() The size of the data set.
double	stdDeviation() The unbiased sample standard deviation of the observations.
double	sum() The sum of the observations.
double	sumOfSquares() The sum of the squared observations.
DataSet	times(DataSet otherData) Multiply every element of this data set with the corresponding element of the given data set.
String	toString()
double	variance() The unbiased sample variance of the observations.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DoubleDataSet

public DoubleDataSet(@NonNull
                     double... data)

Construct a new data set from the given data.

Parameters:

data - the collection of observations.

Method Detail

sum

public final double sum()

Description copied from interface: DataSet

The sum of the observations.

Specified by:

sum in interface DataSet

Returns:

the sum of the observations.

sumOfSquares

public final double sumOfSquares()

Description copied from interface: DataSet

The sum of the squared observations.

Specified by:

sumOfSquares in interface DataSet

Returns:

the sum of the squared observations.

mean

public final double mean()

Description copied from interface: DataSet

The mean of the observations.

Specified by:

mean in interface DataSet

Returns:

the mean of the observations.

median

public final double median()

Description copied from interface: DataSet

The median value of the observations.

Specified by:

median in interface DataSet

Returns:

the median value of the observations.

size

public final int size()

Description copied from interface: DataSet

The size of the data set.

Specified by:

size in interface DataSet

Returns:

the size of the data set.

times

public final DataSet times(@NonNull
                           DataSet otherData)

Description copied from interface: DataSet

Multiply every element of this data set with the corresponding element of the given data set.

Specified by:

times in interface DataSet

Parameters:

otherData - The data to multiply by.

Returns:

A new data set containing every element of this data set multiplied by the corresponding element of the given data set.

plus

public final DataSet plus(@NonNull
                          DataSet otherData)

Description copied from interface: DataSet

Add every element of this data set to the corresponding element of the given data set.

Specified by:

plus in interface DataSet

Parameters:

otherData - The data to add to.

Returns:

A new data set containing every element of this data set added to the corresponding element of the given data set.

variance

public final double variance()

Description copied from interface: DataSet

The unbiased sample variance of the observations.

Specified by:

variance in interface DataSet

Returns:

the unbiased sample variance of the observations.

stdDeviation

public final double stdDeviation()

Description copied from interface: DataSet

The unbiased sample standard deviation of the observations.

Specified by:

stdDeviation in interface DataSet

Returns:

the unbiased sample standard deviation of the observations.

covariance

public final double covariance(@NonNull
                               DataSet otherData)

Description copied from interface: DataSet

The unbiased sample covariance of these observations with the observations contained in the given data set.

Specified by:

covariance in interface DataSet

Parameters:

otherData - the data to compute the covariance with.

Returns:

the unbiased sample covariance of these observations with the observations contained in the given data set.

correlation

public final double correlation(@NonNull
                                DataSet otherData)

Description copied from interface: DataSet

The unbiased sample correlation of these observations with the observations contained in the given data set.

Specified by:

correlation in interface DataSet

Parameters:

otherData - the data to compute the correlation coefficient with.

Returns:

the unbiased sample correlation of these observations with the observations contained in the given data set.

asArray

public final double[] asArray()

Description copied from interface: DataSet

The observations.

Specified by:

asArray in interface DataSet

Returns:

the observations.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object