Serializable, RealDistributionpublic class GammaDistribution extends AbstractRealDistribution
RealDistribution.Sampler| Modifier and Type | Field | Description |
|---|---|---|
static double |
DEFAULT_INVERSE_ABSOLUTE_ACCURACY |
Default inverse cumulative probability accuracy.
|
SOLVER_DEFAULT_ABSOLUTE_ACCURACY| Constructor | Description |
|---|---|
GammaDistribution(double shape,
double scale) |
Creates a distribution.
|
GammaDistribution(double shape,
double scale,
double inverseCumAccuracy) |
Creates a distribution.
|
| Modifier and Type | Method | Description |
|---|---|---|
RealDistribution.Sampler |
createSampler(org.apache.commons.rng.UniformRandomProvider rng) |
Creates a sampler.
|
double |
cumulativeProbability(double x) |
For a random variable
X whose values are distributed according
to this distribution, this method returns P(X <= x). |
double |
density(double x) |
Returns the probability density function (PDF) of this distribution
evaluated at the specified point
x. |
double |
getNumericalMean() |
Use this method to get the numerical value of the mean of this
distribution.
|
double |
getNumericalVariance() |
Use this method to get the numerical value of the variance of this
distribution.
|
double |
getScale() |
Returns the scale parameter of
this distribution. |
double |
getShape() |
Returns the shape parameter of
this distribution. |
protected double |
getSolverAbsoluteAccuracy() |
Returns the solver absolute accuracy for inverse cumulative computation.
|
double |
getSupportLowerBound() |
Access the lower bound of the support.
|
double |
getSupportUpperBound() |
Access the upper bound of the support.
|
boolean |
isSupportConnected() |
Use this method to get information about whether the support is connected,
i.e.
|
double |
logDensity(double x) |
Returns the natural logarithm of the probability density function
(PDF) of this distribution evaluated at the specified point
x. |
inverseCumulativeProbability, probability, probability, samplepublic static final double DEFAULT_INVERSE_ABSOLUTE_ACCURACY
public GammaDistribution(double shape,
double scale)
throws NotStrictlyPositiveException
shape - the shape parameterscale - the scale parameterNotStrictlyPositiveException - if shape <= 0 or
scale <= 0.public GammaDistribution(double shape,
double scale,
double inverseCumAccuracy)
throws NotStrictlyPositiveException
shape - the shape parameterscale - the scale parameterinverseCumAccuracy - the maximum absolute error in inverse
cumulative probability estimates (defaults to
DEFAULT_INVERSE_ABSOLUTE_ACCURACY).NotStrictlyPositiveException - if shape <= 0 or
scale <= 0.public double getShape()
this distribution.public double getScale()
this distribution.public double density(double x)
x. In general, the PDF is
the derivative of the CDF.
If the derivative does not exist at x, then an appropriate
replacement should be returned, e.g. Double.POSITIVE_INFINITY,
Double.NaN, or the limit inferior or limit superior of the
difference quotient.x - the point at which the PDF is evaluatedxpublic double logDensity(double x)
x.
In general, the PDF is the derivative of the CDF.
If the derivative does not exist at x, then an appropriate replacement
should be returned, e.g. Double.POSITIVE_INFINITY, Double.NaN,
or the limit inferior or limit superior of the difference quotient. Note that
due to the floating point precision and under/overflow issues, this method will
for some distributions be more precise and faster than computing the logarithm of
RealDistribution.density(double).
The default implementation simply computes the logarithm of density(x).
logDensity in interface RealDistributionlogDensity in class AbstractRealDistributionx - the point at which the PDF is evaluatedxpublic double cumulativeProbability(double x)
X whose values are distributed according
to this distribution, this method returns P(X <= x). In other
words, this method represents the (cumulative) distribution function
(CDF) for this distribution.
The implementation of this method is based on:
x - the point at which the CDF is evaluatedxprotected double getSolverAbsoluteAccuracy()
getSolverAbsoluteAccuracy in class AbstractRealDistributionpublic double getNumericalMean()
alpha and scale parameter beta, the
mean is alpha * beta.Double.NaN if it is not definedpublic double getNumericalVariance()
alpha and scale parameter beta, the
variance is alpha * beta^2.Double.POSITIVE_INFINITY as
for certain cases in TDistribution) or Double.NaN if it
is not definedpublic double getSupportLowerBound()
inverseCumulativeProbability(0). In other words, this
method must return
inf {x in R | P(X <= x) > 0}.
public double getSupportUpperBound()
inverseCumulativeProbability(1). In other words, this
method must return
inf {x in R | P(X <= x) = 1}.
public boolean isSupportConnected()
truepublic RealDistribution.Sampler createSampler(org.apache.commons.rng.UniformRandomProvider rng)
Sampling algorithms:
0 < shape < 1:
Ahrens, J. H. and Dieter, U., Computer methods for sampling from gamma, beta, Poisson and binomial distributions, Computing, 12, 223-246, 1974.
shape >= 1:
Marsaglia and Tsang, A Simple Method for Generating Gamma Variables. ACM Transactions on Mathematical Software, Volume 26 Issue 3, September, 2000.
createSampler in interface RealDistributioncreateSampler in class AbstractRealDistributionrng - Generator of uniformly distributed numbers.Copyright © 2003–2017 The Apache Software Foundation. All rights reserved.