Package org.hipparchus.distribution.continuous

Class ConstantRealDistribution

java.lang.Object
org.hipparchus.distribution.continuous.AbstractRealDistribution
org.hipparchus.distribution.continuous.ConstantRealDistribution
All Implemented Interfaces:
Serializable, RealDistribution
public class ConstantRealDistribution extends AbstractRealDistribution
Implementation of the constant real distribution.
See Also:

  • Constructor Details Link icon

    • ConstantRealDistribution Link icon

      public ConstantRealDistribution(double value)
      Create a constant real distribution with the given value.
      Parameters:
      value - the constant value of this distribution

  • Method Details Link icon

    • density Link icon

      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 - the point at which the PDF is evaluated
      Returns:
      the value of the probability density function at point x

    • cumulativeProbability Link icon

      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 - the 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

    • inverseCumulativeProbability Link icon

      public double inverseCumulativeProbability(double p) throws MathIllegalArgumentException
      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 RealDistribution
      Overrides:
      inverseCumulativeProbability in class AbstractRealDistribution
      Parameters:
      p - the cumulative probability
      Returns:
      the smallest p-quantile of this distribution (largest 0-quantile for p = 0)
      Throws:
      MathIllegalArgumentException - if p < 0 or p > 1

    • getNumericalMean Link icon

      public double getNumericalMean()
      Use this method to get the numerical value of the mean of this distribution.
      Returns:
      the mean or Double.NaN if it is not defined

    • getNumericalVariance Link icon

      public double getNumericalVariance()
      Use this method to get the numerical value of the variance of this distribution.
      Returns:
      the variance (possibly Double.POSITIVE_INFINITY as for certain cases in TDistribution) or Double.NaN if it is not defined

    • getSupportLowerBound Link icon

      public double getSupportLowerBound()
      Access the lower bound of the support. This method must return the same value as inverseCumulativeProbability(0). In other words, this method must return

      inf {x in R | P(X <= x) > 0}.

      Returns:
      lower bound of the support (might be Double.NEGATIVE_INFINITY)

    • getSupportUpperBound Link icon

      public double getSupportUpperBound()
      Access the upper bound of the support. This method must return the same value as inverseCumulativeProbability(1). In other words, this method must return

      inf {x in R | P(X <= x) = 1}.

      Returns:
      upper bound of the support (might be Double.POSITIVE_INFINITY)

    • isSupportConnected Link icon

      public boolean isSupportConnected()
      Use this method to get information about 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 or not