Mercurial > hg > octave-nkf

diff scripts/statistics/distributions/geoinv.m @ 17401:6643f21e27f3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Document the form of the geometric distribution being used (II) in geo* functions. * scripts/statistics/distributions/geocdf.m, scripts/statistics/distributions/geoinv.m, scripts/statistics/distributions/geopdf.m, scripts/statistics/distributions/geornd.m: Document the form of the geometric distribution being used (II) in geo* functions.
author Rik <rik@octave.org>
date Tue, 10 Sep 2013 07:28:20 -0700
parents f3d52523cde1
children d63878346099
line wrap: on
line diff
--- a/scripts/statistics/distributions/geoinv.m
+++ b/scripts/statistics/distributions/geoinv.m
@@ -21,6 +21,9 @@
 ## @deftypefn {Function File} {} geoinv (@var{x}, @var{p})
 ## For each element of @var{x}, compute the quantile (the inverse of
 ## the CDF) at @var{x} of the geometric distribution with parameter @var{p}.
+##
+## The geometric distribution models the number of failures (@var{x}-1) of a
+## Bernoulli trial with probability @var{p} before the first success (@var{x}).
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>