gov.sandia.cognition.statistics
Class AbstractSufficientStatistic<DataType,DistributionType>

java.lang.Object
  gov.sandia.cognition.util.AbstractCloneableSerializable
      gov.sandia.cognition.statistics.AbstractSufficientStatistic<DataType,DistributionType>

Type Parameters:

DataType - Type of data generated by the Distribution

DistributionType - Type of Distribution this is the sufficient statistics of

All Implemented Interfaces:

Factory<DistributionType>, SufficientStatistic<DataType,DistributionType>, CloneableSerializable, Serializable, Cloneable

Direct Known Subclasses:

BayesianLinearRegression.IncrementalEstimator.SufficientStatistic, BayesianRobustLinearRegression.IncrementalEstimator.SufficientStatistic, MultivariateGaussian.SufficientStatistic, MultivariateGaussian.SufficientStatisticCovarianceInverse, UnivariateGaussian.SufficientStatistic

public abstract class AbstractSufficientStatistic<DataType,DistributionType>
extends AbstractCloneableSerializable
implements SufficientStatistic<DataType,DistributionType>

Partial implementation of SufficientStatistic

Since:

3.1

Author:

Kevin R. Dixon

See Also:

Serialized Form

Field Summary

protected long

count Number of data points used to create this SufficientStatistic

Constructor Summary

AbstractSufficientStatistic()
Creates a new instance of AbstractSufficientStatistic

Method Summary

AbstractSufficientStatistic<DataType,DistributionType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
long	getCount() Gets the count
protected void	setCount(long count) Setter for count
void	update(Iterable<? extends DataType> values) Updates the sufficient statistics from the given set of values

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.sandia.cognition.statistics.SufficientStatistic

create, update

Methods inherited from interface gov.sandia.cognition.factory.Factory

create

Field Detail

count

protected long count

Number of data points used to create this SufficientStatistic

Constructor Detail

AbstractSufficientStatistic

public AbstractSufficientStatistic()

Creates a new instance of AbstractSufficientStatistic

Method Detail

clone

public AbstractSufficientStatistic<DataType,DistributionType> clone()

Description copied from class: AbstractCloneableSerializable

This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class AbstractCloneableSerializable

Returns:

A clone of this object.

update

public void update(Iterable<? extends DataType> values)

Description copied from interface: SufficientStatistic

Updates the sufficient statistics from the given set of values

Specified by:

update in interface SufficientStatistic<DataType,DistributionType>

Parameters:

values - Values to update the sufficient statistics

getCount

public long getCount()

Description copied from interface: SufficientStatistic

Gets the count

Specified by:

getCount in interface SufficientStatistic<DataType,DistributionType>

Returns:

Number of data points used to create this SufficientStatistic

setCount

protected void setCount(long count)

Setter for count

Parameters:

count - Number of data points used to create this SufficientStatistic