Scythe-1.0.3
double scythe::dnbinom ( unsigned int  x,
double  n,
double  p 
) [inline]

The negative binomial density function.

Computes the value of the negative binomial probability density function with n target number of successful trials and p probability of success on each trial, at the desired quantile x.

It is also possible to call this function with a Matrix of doubles as its first argument. In this case the function will return a Matrix of doubles of the same dimension as x, containing the result of evaluating this function at each value in x, given the remaining fixed parameters. By default, the returned Matrix will be concrete and have the same matrix_order as x, but you may invoke a generalized version of the function with an explicit template call.

Parameters:
xThe desired non-negative, integer, quantile.
nThe positive target number of successful trials (dispersion parameter).
pThe probability of success on each trial.
See also:
dnbinom(unsigned int x, double n, double p)
rng::rnbinom(double n, double p)
Exceptions:
scythe_invalid_arg(Level 1)
scythe_range_error(Level 1)
scythe_precision_error(Level 1)

References SCYTHE_CHECK_10.