Class LogisticDistribution

java.lang.Object
smile.stat.distribution.LogisticDistribution
All Implemented Interfaces:
Serializable, Distribution
public class LogisticDistribution extends Object implements Distribution
The logistic distribution is a continuous probability distribution whose cumulative distribution function is the logistic function, which appears in logistic regression and feedforward neural networks. It resembles the normal distribution in shape but has heavier tails (higher kurtosis).

The logistic distribution and the S-shaped pattern that results from it have been extensively used in many different areas such as:

  • Biology - to describe how species populations grow in competition.
  • Epidemiology - to describe the spreading of epidemics.
  • Psychology - to describe learning.
  • Technology - to describe how new technologies diffuse and substitute for each other.
  • Market - the diffusion of new-product sales.
  • Energy - the diffusion and substitution of primary energy sources.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final double
    mu
    The location parameter.
    final double
    scale
    The scale parameter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogisticDistribution(double mu, double scale)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    cdf(double x)
    Cumulative distribution function.
    double
    entropy()
    Returns Shannon entropy of the distribution.
    int
    length()
    Returns the number of parameters of the distribution.
    double
    logp(double x)
    The density at x in log scale, which may prevents the underflow problem.
    double
    mean()
    Returns the mean of distribution.
    double
    p(double x)
    The probability density function for continuous distribution or probability mass function for discrete distribution at x.
    double
    quantile(double p)
    The quantile, the probability to the left of quantile is p.
    double
    rand()
    Generates a random number following this distribution.
    double
    sd()
    Returns the standard deviation of distribution.
    String
    toString()
     
    double
    variance()
    Returns the variance of distribution.

    Methods inherited from class Object

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

    Methods inherited from interface Distribution

    inverseTransformSampling, likelihood, logLikelihood, quantile, quantile, rand, rejectionSampling

  • Field Details

    • mu

      public final double mu
      The location parameter.

    • scale

      public final double scale
      The scale parameter.

  • Constructor Details

    • LogisticDistribution

      public LogisticDistribution(double mu, double scale)
      Constructor.
      Parameters:
      mu - the location parameter.
      scale - the scale parameter.

  • Method Details

    • length

      public int length()
      Description copied from interface: Distribution
      Returns the number of parameters of the distribution. The "length" is in the sense of the minimum description length principle.
      Specified by:
      length in interface Distribution
      Returns:
      The number of parameters.

    • mean

      public double mean()
      Description copied from interface: Distribution
      Returns the mean of distribution.
      Specified by:
      mean in interface Distribution
      Returns:
      The mean.

    • variance

      public double variance()
      Description copied from interface: Distribution
      Returns the variance of distribution.
      Specified by:
      variance in interface Distribution
      Returns:
      The variance.

    • sd

      public double sd()
      Description copied from interface: Distribution
      Returns the standard deviation of distribution.
      Specified by:
      sd in interface Distribution
      Returns:
      The standard deviation.

    • entropy

      public double entropy()
      Description copied from interface: Distribution
      Returns Shannon entropy of the distribution.
      Specified by:
      entropy in interface Distribution
      Returns:
      Shannon entropy.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • rand

      public double rand()
      Description copied from interface: Distribution
      Generates a random number following this distribution.
      Specified by:
      rand in interface Distribution
      Returns:
      a random number.

    • p

      public double p(double x)
      Description copied from interface: Distribution
      The probability density function for continuous distribution or probability mass function for discrete distribution at x.
      Specified by:
      p in interface Distribution
      Parameters:
      x - a real number.
      Returns:
      the density.

    • logp

      public double logp(double x)
      Description copied from interface: Distribution
      The density at x in log scale, which may prevents the underflow problem.
      Specified by:
      logp in interface Distribution
      Parameters:
      x - a real number.
      Returns:
      the log density.

    • cdf

      public double cdf(double x)
      Description copied from interface: Distribution
      Cumulative distribution function. That is the probability to the left of x.
      Specified by:
      cdf in interface Distribution
      Parameters:
      x - a real number.
      Returns:
      the probability.

    • quantile

      public double quantile(double p)
      Description copied from interface: Distribution
      The quantile, the probability to the left of quantile is p. It is actually the inverse of cdf.
      Specified by:
      quantile in interface Distribution
      Parameters:
      p - the probability.
      Returns:
      the quantile.