ErlangDistribution Class

Generates Erlang distributed random numbers.

Inheritance Hierarchy

SystemObject
  Altaxo.Calc.ProbabilityDistribution
    Altaxo.Calc.ProbabilityContinuousDistribution
      Altaxo.Calc.ProbabilityErlangDistribution

Namespace: Altaxo.Calc.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)

Syntax

Copy

public class ErlangDistribution : ContinuousDistribution

The ErlangDistribution type exposes the following members.

Constructors

	Name	Description
	ErlangDistribution	Initializes a new instance of the ErlangDistribution class, using a StandardGenerator as underlying random number generator.
	ErlangDistribution(Generator)	Initializes a new instance of the ErlangDistribution class, using the specified Generator as underlying random number generator.
	ErlangDistribution(Int32, Double)	Initializes a new instance of the ErlangDistribution class with the given parameters.
	ErlangDistribution(Int32, Double, Generator)	Initializes a new instance of the ErlangDistribution class with the given parameters and generator.

Top

Properties

	Name	Description
	Alpha	Gets or sets the parameter alpha which is used for generation of erlang distributed random numbers.
	CanReset	Gets a value indicating whether the random number distribution can be reset so that it produces the same random number sequence again. (Inherited from Distribution)
	Generator	Gets or sets a Generator object that can be used as the underlying random number generator. (Inherited from Distribution)
	Lambda	Gets or sets the parameter lambda which is used for generation of erlang distributed random numbers.
	Location	Gets the location/scale value used internally for the distribution.
	Maximum	Gets the maximum possible value of erlang distributed random numbers. (Overrides DistributionMaximum)
	Mean	Gets the mean value of erlang distributed random numbers. (Overrides DistributionMean)
	Median	Gets the median of erlang distributed random numbers. (Overrides DistributionMedian)
	Minimum	Gets the minimum possible value of erlang distributed random numbers. (Overrides DistributionMinimum)
	Mode	Gets the mode of erlang distributed random numbers. (Overrides DistributionMode)
	Order	Gets the order (shape) parameter of the Erlang distribution.
	Variance	Gets the variance of erlang distributed random numbers. (Overrides DistributionVariance)

Top

Methods

	Name	Description
	CDF(Double)	Calculates the cumulative distribution function. (Overrides ContinuousDistributionCDF(Double))
	CDF(Double, Double, Double)	Returns the cumulative distribution function (CDF) for the Erlang distribution.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initializes the distribution with the specified order and rate parameter.
	IsValidAlpha	Determines whether the specified value is valid for parameter Alpha.
	IsValidLambda	Determines whether the specified value is valid for parameter Lambda.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NextDouble	Returns a distributed floating-point random number. (Overrides DistributionNextDouble)
	PDF(Double)	Calculates the probability density function. (Overrides ContinuousDistributionPDF(Double))
	PDF(Double, Double, Double)	Returns the probability density function (PDF) for the Erlang distribution.
	Quantile(Double)	Calculates the quantile of the distribution function. (Overrides ContinuousDistributionQuantile(Double))
	Quantile(Double, Double, Double)	Returns the quantile function (inverse CDF) for the Erlang distribution.
	Reset	Resets the random number distribution so that it produces the same random number sequence again. (Inherited from Distribution)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

	Name	Description
	A
	a1
	B
	generator	Stores a Generator object that can be used as the underlying random number generator. (Inherited from Distribution)
	lambda
	scale
	scale2
	sq

Top

Remarks

Copy

Return Erlang distributed random deviates according to:

                     a-1  -bx
               b (bx)    e
 p   (x) dx = ---------------- dx   for x > 0
  a,b             Gamma(a)

            =  0                    otherwise

The Erlang distribution is a special case of the Gamma distribution
with integer valued order a.

References:
see references in:
W. H. Press, B. P. Flannery, S. A. Teukolsky, W. T. Vetterling,
Numerical Recipies in C, Cambridge Univ. Press, 1988.

Reference

Altaxo.Calc.Probability Namespace