org.apache.spark.mllib.stat

Class MultivariateOnlineSummarizer

Object

org.apache.spark.mllib.stat.MultivariateOnlineSummarizer

All Implemented Interfaces:

java.io.Serializable, MultivariateStatisticalSummary

public class MultivariateOnlineSummarizer
extends Object
implements MultivariateStatisticalSummary, scala.Serializable

:: DeveloperApi :: MultivariateOnlineSummarizer implements MultivariateStatisticalSummary to compute the mean, variance, minimum, maximum, counts, and nonzero counts for instances in sparse or dense vector format in an online fashion.

Two MultivariateOnlineSummarizer can be merged together to have a statistical summary of the corresponding joint dataset.

A numerically stable algorithm is implemented to compute the mean and variance of instances: Reference: variance-wiki Zero elements (including explicit zero values) are skipped when calling add(), to have time complexity O(nnz) instead of O(n) for each column.

For weighted instances, the unbiased estimation of variance is defined by the reliability weights: see Reliability weights (Wikipedia).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultivariateOnlineSummarizer()

Method Summary

Modifier and Type	Method and Description
MultivariateOnlineSummarizer	add(Vector sample) Add a new sample to this summarizer, and update the statistical summary.
long	count() Sample size.
Vector	max() Maximum value of each dimension.
Vector	mean() Sample mean of each dimension.
MultivariateOnlineSummarizer	merge(MultivariateOnlineSummarizer other) Merge another MultivariateOnlineSummarizer, and update the statistical summary.
Vector	min() Minimum value of each dimension.
Vector	normL1() L1 norm of each dimension.
Vector	normL2() L2 (Euclidean) norm of each dimension.
Vector	numNonzeros() Number of nonzero elements in each dimension.
Vector	variance() Unbiased estimate of sample variance of each dimension.

Methods inherited from class Object

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

Constructor Detail

MultivariateOnlineSummarizer

public MultivariateOnlineSummarizer()

Method Detail

add

public MultivariateOnlineSummarizer add(Vector sample)

Add a new sample to this summarizer, and update the statistical summary.

Parameters:

sample - The sample in dense/sparse vector format to be added into this summarizer.

Returns:

This MultivariateOnlineSummarizer object.

count

public long count()

Sample size.

Specified by:

count in interface MultivariateStatisticalSummary

Returns:

(undocumented)

max

public Vector max()

Maximum value of each dimension.

Specified by:

max in interface MultivariateStatisticalSummary

Returns:

(undocumented)

mean

public Vector mean()

Sample mean of each dimension.

Specified by:

mean in interface MultivariateStatisticalSummary

Returns:

(undocumented)

merge

public MultivariateOnlineSummarizer merge(MultivariateOnlineSummarizer other)

Merge another MultivariateOnlineSummarizer, and update the statistical summary. (Note that it's in place merging; as a result, this object will be modified.)

Parameters:

other - The other MultivariateOnlineSummarizer to be merged.

Returns:

This MultivariateOnlineSummarizer object.

min

public Vector min()

Minimum value of each dimension.

Specified by:

min in interface MultivariateStatisticalSummary

Returns:

(undocumented)

normL1

public Vector normL1()

L1 norm of each dimension.

Specified by:

normL1 in interface MultivariateStatisticalSummary

Returns:

(undocumented)

normL2

public Vector normL2()

L2 (Euclidean) norm of each dimension.

Specified by:

normL2 in interface MultivariateStatisticalSummary

Returns:

(undocumented)

numNonzeros

public Vector numNonzeros()

Number of nonzero elements in each dimension.

Specified by:

numNonzeros in interface MultivariateStatisticalSummary

Returns:

(undocumented)

variance

public Vector variance()

Unbiased estimate of sample variance of each dimension.

Specified by:

variance in interface MultivariateStatisticalSummary

Returns:

(undocumented)