gov.sandia.cognition.statistics.distribution

Class NormalInverseGammaDistribution.PDF

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

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

gov.sandia.cognition.statistics.distribution.NormalInverseGammaDistribution

gov.sandia.cognition.statistics.distribution.NormalInverseGammaDistribution.PDF

All Implemented Interfaces:

Evaluator<Vector,java.lang.Double>, VectorInputEvaluator<Vector,java.lang.Double>, Vectorizable, ClosedFormComputableDistribution<Vector>, ClosedFormDistribution<Vector>, ComputableDistribution<Vector>, Distribution<Vector>, DistributionWithMean<Vector>, ProbabilityDensityFunction<Vector>, ProbabilityFunction<Vector>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

NormalInverseGammaDistribution

public static class NormalInverseGammaDistribution.PDF
extends NormalInverseGammaDistribution
implements ProbabilityDensityFunction<Vector>, VectorInputEvaluator<Vector,java.lang.Double>

PDF of the NormalInverseGammaDistribution

See Also:

Serialized Form

Nested Class Summary

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

NormalInverseGammaDistribution.PDF

Field Summary

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

DEFAULT_LOCATION, DEFAULT_PRECISION, DEFAULT_SCALE, DEFAULT_SHAPE

Constructor Summary

Constructors

Constructor and Description
PDF() Creates a new instance of NormalInverseGammaDistribution
PDF(double location, double precision, double shape, double scale) Creates a new instance of NormalInverseGammaDistribution
PDF(NormalInverseGammaDistribution other) Copy constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Double	evaluate(Vector input) Evaluates the function on the given input and returns the output.
int	getInputDimensionality() Gets the expected dimensionality of the input vector to the evaluator, if it is known.
NormalInverseGammaDistribution.PDF	getProbabilityFunction() Gets the distribution function associated with this Distribution, either the PDF or PMF.
double	logEvaluate(Vector input) Evaluate the natural logarithm of the distribution function.

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

clone, convertFromVector, convertToVector, getLocation, getMean, getPrecision, getScale, getShape, sampleInto, setLocation, setPrecision, setScale, setShape, toString

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

getMean

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

clone, convertFromVector, convertToVector

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

sample, sample, sampleInto

Constructor Detail

PDF

public PDF()

Creates a new instance of NormalInverseGammaDistribution

PDF

public PDF(double location,
           double precision,
           double shape,
           double scale)

Creates a new instance of NormalInverseGammaDistribution

Parameters:

location - Location of the Gaussian kernel.

precision - Precision of the Gaussian kernel, must be greater than zero.

shape - Shape parameter of the Inverse Gamma kernel, must be greater than zero.

scale - Scale parameter of the Inverse Gamma kernel, must be greater than zero.

PDF

public PDF(NormalInverseGammaDistribution other)

Copy constructor

Parameters:

other - NormalInverseGammaDistribution to copy

Method Detail

getProbabilityFunction

public NormalInverseGammaDistribution.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<Vector>

Specified by:

getProbabilityFunction in interface ProbabilityDensityFunction<Vector>

Overrides:

getProbabilityFunction in class NormalInverseGammaDistribution

Returns:

Distribution function associated with this Distribution.

logEvaluate

public double logEvaluate(Vector 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<Vector>

Parameters:

input - The input to be evaluated

Returns:

Natural logarithm of the distribution function.

evaluate

public java.lang.Double evaluate(Vector input)

Description copied from interface: Evaluator

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

Specified by:

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

Parameters:

input - The input to evaluate.

Returns:

The output produced by evaluating the input.

getInputDimensionality

public int getInputDimensionality()

Description copied from interface: VectorInputEvaluator

Gets the expected dimensionality of the input vector to the evaluator, if it is known. If it is not known, -1 is returned.

Specified by:

getInputDimensionality in interface VectorInputEvaluator<Vector,java.lang.Double>

Returns:

The expected dimensionality of the input vector to the evaluator, or -1 if it is not known.