Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.12 KB

negativebinomial.rst

File metadata and controls

37 lines (25 loc) · 1.12 KB
Raw

NegativeBinomial

The function :aimmsNegativeBinomial draws a random value from a negative binomial distribution.

NegativeBinomial(
    ProbabilityOfSuccess,   ! (input) numerical expression
    NumberOfSuccesses       ! (input) integer expression
    )

Arguments

ProbabilityOfSuccess

A scalar numerical expression in the range (0, 1).

NumberOfSuccesses

A integer numerical expression  > 0.

Return Value

The function :aimmsNegativeBinomial returns a random value drawn from a negative binomial distribution with probability ProbabilityOfSuccess and number of successes NumberOfSuccesses.

The :aimmsNegativeBinomial distribution is discussed in full detail in appendices/distributions-statistical-operators-and-histogram-functions/discrete-distributions of the Language Reference.