gov.sandia.cognition.statistics.distribution

Class YuleSimonDistribution.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.YuleSimonDistribution

gov.sandia.cognition.statistics.distribution.YuleSimonDistribution.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>, IntegerDistribution, ProbabilityFunction<java.lang.Number>, ProbabilityMassFunction<java.lang.Number>, UnivariateDistribution<java.lang.Number>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

YuleSimonDistribution

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

PMF of the Yule-Simon Distribution

See Also:

Serialized Form

Nested Class Summary

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

YuleSimonDistribution.CDF, YuleSimonDistribution.PMF

Field Summary

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

DEFAULT_SHAPE, shape

Constructor Summary

Constructors

Constructor and Description
PMF() Creates a new instance of YuleSimonDistribution
PMF(double shape) Creates a new instance of YuleSimonDistribution
PMF(YuleSimonDistribution other) Copy constructor

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

clone, convertFromVector, convertToVector, getCDF, getDomain, getDomainSize, getMaxSupport, getMean, getMeanAsDouble, getMinSupport, getShape, getVariance, sampleAsInt, sampleInto, setShape

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

sampleAsInts, sampleInto

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 YuleSimonDistribution

PMF

public PMF(double shape)

Creates a new instance of YuleSimonDistribution

Parameters:

shape - Shape parameter, must be greater than zero

PMF

public PMF(YuleSimonDistribution other)

Copy constructor

Parameters:

other - YuleSimonDistribution to copy

Method Detail

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.

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.

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.

getProbabilityFunction

public YuleSimonDistribution.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 YuleSimonDistribution

Returns:

Distribution function associated with this Distribution.