/* * Documentation for those functions where inline documentation is * not appropriate, for example because the source code was imported * from elsewhere. */ #include /* ------------------------------------------------------------------------- */ /** * log1pmx: * @x: a number * * Returns: log(1+@x)-@x with less rounding error than the naive formula, * especially for small values of @x. */ /* ------------------------------------------------------------------------- */ /** * pnorm: * @x: observation * @mu: mean of the distribution * @sigma: standard deviation of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the normal distribution. */ /** * qnorm: * @p: probability * @mu: mean of the distribution * @sigma: standard deviation of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * normal distribution. */ /* ------------------------------------------------------------------------- */ /** * dgamma: * @x: observation * @shape: the shape parameter of the distribution * @scale: the scale parameter of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the gamma distribution. */ /** * pgamma: * @x: observation * @shape: the shape parameter of the distribution * @scale: the scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the gamma distribution. */ /** * qgamma: * @p: probability * @shape: the shape parameter of the distribution * @scale: the scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * gamma distribution. */ /* ------------------------------------------------------------------------- */ /** * dbeta: * @x: observation * @a: the first shape parameter of the distribution * @b: the second scale parameter of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the beta distribution. */ /** * pbeta: * @x: observation * @a: the first shape parameter of the distribution * @b: the second scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the beta distribution. */ /** * qbeta: * @p: probability * @a: the first shape parameter of the distribution * @b: the second scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * beta distribution. */ /* ------------------------------------------------------------------------- */ /** * dt: * @x: observation * @n: the number of degrees of freedom of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the Student t distribution. */ /** * pt: * @x: observation * @n: the number of degrees of freedom of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the Student t distribution. */ /** * qt: * @p: probability * @n: the number of degrees of freedom of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * Student t distribution. */ /* ------------------------------------------------------------------------- */ /** * df: * @x: observation * @n1: the first number of degrees of freedom of the distribution * @n2: the first number of degrees of freedom of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the F distribution. */ /** * pf: * @x: observation * @n1: the first number of degrees of freedom of the distribution * @n2: the first number of degrees of freedom of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the F distribution. */ /** * qf: * @p: probability * @n1: the first number of degrees of freedom of the distribution * @n2: the first number of degrees of freedom of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * F distribution. */ /* ------------------------------------------------------------------------- */ /** * dgeom: * @x: observation * @psuc: the probability of success in each trial * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the geometric distribution. */ /** * pgeom: * @x: observation * @psuc: the probability of success in each trial * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the geometric distribution. */ /** * qgeom: * @p: probability * @psuc: the probability of success in each trial * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * geometric distribution. */ /* ------------------------------------------------------------------------- */ /** * dchisq: * @x: observation * @df: the number of degrees of freedom of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the 𝜒² distribution. */ /** * pchisq: * @x: observation * @df: the number of degrees of freedom of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the 𝜒² distribution. */ /** * qchisq: * @p: probability * @df: the number of degrees of freedom of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * 𝜒² distribution. */ /* ------------------------------------------------------------------------- */ /** * dweibull: * @x: observation * @shape: the shape parameter of the distribution * @scale: the scale parameter of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the Weibull distribution. */ /** * pweibull: * @x: observation * @shape: the shape parameter of the distribution * @scale: the scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the Weibull distribution. */ /** * qweibull: * @p: probability * @shape: the shape parameter of the distribution * @scale: the scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * Weibull distribution. */ /* ------------------------------------------------------------------------- */ /** * dpois: * @x: observation * @lambda: the mean of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the Poisson distribution. */ /** * ppois: * @x: observation * @lambda: the mean of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the Poisson distribution. */ /** * qpois: * @p: probability * @lambda: the mean of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * Poisson distribution. */ /* ------------------------------------------------------------------------- */ /** * dexp: * @x: observation * @scale: the scale parameter of the distribution * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the exponential distribution. */ /** * pexp: * @x: observation * @scale: the scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the exponential distribution. */ /** * qexp: * @p: probability * @scale: the scale parameter of the distribution * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * exponential distribution. */ /* ------------------------------------------------------------------------- */ /** * dbinom: * @x: observation * @n: the number of trials * @psuc: the probability of success in each trial * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the binomial distribution. */ /** * pbinom: * @x: observation * @n: the number of trials * @psuc: the probability of success in each trial * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the binomial distribution. */ /** * qbinom: * @p: probability * @n: the number of trials * @psuc: the probability of success in each trial * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * binomial distribution. */ /* ------------------------------------------------------------------------- */ /** * dnbinom: * @x: observation * @n: the number of trials * @psuc: the probability of success in each trial * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the negative binomial distribution. */ /** * pnbinom: * @x: observation * @n: the number of trials * @psuc: the probability of success in each trial * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the negative binomial distribution. */ /** * qnbinom: * @p: probability * @n: the number of trials * @psuc: the probability of success in each trial * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * negative binomial distribution. */ /* ------------------------------------------------------------------------- */ /** * dhyper: * @x: observation * @r: the number of red balls * @b: the number of black balls * @n: the number of balls drawn * @give_log: if %TRUE, log of the result will be returned instead * * Returns: density of the hypergeometric distribution. */ /** * phyper: * @x: observation * @r: the number of red balls * @b: the number of black balls * @n: the number of balls drawn * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, log of the result will be returned instead * * Returns: cumulative density of the hypergeometric distribution. */ /** * qhyper: * @p: probability * @r: the number of red balls * @b: the number of black balls * @n: the number of balls drawn * @lower_tail: if %TRUE, the lower tail of the distribution is considered. * @log_p: if %TRUE, @p is given as log probability * * Returns: the observation with cumulative probability @p for the * hypergeometric distribution. */ /* ------------------------------------------------------------------------- */