gov.sandia.cognition.statistics.distribution

Class BetaBinomialDistribution.PMF

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.statistics.AbstractDistribution<NumberType>

gov.sandia.cognition.statistics.AbstractClosedFormUnivariateDistribution<java.lang.Number>

gov.sandia.cognition.statistics.AbstractClosedFormIntegerDistribution

gov.sandia.cognition.statistics.distribution.BetaBinomialDistribution

gov.sandia.cognition.statistics.distribution.BetaBinomialDistribution.PMF

All Implemented Interfaces:

Evaluator<java.lang.Number,java.lang.Double>, Vectorizable, ClosedFormComputableDistribution<java.lang.Number>, ClosedFormDiscreteUnivariateDistribution<java.lang.Number>, ClosedFormDistribution<java.lang.Number>, ClosedFormUnivariateDistribution<java.lang.Number>, ComputableDistribution<java.lang.Number>, DiscreteDistribution<java.lang.Number>, Distribution<java.lang.Number>, DistributionWithMean<java.lang.Number>, EstimableDistribution<java.lang.Number,BetaBinomialDistribution>, IntegerDistribution, ProbabilityFunction<java.lang.Number>, ProbabilityMassFunction<java.lang.Number>, UnivariateDistribution<java.lang.Number>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

BetaBinomialDistribution

public static class BetaBinomialDistribution.PMF
extends BetaBinomialDistribution
implements ProbabilityMassFunction<java.lang.Number>

PMF of the BetaBinomialDistribution

See Also:

Serialized Form

Nested Class Summary

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

BetaBinomialDistribution.CDF, BetaBinomialDistribution.MomentMatchingEstimator, BetaBinomialDistribution.PMF

Field Summary

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

DEFAULT_N, DEFAULT_SCALE, DEFAULT_SHAPE, n, scale, shape

Constructor Summary

Constructors

Constructor and Description
PMF() Creates a new instance of BetaBinomialDistribution
PMF(BetaBinomialDistribution other) Copy constructor
PMF(int n, double shape, double scale) Creates a new instance of BetaBinomialDistribution

Method Summary

Modifier and Type	Method and Description
java.lang.Double	evaluate(java.lang.Number input) Evaluates the function on the given input and returns the output.
double	getEntropy() Gets the entropy of the values in the histogram.
BetaBinomialDistribution.PMF	getProbabilityFunction() Gets the distribution function associated with this Distribution, either the PDF or PMF.
double	logEvaluate(java.lang.Number input) Evaluate the natural logarithm of the distribution function.

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

clone, convertFromVector, convertToVector, getCDF, getDomain, getDomainSize, getEstimator, getMaxSupport, getMean, getMeanAsDouble, getMinSupport, getN, getScale, getShape, getVariance, sampleAsInt, sampleInto, sampleInto, setN, setScale, setShape

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

sampleAsInts

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

sample, sample

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

getDomain, getDomainSize

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

sample, sample, sampleInto

Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable

clone

Constructor Detail

PMF

public PMF()

Creates a new instance of BetaBinomialDistribution

PMF

public PMF(int n,
           double shape,
           double scale)

Creates a new instance of BetaBinomialDistribution

Parameters:

shape - Shape, similar to the beta parameter shape, must be greater than zero

scale - Scale, similar to the beta parameter scale, must be greater than zero

n - Number of observations, similar to the Binomial N, must be greater than zero

PMF

public PMF(BetaBinomialDistribution other)

Copy constructor

Parameters:

other - BetaBinomialDistribution to copy

Method Detail

getProbabilityFunction

public BetaBinomialDistribution.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.Number>

Specified by:

getProbabilityFunction in interface DiscreteDistribution<java.lang.Number>

Specified by:

getProbabilityFunction in interface ProbabilityMassFunction<java.lang.Number>

Overrides:

getProbabilityFunction in class BetaBinomialDistribution

Returns:

Distribution function associated with this Distribution.

evaluate

public java.lang.Double evaluate(java.lang.Number input)

Description copied from interface: Evaluator

Evaluates the function on the given input and returns the output.

Specified by:

evaluate in interface Evaluator<java.lang.Number,java.lang.Double>

Parameters:

input - The input to evaluate.

Returns:

The output produced by evaluating the input.

logEvaluate

public double logEvaluate(java.lang.Number input)

Description copied from interface: ProbabilityFunction

Evaluate the natural logarithm of the distribution function. This is sometimes more efficient than evaluating the distribution function itself, and when evaluating the product of many independent or exchangeable samples.

Specified by:

logEvaluate in interface ProbabilityFunction<java.lang.Number>

Parameters:

input - The input to be evaluated

Returns:

Natural logarithm of the distribution function.

getEntropy

public double getEntropy()

Description copied from interface: ProbabilityMassFunction

Gets the entropy of the values in the histogram.

Specified by:

getEntropy in interface ProbabilityMassFunction<java.lang.Number>

Returns:

The entropy of the values in the histogram.