PoissonDistribution Class

Generates Poisson distributed random numbers.

Inheritance Hierarchy

SystemObject
  Altaxo.Calc.ProbabilityDistribution
    Altaxo.Calc.ProbabilityDiscreteDistribution
      Altaxo.Calc.ProbabilityPoissonDistribution

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

Syntax

Copy

public class PoissonDistribution : DiscreteDistribution

The PoissonDistribution type exposes the following members.

Constructors

	Name	Description
	PoissonDistribution	Initializes a new instance of the PoissonDistribution class with mean 1, using a StandardGenerator as the underlying random number generator.
	PoissonDistribution(Double)	Initializes a new instance of the PoissonDistribution class with the specified mean, using a StandardGenerator as the underlying random number generator.
	PoissonDistribution(Generator)	Initializes a new instance of the PoissonDistribution class with mean 1, using the specified Generator as the underlying random number generator.
	PoissonDistribution(Double, Generator)	Initializes a new instance of the PoissonDistribution class with the specified mean, using the specified Generator as the underlying random number generator.

Top

Properties

	Name	Description
	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)
	Maximum	Gets the maximum possible value of distributed random numbers. (Overrides DistributionMaximum)
	Mean	Gets the mean of distributed random numbers. (Overrides DistributionMean)
	Median	Gets the median of distributed random numbers. (Overrides DistributionMedian)
	Minimum	Gets the minimum possible value of distributed random numbers. (Overrides DistributionMinimum)
	Mode	Gets the mode of distributed random numbers. (Overrides DistributionMode)
	Variance	Gets the variance of distributed random numbers. (Overrides DistributionVariance)

Top

Methods

	Name	Description
	CDF(Double)	Returns the cumulative distribution function (CDF) evaluated at x. (Overrides DiscreteDistributionCDF(Double))
	CDF(Double, Double)	Returns the cumulative distribution function (CDF) of a Poisson 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 this instance with the specified mean value.
	IsValidMu	Determines whether the specified mean value is valid.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NextDouble	Returns a distributed floating-point random number. (Overrides DistributionNextDouble)
	PDF(Double)	Returns the probability mass function (PMF) evaluated at x. (Overrides DiscreteDistributionPDF(Double))
	PDF(Double, Double)	Returns the probability mass function (PMF) of a Poisson distribution.
	Quantile	Returns the quantile corresponding to the specified cumulative probability. (Overrides DiscreteDistributionQuantile(Double))
	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
	alm	Stores the distribution parameters and helper values used during random number generation.
	g	Stores the distribution parameters and helper values used during random number generation.
	generator	Stores a Generator object that can be used as the underlying random number generator. (Inherited from Distribution)
	m	Stores the distribution parameters and helper values used during random number generation.
	scale	Stores the distribution parameters and helper values used during random number generation.
	scalepi	Stores the distribution parameters and helper values used during random number generation.
	sq	Stores the distribution parameters and helper values used during random number generation.

Top

Remarks


             Returns a Poisson distributed deviate (integer returned in a double)
             from a distribution of mean m.
             The Poisson distribution gives the probability of a certain integer
             number m of unit rate Poisson random events occurring in a given
             interval of time x.
                                               j  -x
                          j+eps               x  e
                  integral       p (m) dm  = -------
                          j-eps   x            j !
            
             References: The method follows the outlines of:
             W. H. Press, B. P. Flannery, S. A. Teukolsky, W. T. Vetterling,
             Numerical Recipes in C, Cambridge Univ. Press, 1988.

Reference

Altaxo.Calc.Probability Namespace