changeset 13949:0c15fece33ad

doc: Clarify binomial and gamma distribution paramters * binocdf.m, binoinv.m, binopdf.m, binornd.m: Clarify that n is the number of trials and p is the probability of success. * gamcdf.m, gaminv.m, gaminv.m, gampdf.m, gamrnd.m: Clarify that a is the shape parameter and b is the scale parameter.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Sun, 27 Nov 2011 09:01:37 -0500
parents a3676380e841
children c72ad9f5fa2e 79aa00a94e9e
files scripts/statistics/distributions/binocdf.m scripts/statistics/distributions/binoinv.m scripts/statistics/distributions/binopdf.m scripts/statistics/distributions/binornd.m scripts/statistics/distributions/gamcdf.m scripts/statistics/distributions/gaminv.m scripts/statistics/distributions/gampdf.m scripts/statistics/distributions/gamrnd.m
diffstat 8 files changed, 15 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/statistics/distributions/binocdf.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/binocdf.m	Sun Nov 27 09:01:37 2011 -0500
@@ -21,7 +21,8 @@
 ## @deftypefn {Function File} {} binocdf (@var{x}, @var{n}, @var{p})
 ## For each element of @var{x}, compute the cumulative distribution function
 ## (CDF) at @var{x} of the binomial distribution with parameters @var{n} and
-## @var{p}.
+## @var{p}, where @var{n} is the number of trials and @var{p} is the
+## probability of success.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/binoinv.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/binoinv.m	Sun Nov 27 09:01:37 2011 -0500
@@ -21,7 +21,8 @@
 ## @deftypefn {Function File} {} binoinv (@var{x}, @var{n}, @var{p})
 ## For each element of @var{x}, compute the quantile (the inverse of
 ## the CDF) at @var{x} of the binomial distribution with parameters 
-## @var{n} and @var{p}.
+## @var{n} and @var{p}, where @var{n} is the number of trials and
+## @var{p} is the probability of success.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/binopdf.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/binopdf.m	Sun Nov 27 09:01:37 2011 -0500
@@ -21,7 +21,8 @@
 ## @deftypefn {Function File} {} binopdf (@var{x}, @var{n}, @var{p})
 ## For each element of @var{x}, compute the probability density function
 ## (PDF) at @var{x} of the binomial distribution with parameters @var{n}
-## and @var{p}.
+## and @var{p}, where @var{n} is the number of trials and @var{p} is the
+## probability of success.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/binornd.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/binornd.m	Sun Nov 27 09:01:37 2011 -0500
@@ -23,7 +23,8 @@
 ## @deftypefnx {Function File} {} binornd (@var{n}, @var{p}, @var{r}, @var{c}, @dots{})
 ## @deftypefnx {Function File} {} binornd (@var{n}, @var{p}, [@var{sz}])
 ## Return a matrix of random samples from the binomial distribution with
-## parameters @var{n} and @var{p}.
+## parameters @var{n} and @var{p}, where @var{n} is the number of trials
+## and @var{p} is the probability of success.
 ##
 ## When called with a single size argument, return a square matrix with
 ## the dimension specified.  When called with more than one scalar argument the
--- a/scripts/statistics/distributions/gamcdf.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/gamcdf.m	Sun Nov 27 09:01:37 2011 -0500
@@ -20,8 +20,8 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} gamcdf (@var{x}, @var{a}, @var{b})
 ## For each element of @var{x}, compute the cumulative distribution
-## function (CDF) at @var{x} of the Gamma distribution with parameters
-## @var{a} and @var{b}.
+## function (CDF) at @var{x} of the Gamma distribution with shape
+## parameter @var{a} and scale @var{b}.
 ## @end deftypefn
 
 ## Author: TT <Teresa.Twaroch@ci.tuwien.ac.at>
--- a/scripts/statistics/distributions/gaminv.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/gaminv.m	Sun Nov 27 09:01:37 2011 -0500
@@ -20,8 +20,8 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} gaminv (@var{x}, @var{a}, @var{b})
 ## For each element of @var{x}, compute the quantile (the inverse of
-## the CDF) at @var{x} of the Gamma distribution with parameters @var{a}
-## and @var{b}.
+## the CDF) at @var{x} of the Gamma distribution with shape parameter
+## @var{a} and scale @var{b}.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/gampdf.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/gampdf.m	Sun Nov 27 09:01:37 2011 -0500
@@ -20,8 +20,8 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} gampdf (@var{x}, @var{a}, @var{b})
 ## For each element of @var{x}, return the probability density function
-## (PDF) at @var{x} of the Gamma distribution with parameters @var{a}
-## and @var{b}.
+## (PDF) at @var{x} of the Gamma distribution with shape parameter
+## @var{a} and scale @var{b}.
 ## @end deftypefn
 
 ## Author: TT <Teresa.Twaroch@ci.tuwien.ac.at>
--- a/scripts/statistics/distributions/gamrnd.m	Sun Nov 27 08:15:48 2011 -0500
+++ b/scripts/statistics/distributions/gamrnd.m	Sun Nov 27 09:01:37 2011 -0500
@@ -23,7 +23,7 @@
 ## @deftypefnx {Function File} {} gamrnd (@var{a}, @var{b}, @var{r}, @var{c}, @dots{})
 ## @deftypefnx {Function File} {} gamrnd (@var{a}, @var{b}, [@var{sz}])
 ## Return a matrix of random samples from the Gamma distribution with
-## parameters @var{a} and @var{b}.
+## shape parameter @var{a} and scale @var{b}.
 ##
 ## When called with a single size argument, return a square matrix with
 ## the dimension specified.  When called with more than one scalar argument the