gov.sandia.cognition.statistics.distribution

Class ScalarDataDistribution

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.collection.AbstractScalarMap<KeyType,MutableDouble>

gov.sandia.cognition.collection.AbstractMutableDoubleMap<KeyType>

gov.sandia.cognition.statistics.AbstractDataDistribution<KeyType>

gov.sandia.cognition.statistics.distribution.DefaultDataDistribution<java.lang.Double>

gov.sandia.cognition.statistics.distribution.ScalarDataDistribution

All Implemented Interfaces:

NumericMap<java.lang.Double>, ScalarMap<java.lang.Double>, ComputableDistribution<java.lang.Double>, DataDistribution<java.lang.Double>, DiscreteDistribution<java.lang.Double>, Distribution<java.lang.Double>, DistributionWithMean<java.lang.Double>, EstimableDistribution<java.lang.Double,DataDistribution<java.lang.Double>>, UnivariateDistribution<java.lang.Double>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ScalarDataDistribution.CDF, ScalarDataDistribution.PMF

public class ScalarDataDistribution
extends DefaultDataDistribution<java.lang.Double>
implements UnivariateDistribution<java.lang.Double>

A Data Distribution that uses Doubles as its keys, making it a univariate distribution

Since:

3.1

Author:

Kevin R. Dixon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarDataDistribution.CDF CDF of the ScalarDataDistribution, maintains the keys/domain in sorted order (TreeMap), so it's slower than it's peers.
static class	ScalarDataDistribution.Estimator Estimator for a ScalarDataDistribution
static class	ScalarDataDistribution.PMF PMF of the ScalarDataDistribution

Nested classes/interfaces inherited from class gov.sandia.cognition.statistics.distribution.DefaultDataDistribution

DefaultDataDistribution.DefaultFactory<DataType>, DefaultDataDistribution.WeightedEstimator<KeyType>

Nested classes/interfaces inherited from class gov.sandia.cognition.collection.AbstractMutableDoubleMap

AbstractMutableDoubleMap.Entry<KeyType>, AbstractMutableDoubleMap.SimpleEntry<KeyType>, AbstractMutableDoubleMap.SimpleEntrySet<KeyType>, AbstractMutableDoubleMap.SimpleIterator<KeyType>

Nested classes/interfaces inherited from interface gov.sandia.cognition.collection.ScalarMap

ScalarMap.Entry<KeyType>

Field Summary

Fields inherited from class gov.sandia.cognition.statistics.distribution.DefaultDataDistribution

DEFAULT_INITIAL_CAPACITY, total

Fields inherited from class gov.sandia.cognition.collection.AbstractScalarMap

map

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalarDataDistribution() Creates a new instance of ScalarDataDistribution
	ScalarDataDistribution(java.lang.Iterable<? extends java.lang.Number> data) Creates a new instance of ScalarDataDistribution
protected	ScalarDataDistribution(java.util.Map<java.lang.Double,MutableDouble> map, double total) Creates a new instance of ScalarDataDistribution
	ScalarDataDistribution(ScalarDataDistribution other) Copy constructor

Method Summary

Modifier and Type	Method and Description
ScalarDataDistribution	clone() This makes public the clone method on the Object class and removes the exception that it throws.
ScalarDataDistribution.CDF	getCDF() Gets the CDF of a scalar distribution.
ScalarDataDistribution.Estimator	getEstimator() Gets an estimator associated with this distribution.
java.lang.Double	getMaxSupport() Gets the minimum support (domain or input) of the distribution.
java.lang.Double	getMean() Gets the arithmetic mean, or "first central moment" or "expectation", of the distribution.
double	getMeanAsDouble() Gets the mean of the distribution as a double.
java.lang.Double	getMinSupport() Gets the minimum support (domain or input) of the distribution.
ScalarDataDistribution.PMF	getProbabilityFunction() Gets the distribution function associated with this Distribution, either the PDF or PMF.
double	getVariance() Gets the variance of the distribution.

Methods inherited from class gov.sandia.cognition.statistics.distribution.DefaultDataDistribution

clear, getMeanValue, getTotal, increment, set

Methods inherited from class gov.sandia.cognition.statistics.AbstractDataDistribution

fromInfiniteVector, getDomain, getDomainSize, getEntropy, getFraction, getLogFraction, getMaxValue, getMinValue, sample, sample, sampleInto, toInfiniteVector

Methods inherited from class gov.sandia.cognition.collection.AbstractMutableDoubleMap

asMap, compact, entrySet, get

Methods inherited from class gov.sandia.cognition.collection.AbstractScalarMap

containsKey, decrement, decrement, decrementAll, decrementAll, getMaxValueKey, getMaxValueKeys, getMinValueKey, getMinValueKeys, increment, incrementAll, incrementAll, isEmpty, keySet, setAll, setAll, size

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.Distribution

sample, sample, sampleInto

Methods inherited from interface gov.sandia.cognition.collection.ScalarMap

asMap, decrement, decrement, decrementAll, decrementAll, entrySet, get, increment, incrementAll, incrementAll, setAll, setAll

Methods inherited from interface gov.sandia.cognition.collection.NumericMap

containsKey, getMaxValueKey, getMaxValueKeys, getMinValueKey, getMinValueKeys, isEmpty, keySet, size

Constructor Detail

ScalarDataDistribution

public ScalarDataDistribution()

Creates a new instance of ScalarDataDistribution

ScalarDataDistribution

public ScalarDataDistribution(ScalarDataDistribution other)

Copy constructor

Parameters:

other - ScalarDataDistribution to copy

ScalarDataDistribution

public ScalarDataDistribution(java.lang.Iterable<? extends java.lang.Number> data)

Creates a new instance of ScalarDataDistribution

Parameters:

data - Data to create the distribution

ScalarDataDistribution

protected ScalarDataDistribution(java.util.Map<java.lang.Double,MutableDouble> map,
                                 double total)

Creates a new instance of ScalarDataDistribution

Parameters:

map -

total -

Method Detail

clone

public ScalarDataDistribution 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 DataDistribution<java.lang.Double>

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class DefaultDataDistribution<java.lang.Double>

Returns:

A clone of this object.

getProbabilityFunction

public ScalarDataDistribution.PMF getProbabilityFunction()

Description copied from interface: ComputableDistribution

Gets the distribution function associated with this Distribution, either the PDF or PMF.

Specified by:

getProbabilityFunction in interface ComputableDistribution<java.lang.Double>

Specified by:

getProbabilityFunction in interface DataDistribution<java.lang.Double>

Specified by:

getProbabilityFunction in interface DiscreteDistribution<java.lang.Double>

Overrides:

getProbabilityFunction in class DefaultDataDistribution<java.lang.Double>

Returns:

Distribution function associated with this Distribution.

getMean

public java.lang.Double getMean()

Description copied from interface: DistributionWithMean

Gets the arithmetic mean, or "first central moment" or "expectation", of the distribution.

Specified by:

getMean in interface DistributionWithMean<java.lang.Double>

Returns:

Mean of the distribution.

getMeanAsDouble

public double getMeanAsDouble()

Description copied from interface: UnivariateDistribution

Gets the mean of the distribution as a double.

Specified by:

getMeanAsDouble in interface UnivariateDistribution<java.lang.Double>

Returns:

The mean as a double.

getEstimator

public ScalarDataDistribution.Estimator getEstimator()

Description copied from interface: EstimableDistribution

Gets an estimator associated with this distribution.

Specified by:

getEstimator in interface DataDistribution<java.lang.Double>

Specified by:

getEstimator in interface EstimableDistribution<java.lang.Double,DataDistribution<java.lang.Double>>

Overrides:

getEstimator in class DefaultDataDistribution<java.lang.Double>

Returns:

A distribution estimator associated for this distribution.

getMinSupport

public java.lang.Double getMinSupport()

Description copied from interface: UnivariateDistribution

Gets the minimum support (domain or input) of the distribution.

Specified by:

getMinSupport in interface UnivariateDistribution<java.lang.Double>

Returns:

Minimum support.

getMaxSupport

public java.lang.Double getMaxSupport()

Description copied from interface: UnivariateDistribution

Gets the minimum support (domain or input) of the distribution.

Specified by:

getMaxSupport in interface UnivariateDistribution<java.lang.Double>

Returns:

Minimum support.

getCDF

public ScalarDataDistribution.CDF getCDF()

Description copied from interface: UnivariateDistribution

Gets the CDF of a scalar distribution.

Specified by:

getCDF in interface UnivariateDistribution<java.lang.Double>

Returns:

CDF of the scalar distribution.

getVariance

@PublicationReference(title="Algorithms for calculating variance",
                      type=WebPage,
                      year=2010,
                      author="Wikipedia",
                      url="http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance")
public double getVariance()

Description copied from interface: UnivariateDistribution

Gets the variance of the distribution. This is sometimes called the second central moment by more pedantic people, which is equivalent to the square of the standard deviation.

Specified by:

getVariance in interface UnivariateDistribution<java.lang.Double>

Returns:

Variance of the distribution.