gov.sandia.cognition.statistics.distribution
Class ChiSquareDistribution.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.ChiSquareDistribution
                      extended by gov.sandia.cognition.statistics.distribution.ChiSquareDistribution.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>, SmoothCumulativeDistributionFunction, SmoothUnivariateDistribution, UnivariateDistribution<Double>, CloneableSerializable, Serializable, Cloneable
Enclosing class:
ChiSquareDistribution

public static class ChiSquareDistribution.CDF
extends ChiSquareDistribution
implements SmoothCumulativeDistributionFunction

Cumulative Distribution Function (CDF) of a Chi-Square Distribution

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class gov.sandia.cognition.statistics.distribution.ChiSquareDistribution
ChiSquareDistribution.CDF, ChiSquareDistribution.PDF
 
Field Summary
 
Fields inherited from class gov.sandia.cognition.statistics.distribution.ChiSquareDistribution
DEFAULT_DEGREES_OF_FREEDOM
 
Constructor Summary
ChiSquareDistribution.CDF()
          Default constructor.
ChiSquareDistribution.CDF(ChiSquareDistribution other)
          Copy constructor
ChiSquareDistribution.CDF(double degreesOfFreedom)
          Creates a new instance of ChiSquareDistribution
 
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 input, double degreesOfFreedom)
          Computes the values of the Chi-Square CDF for the given input and degrees of freedom
 double evaluateAsDouble(Double input)
          Evaluates the scalar function as a double.
 ChiSquareDistribution.CDF getCDF()
          Gets the CDF of a scalar distribution.
 ChiSquareDistribution.PDF getDerivative()
          Gets the closed-form derivative of the function.
 
Methods inherited from class gov.sandia.cognition.statistics.distribution.ChiSquareDistribution
clone, convertFromVector, convertToVector, getDegreesOfFreedom, getMaxSupport, getMean, getMinSupport, getProbabilityFunction, getVariance, sample, sample, setDegreesOfFreedom
 
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.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

ChiSquareDistribution.CDF

public ChiSquareDistribution.CDF()
Default constructor.


ChiSquareDistribution.CDF

public ChiSquareDistribution.CDF(double degreesOfFreedom)
Creates a new instance of ChiSquareDistribution

Parameters:
degreesOfFreedom - Number of degrees of freedom in the distribution, must be greater than 0.0

ChiSquareDistribution.CDF

public ChiSquareDistribution.CDF(ChiSquareDistribution other)
Copy constructor

Parameters:
other - ChiSquareDistribution 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.

evaluate

public static double evaluate(double input,
                              double degreesOfFreedom)
Computes the values of the Chi-Square CDF for the given input and degrees of freedom

Parameters:
input - Input about which to evaluate the CDF
degreesOfFreedom - Number of degrees of freedom in the distribution
Returns:
Pr{ y <= input | degreesOfFreedom }

getCDF

public ChiSquareDistribution.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 ChiSquareDistribution
Returns:
CDF of the scalar distribution.

getDerivative

public ChiSquareDistribution.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