Package org.apache.commons.statistics.distribution

Class TDistribution

    • Constructor Summary

      Constructors 
      Constructor Description
      TDistribution​(double degreesOfFreedom)
      Creates a distribution.

    • Method Summary

      Modifier and Type Method Description
      ContinuousDistribution.Sampler createSampler​(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 getDegreesOfFreedom()
      Access the degrees of freedom.
      double getMean()
      Gets the mean of this distribution.
      double getSupportLowerBound()
      Gets the lower bound of the support.
      double getSupportUpperBound()
      Gets the upper bound of the support.
      double getVariance()
      Gets the variance of this distribution.
      double inverseCumulativeProbability​(double p)
      Computes the quantile function of this distribution.
      boolean isSupportConnected()
      Indicates 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.
      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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TDistribution

        public TDistribution​(double degreesOfFreedom)
        Creates a distribution.
        Parameters:
        degreesOfFreedom - Degrees of freedom.
        Throws:
        java.lang.IllegalArgumentException - if degreesOfFreedom <= 0

    • Method Detail

      • getDegreesOfFreedom

        public double getDegreesOfFreedom()
        Access the degrees of freedom.
        Returns:
        the degrees of freedom.

      • 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.

      • logDensity

        public double logDensity​(double x)
        Returns the natural logarithm of the probability density function (PDF) of this distribution evaluated at the specified point x.
        Parameters:
        x - Point at which the PDF is evaluated.
        Returns:
        the logarithm of 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. For degrees of freedom parameter df, the mean is
        • zero if df > 1, and
        • undefined (Double.NaN) otherwise.
        Returns:
        the mean, or Double.NaN if it is not defined.

      • getVariance

        public double getVariance()
        Gets the variance of this distribution. For degrees of freedom parameter df, the variance is
        • df / (df - 2) if df > 2,
        • infinite (Double.POSITIVE_INFINITY) if 1 < df <= 2, and
        • undefined (Double.NaN) otherwise.
        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}. The lower bound of the support is always negative infinity..
        Returns:
        lower bound of the support (always Double.NEGATIVE_INFINITY)

      • 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}. The upper bound of the support is always positive infinity.
        Returns:
        upper bound of the support (always Double.POSITIVE_INFINITY)

      • 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. The support of this distribution is connected.
        Returns:
        true

      • 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.