gov.sandia.cognition.statistics.distribution
Class LaplaceDistribution.PDF

java.lang.Object
  gov.sandia.cognition.util.AbstractCloneableSerializable
      gov.sandia.cognition.statistics.AbstractDistribution<NumberType>
          gov.sandia.cognition.statistics.AbstractClosedFormUnivariateDistribution<Double>
              gov.sandia.cognition.statistics.AbstractClosedFormSmoothUnivariateDistribution
                  gov.sandia.cognition.statistics.distribution.LaplaceDistribution
                      gov.sandia.cognition.statistics.distribution.LaplaceDistribution.PDF

All Implemented Interfaces:

Evaluator<Double,Double>, Vectorizable, ScalarFunction<Double>, UnivariateScalarFunction, ClosedFormComputableDistribution<Double>, ClosedFormDistribution<Double>, ClosedFormUnivariateDistribution<Double>, ComputableDistribution<Double>, Distribution<Double>, DistributionWithMean<Double>, EstimableDistribution<Double,LaplaceDistribution>, ProbabilityDensityFunction<Double>, ProbabilityFunction<Double>, SmoothUnivariateDistribution, UnivariateDistribution<Double>, UnivariateProbabilityDensityFunction, CloneableSerializable, Serializable, Cloneable

Enclosing class:

LaplaceDistribution

public static class LaplaceDistribution.PDF
extends LaplaceDistribution
implements UnivariateProbabilityDensityFunction

The PDF of a Laplace Distribution.

See Also:

Serialized Form

Nested Class Summary

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

LaplaceDistribution.CDF, LaplaceDistribution.MaximumLikelihoodEstimator, LaplaceDistribution.PDF, LaplaceDistribution.WeightedMaximumLikelihoodEstimator

Field Summary

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

DEFAULT_MEAN, DEFAULT_SCALE, mean, scale

Constructor Summary

LaplaceDistribution.PDF()
Creates a new instance of LaplaceDistribution.PDF

LaplaceDistribution.PDF(double mean, double scale)
Creates a new instance of LaplaceDistribution.PDF

LaplaceDistribution.PDF(LaplaceDistribution other)
Copy Constructor

Method Summary

double	evaluate(double input) Produces a double output for the given double input
Double	evaluate(Double input) Evaluates the function on the given input and returns the output.
double	evaluateAsDouble(Double input) Evaluates the scalar function as a double.
LaplaceDistribution.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(Double input) Evaluate the natural logarithm of the distribution function.

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

clone, convertFromVector, convertToVector, getCDF, getEstimator, getMaxSupport, getMean, getMinSupport, getScale, getVariance, sample, setMean, setScale, toString

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

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

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

getMaxSupport, getMinSupport, getVariance

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

sample, sample

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

clone, convertFromVector, convertToVector

Constructor Detail

LaplaceDistribution.PDF

public LaplaceDistribution.PDF()

Creates a new instance of LaplaceDistribution.PDF

LaplaceDistribution.PDF

public LaplaceDistribution.PDF(double mean,
                               double scale)

Creates a new instance of LaplaceDistribution.PDF

Parameters:

mean - Mean of the distribution

scale - Scale factor of the distribution, must be greater than zero.

LaplaceDistribution.PDF

public LaplaceDistribution.PDF(LaplaceDistribution other)

Copy Constructor

Parameters:

other - LaplaceDistribution to copy

Method Detail

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

evaluate

public Double evaluate(Double input)

Description copied from interface: Evaluator

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

Specified by:

evaluate in interface Evaluator<Double,Double>

Parameters:

input - The input to evaluate.

Returns:

The output produced by evaluating the input.

evaluateAsDouble

public double evaluateAsDouble(Double input)

Description copied from interface: ScalarFunction

Evaluates the scalar function as a double.

Specified by:

evaluateAsDouble in interface ScalarFunction<Double>

Parameters:

input - The input value.

Returns:

The scalar output calculated from the given input.

logEvaluate

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

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 LaplaceDistribution.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<Double>

Specified by:

getProbabilityFunction in interface ProbabilityDensityFunction<Double>

Specified by:

getProbabilityFunction in interface SmoothUnivariateDistribution

Specified by:

getProbabilityFunction in interface UnivariateProbabilityDensityFunction

Overrides:

getProbabilityFunction in class LaplaceDistribution

Returns:

Distribution function associated with this Distribution.