gov.sandia.cognition.statistics.distribution

Class StudentTDistribution.PDF

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

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

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

gov.sandia.cognition.statistics.AbstractClosedFormSmoothUnivariateDistribution

gov.sandia.cognition.statistics.distribution.StudentTDistribution

gov.sandia.cognition.statistics.distribution.StudentTDistribution.PDF

All Implemented Interfaces:

Evaluator<java.lang.Double,java.lang.Double>, Vectorizable, ScalarFunction<java.lang.Double>, UnivariateScalarFunction, ClosedFormComputableDistribution<java.lang.Double>, ClosedFormDistribution<java.lang.Double>, ClosedFormUnivariateDistribution<java.lang.Double>, ComputableDistribution<java.lang.Double>, Distribution<java.lang.Double>, DistributionWithMean<java.lang.Double>, EstimableDistribution<java.lang.Double,StudentTDistribution>, ProbabilityDensityFunction<java.lang.Double>, ProbabilityFunction<java.lang.Double>, SmoothUnivariateDistribution, UnivariateDistribution<java.lang.Double>, UnivariateProbabilityDensityFunction, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

StudentTDistribution

public static class StudentTDistribution.PDF
extends StudentTDistribution
implements UnivariateProbabilityDensityFunction

Evaluator that computes the Probability Density Function (CDF) of a Student-t distribution with a fixed number of degrees of freedom

See Also:

Serialized Form

Nested Class Summary

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

StudentTDistribution.CDF, StudentTDistribution.MaximumLikelihoodEstimator, StudentTDistribution.PDF, StudentTDistribution.WeightedMaximumLikelihoodEstimator

Field Summary

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

DEFAULT_DEGREES_OF_FREEDOM, DEFAULT_MEAN, DEFAULT_PRECISION, degreesOfFreedom, mean, precision

Constructor Summary

Constructors

Constructor and Description
PDF() Default constructor.
PDF(double degreesOfFreedom) Creates a new instance of PDF
PDF(double degreesOfFreedom, double mean, double precision) Creates a new instance of PDF
PDF(StudentTDistribution other) Creates a new instance of PDF

Method Summary

Modifier and Type	Method and Description
double	evaluate(double input) Produces a double output for the given double input
java.lang.Double	evaluate(java.lang.Double input) Evaluates the function on the given input and returns the output.
double	evaluateAsDouble(java.lang.Double input) Evaluates the scalar function as a double.
StudentTDistribution.PDF	getProbabilityFunction() Gets the distribution function associated with this Distribution, either the PDF or PMF.
double	logEvaluate(double input) Evaluate the natural logarithm of the distribution function.
double	logEvaluate(java.lang.Double input) Evaluate the natural logarithm of the distribution function.

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

clone, convertFromVector, convertToVector, getCDF, getDegreesOfFreedom, getEstimator, getMaxSupport, getMeanAsDouble, getMinSupport, getPrecision, getVariance, sampleInto, setDegreesOfFreedom, setMean, setPrecision, toString

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

getMean, sampleAsDouble, sampleAsDoubles, 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, wait, wait, wait

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

getCDF, getMean, sampleAsDouble, sampleAsDoubles, sampleInto

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

getMaxSupport, getMeanAsDouble, getMinSupport, getVariance

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

sample, sample, sampleInto

Methods inherited from interface gov.sandia.cognition.math.matrix.Vectorizable

clone, convertFromVector, convertToVector

Constructor Detail

PDF

public PDF()

Default constructor.

PDF

public PDF(double degreesOfFreedom)

Creates a new instance of PDF

Parameters:

degreesOfFreedom - Degrees of freedom in the distribution, usually the number of datapoints - 1, DOFs must be greater than zero.

PDF

public PDF(double degreesOfFreedom,
           double mean,
           double precision)

Creates a new instance of PDF

Parameters:

degreesOfFreedom - Degrees of freedom in the distribution, usually the number of datapoints - 1, DOFs must be greater than zero.

mean - Mean, or noncentrality parameter, of the distribution

precision - Precision, inverseRootFinder variance, of the distribution, must be greater than zero.

PDF

public PDF(StudentTDistribution other)

Creates a new instance of PDF

Parameters:

other - The underlying Student t-distribution

Method Detail

evaluate

public java.lang.Double evaluate(java.lang.Double 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.Double,java.lang.Double>

Specified by:

evaluate in interface ScalarFunction<java.lang.Double>

Specified by:

evaluate in interface UnivariateScalarFunction

Parameters:

input - The input to evaluate.

Returns:

The output produced by evaluating the input.

evaluateAsDouble

public double evaluateAsDouble(java.lang.Double input)

Description copied from interface: ScalarFunction

Evaluates the scalar function as a double.

Specified by:

evaluateAsDouble in interface ScalarFunction<java.lang.Double>

Specified by:

evaluateAsDouble in interface UnivariateScalarFunction

Parameters:

input - The input value.

Returns:

The scalar output calculated from the given input.

evaluate

public double evaluate(double input)

Description copied from interface: UnivariateScalarFunction

Produces a double output for the given double input

Specified by:

evaluate in interface UnivariateScalarFunction

Parameters:

input - Input to the Evaluator

Returns:

output at the given input

logEvaluate

public double logEvaluate(java.lang.Double 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.Double>

Parameters:

input - The input to be evaluated

Returns:

Natural logarithm of the distribution function.

logEvaluate

public double logEvaluate(double input)

Description copied from interface: UnivariateProbabilityDensityFunction

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 UnivariateProbabilityDensityFunction

Parameters:

input - The input value.

Returns:

The natural logarithm of the distribution function.

getProbabilityFunction

public StudentTDistribution.PDF 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 ProbabilityDensityFunction<java.lang.Double>

Specified by:

getProbabilityFunction in interface SmoothUnivariateDistribution

Specified by:

getProbabilityFunction in interface UnivariateProbabilityDensityFunction

Overrides:

getProbabilityFunction in class StudentTDistribution

Returns:

Distribution function associated with this Distribution.