Package nl.tudelft.simulation.jstats.distributions

Class DistPearson6

java.lang.Object
nl.tudelft.simulation.jstats.distributions.Dist
nl.tudelft.simulation.jstats.distributions.DistContinuous
nl.tudelft.simulation.jstats.distributions.DistPearson6
All Implemented Interfaces:
Serializable
public class DistPearson6 extends DistContinuous
The Pearson6 distribution. For more information on this distribution see https://mathworld.wolfram.com/Pearson6Distribution.html

Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:
Peter Jacobs , Alexander Verbraeck
See Also:

  • Field Summary

    Fields inherited from class nl.tudelft.simulation.jstats.distributions.Dist

    stream

  • Constructor Summary

    Constructors
    Constructor
    Description
    DistPearson6(StreamInterface stream, double alpha1, double alpha2, double beta)
    constructs a new Pearson6 distribution.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    draw()
    draws the next stream value according to the probability of this this distribution.
    double
    getAlpha1()
    Return the first shape parameter α1.
    double
    getAlpha2()
    Return the second shape parameter α2.
    double
    getBeta()
    Return the scale parameter β.
    double
    getProbabilityDensity(double x)
    returns the probability density value of a value x.
    void
    setStream(StreamInterface stream)
    Replace the random number stream.
    String
    toString()

    Methods inherited from class nl.tudelft.simulation.jstats.distributions.Dist

    getStream

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DistPearson6

      public DistPearson6(StreamInterface stream, double alpha1, double alpha2, double beta)
      constructs a new Pearson6 distribution.
      Parameters:
      stream - StreamInterface; the random number stream
      alpha1 - double; the first shape parameter
      alpha2 - double; the second shape parameter
      beta - double; the scale parameter
      Throws:
      IllegalArgumentException - when alpha1 <= 0 or alpha2 <= 0 or beta <= 0

  • Method Details

    • draw

      public double draw()
      draws the next stream value according to the probability of this this distribution.
      Specified by:
      draw in class DistContinuous
      Returns:
      the next double value drawn.

    • getProbabilityDensity

      public double getProbabilityDensity(double x)
      returns the probability density value of a value x.
      Specified by:
      getProbabilityDensity in class DistContinuous
      Parameters:
      x - double; the value for which the density function needs to be calculated
      Returns:
      double; the probability density for value x

    • getAlpha1

      public double getAlpha1()
      Return the first shape parameter α1.
      Returns:
      double; the first shape parameter α1

    • getAlpha2

      public double getAlpha2()
      Return the second shape parameter α2.
      Returns:
      double; the second shape parameter α2

    • getBeta

      public double getBeta()
      Return the scale parameter β.
      Returns:
      double; the scale parameter β

    • setStream

      public void setStream(StreamInterface stream)
      Replace the random number stream.
      Overrides:
      setStream in class Dist
      Parameters:
      stream - StreamInterface; the new random number stream

    • toString

      public String toString()
      Overrides:
      toString in class Object