gov.sandia.cognition.statistics.distribution
Class DeterministicDistribution.PMF

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.statistics.AbstractDistribution<NumberType>
          extended by gov.sandia.cognition.statistics.AbstractClosedFormUnivariateDistribution<Double>
              extended by gov.sandia.cognition.statistics.distribution.DeterministicDistribution
                  extended by gov.sandia.cognition.statistics.distribution.DeterministicDistribution.PMF
All Implemented Interfaces:
Evaluator<Double,Double>, Vectorizable, ClosedFormComputableDistribution<Double>, ClosedFormDiscreteUnivariateDistribution<Double>, ClosedFormDistribution<Double>, ClosedFormUnivariateDistribution<Double>, ComputableDistribution<Double>, DiscreteDistribution<Double>, Distribution<Double>, DistributionWithMean<Double>, ProbabilityFunction<Double>, ProbabilityMassFunction<Double>, UnivariateDistribution<Double>, CloneableSerializable, Serializable, Cloneable
Enclosing class:
DeterministicDistribution

public static class DeterministicDistribution.PMF
extends DeterministicDistribution
implements ProbabilityMassFunction<Double>

PMF of the deterministic distribution.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class gov.sandia.cognition.statistics.distribution.DeterministicDistribution
DeterministicDistribution.CDF, DeterministicDistribution.PMF
 
Field Summary
 
Fields inherited from class gov.sandia.cognition.statistics.distribution.DeterministicDistribution
DEFAULT_POINT
 
Constructor Summary
DeterministicDistribution.PMF()
          Creates a new instance of DeterministicDistribution
DeterministicDistribution.PMF(DeterministicDistribution other)
          Copy Constructor
DeterministicDistribution.PMF(double point)
          Creates a new instance of DeterministicDistribution
 
Method Summary
 Double evaluate(Double input)
          Evaluates the function on the given input and returns the output.
 double getEntropy()
          Gets the entropy of the values in the histogram.
 DeterministicDistribution.PMF 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.
 
Methods inherited from class gov.sandia.cognition.statistics.distribution.DeterministicDistribution
convertFromVector, convertToVector, getCDF, getDomain, getDomainSize, getMaxSupport, getMean, getMinSupport, getPoint, getVariance, sample, setPoint
 
Methods inherited from class gov.sandia.cognition.statistics.AbstractClosedFormUnivariateDistribution
clone
 
Methods inherited from class gov.sandia.cognition.statistics.AbstractDistribution
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
 
Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable
clone
 
Methods inherited from interface gov.sandia.cognition.math.matrix.Vectorizable
clone
 

Constructor Detail

DeterministicDistribution.PMF

public DeterministicDistribution.PMF()
Creates a new instance of DeterministicDistribution


DeterministicDistribution.PMF

public DeterministicDistribution.PMF(double point)
Creates a new instance of DeterministicDistribution

Parameters:
point - Location of the distribution

DeterministicDistribution.PMF

public DeterministicDistribution.PMF(DeterministicDistribution other)
Copy Constructor

Parameters:
other - DeterministicDistribution 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<Double>
Returns:
The entropy of the values in the histogram.

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.

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.

getProbabilityFunction

public DeterministicDistribution.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<Double>
Specified by:
getProbabilityFunction in interface DiscreteDistribution<Double>
Specified by:
getProbabilityFunction in interface ProbabilityMassFunction<Double>
Overrides:
getProbabilityFunction in class DeterministicDistribution
Returns:
Distribution function associated with this Distribution.