Package org.apache.commons.statistics.distribution

Class NakagamiDistribution

java.lang.Object
org.apache.commons.statistics.distribution.NakagamiDistribution
All Implemented Interfaces:
ContinuousDistribution
public class NakagamiDistribution
extends java.lang.Object
This class implements the Nakagami distribution.

  • Constructor Details

    • NakagamiDistribution

      public NakagamiDistribution​(double mu, double omega)
      Creates a distribution.
      Parameters:
      mu - shape parameter
      omega - scale parameter (must be positive)
      Throws:
      java.lang.IllegalArgumentException - if mu < 0.5 or if omega <= 0.

  • Method Details

    • getShape

      public double getShape()
      Access the shape parameter, mu.
      Returns:
      the shape parameter.

    • getScale

      public double getScale()
      Access the scale parameter, omega.
      Returns:
      the scale parameter.

    • density

      public double density​(double x)
      Returns the probability density function (PDF) of this distribution evaluated at the specified point 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.
      Parameters:
      x - Point at which the PDF is evaluated.
      Returns:
      the value of the probability density function at x.

    • cumulativeProbability

      public double cumulativeProbability​(double x)
      For a random variable 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.
      Parameters:
      x - Point at which the CDF is evaluated.
      Returns:
      the probability that a random variable with this distribution takes a value less than or equal to x.

    • getMean

      public double getMean()
      Gets the mean of this distribution.
      Returns:
      the mean, or Double.NaN if it is not defined.

    • getVariance

      public double getVariance()
      Gets the variance of this distribution.
      Returns:
      the variance, or Double.NaN if it is not defined.

    • getSupportLowerBound

      public double getSupportLowerBound()
      Gets the lower bound of the support. It must return the same value as inverseCumulativeProbability(0), i.e. inf {x in R | P(X <= x) > 0}.
      Returns:
      the lower bound of the support.

    • getSupportUpperBound

      public double getSupportUpperBound()
      Gets the upper bound of the support. It must return the same value as inverseCumulativeProbability(1), i.e. inf {x in R | P(X <= x) = 1}.
      Returns:
      the upper bound of the support.

    • isSupportConnected

      public boolean isSupportConnected()
      Indicates whether the support is connected, i.e. whether all values between the lower and upper bound of the support are included in the support.
      Returns:
      whether the support is connected.

    • inverseCumulativeProbability

      public double inverseCumulativeProbability​(double p)
      Computes the quantile function of this distribution. For a random variable X distributed according to this distribution, the returned value is
      • inf{x in R | P(X<=x) >= p} for 0 < p <= 1,
      • inf{x in R | P(X<=x) > 0} for p = 0.
      The default implementation returns
      Specified by:
      inverseCumulativeProbability in interface ContinuousDistribution
      Parameters:
      p - Cumulative probability.
      Returns:
      the smallest p-quantile of this distribution (largest 0-quantile for p = 0).

    • sample

      public static double[] sample​(int n, ContinuousDistribution.Sampler sampler)
      Utility function for allocating an array and filling it with n samples generated by the given sampler.
      Parameters:
      n - Number of samples.
      sampler - Sampler.
      Returns:
      an array of size n.

    • createSampler

      public ContinuousDistribution.Sampler createSampler​(UniformRandomProvider rng)
      Creates a sampler.
      Specified by:
      createSampler in interface ContinuousDistribution
      Parameters:
      rng - Generator of uniformly distributed numbers.
      Returns:
      a sampler that produces random numbers according this distribution.