LogarithmicSeriesDistribution Constructor

Definition

Namespace: Numerics.NET.Statistics.Distributions
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.2

Overload List

LogarithmicSeriesDistribution(Double) Constructs a new LogarithmicSeriesDistribution with the specified probability of success. The distribution uses the default random number generator to generate samples.
LogarithmicSeriesDistribution(Vector<Double>) Estimates the parameter of the distribution of a variable assuming it follows a logarithmic series distribution.

LogarithmicSeriesDistribution(Double)

Constructs a new LogarithmicSeriesDistribution with the specified probability of success. The distribution uses the default random number generator to generate samples.
C#
public LogarithmicSeriesDistribution(
	double probabilityOfSuccess
)

Parameters

probabilityOfSuccess  Double
The probability of a trial resulting in success.

Exceptions

ArgumentOutOfRangeException

probabilityOfSuccess is less than zero or greater than 1.

LogarithmicSeriesDistribution(Vector<Double>)

Estimates the parameter of the distribution of a variable assuming it follows a logarithmic series distribution.
C#
public LogarithmicSeriesDistribution(
	Vector<double> variable
)

Parameters

variable  Vector<Double>
A vector.

Return Value

The LogarithmicSeriesDistribution that best matches the distribution of variable.

Remarks

Use this constructor to create a LogarithmicSeriesDistribution whose parameter is estimated from variable.

Exceptions

ArgumentNullException

variable is null.

ArgumentException

The mean of variable is less than zero. Samples from a logarithmic series distribution cannot be negative.

See Also