gov.sandia.cognition.statistics.distribution
Class GammaDistribution.CDF

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.AbstractClosedFormSmoothUnivariateDistribution
                  extended by gov.sandia.cognition.statistics.distribution.GammaDistribution
                      extended by gov.sandia.cognition.statistics.distribution.GammaDistribution.CDF
All Implemented Interfaces:
Evaluator<Double,Double>, ClosedFormDifferentiableEvaluator<Double,Double,Double>, DifferentiableEvaluator<Double,Double,Double>, Vectorizable, ScalarFunction<Double>, UnivariateScalarFunction, ClosedFormComputableDistribution<Double>, ClosedFormCumulativeDistributionFunction<Double>, ClosedFormDistribution<Double>, ClosedFormUnivariateDistribution<Double>, ComputableDistribution<Double>, CumulativeDistributionFunction<Double>, Distribution<Double>, DistributionWithMean<Double>, EstimableDistribution<Double,GammaDistribution>, SmoothCumulativeDistributionFunction, SmoothUnivariateDistribution, UnivariateDistribution<Double>, CloneableSerializable, Serializable, Cloneable
Enclosing class:
GammaDistribution

public static class GammaDistribution.CDF
extends GammaDistribution
implements SmoothCumulativeDistributionFunction

CDF of the Gamma distribution

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class gov.sandia.cognition.statistics.distribution.GammaDistribution
GammaDistribution.CDF, GammaDistribution.MomentMatchingEstimator, GammaDistribution.PDF, GammaDistribution.WeightedMomentMatchingEstimator
 
Field Summary
 
Fields inherited from class gov.sandia.cognition.statistics.distribution.GammaDistribution
DEFAULT_SCALE, DEFAULT_SHAPE
 
Constructor Summary
GammaDistribution.CDF()
          Default constructor.
GammaDistribution.CDF(double shape, double scale)
          Creates a new instance of CDF
GammaDistribution.CDF(GammaDistribution other)
          Copy constructor
 
Method Summary
 Double differentiate(Double input)
          Differentiates the output with respect to the input
 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.
static double evaluate(double x, double shape, double scale)
          Evaluates the CDF of the Gamma distribution about x, given the shape and scale parameters
 double evaluateAsDouble(Double input)
          Evaluates the scalar function as a double.
 GammaDistribution.CDF getCDF()
          Gets the CDF of a scalar distribution.
 GammaDistribution.PDF getDerivative()
          Gets the closed-form derivative of the function.
 
Methods inherited from class gov.sandia.cognition.statistics.distribution.GammaDistribution
clone, convertFromVector, convertToVector, getEstimator, getMaxSupport, getMean, getMinSupport, getProbabilityFunction, getScale, getShape, getVariance, sample, sample, setScale, setShape, 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
getMean, getProbabilityFunction
 
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

GammaDistribution.CDF

public GammaDistribution.CDF()
Default constructor.


GammaDistribution.CDF

public GammaDistribution.CDF(double shape,
                             double scale)
Creates a new instance of CDF

Parameters:
shape - Shape parameter of the Gamma distribution, often written as "k", must be greater than zero
scale - Scale parameters of the Gamma distribution, often written as "theta", must be greater than zero. Note that this is the INVERSE of what octave uses!!

GammaDistribution.CDF

public GammaDistribution.CDF(GammaDistribution other)
Copy constructor

Parameters:
other - GammaDistribution to copy
Method Detail

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.

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 static double evaluate(double x,
                              double shape,
                              double scale)
Evaluates the CDF of the Gamma distribution about x, given the shape and scale parameters

Parameters:
x - Input to the CDF
shape - Shape parameter of the Gamma distribution, often written as "k", must be greater than zero
scale - Scale parameters of the Gamma distribution, often written as "theta", must be greater than zero. Note that this is the INVERSE of what octave uses!!
Returns:
Pr(y le x;shape,scale)

getCDF

public GammaDistribution.CDF getCDF()
Description copied from interface: UnivariateDistribution
Gets the CDF of a scalar distribution.

Specified by:
getCDF in interface ClosedFormUnivariateDistribution<Double>
Specified by:
getCDF in interface SmoothUnivariateDistribution
Specified by:
getCDF in interface UnivariateDistribution<Double>
Overrides:
getCDF in class GammaDistribution
Returns:
CDF of the scalar distribution.

getDerivative

public GammaDistribution.PDF getDerivative()
Description copied from interface: ClosedFormDifferentiableEvaluator
Gets the closed-form derivative of the function.

Specified by:
getDerivative in interface ClosedFormDifferentiableEvaluator<Double,Double,Double>
Specified by:
getDerivative in interface SmoothCumulativeDistributionFunction
Returns:
Closed-form derivative of the function.

differentiate

public Double differentiate(Double input)
Description copied from interface: DifferentiableEvaluator
Differentiates the output with respect to the input

Specified by:
differentiate in interface DifferentiableEvaluator<Double,Double,Double>
Parameters:
input - Input about which to compute the derivative
Returns:
Derivative of the output with respect to the given input