Mercurial > hg > octave-nkf

changeset 18512:8858d0ccfc93 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Document that default mu is 0 for logn* statistical functions (bug #41547). * logncdf.m, logninv.m, lognpdf.m: Document that default mu is 0 (bug #41547).
author Rik <rik@octave.org>
date Tue, 11 Feb 2014 14:31:25 -0800
parents 4bfd44c15145
children ff7e7928f160
files scripts/statistics/distributions/logncdf.m scripts/statistics/distributions/logninv.m scripts/statistics/distributions/lognpdf.m
diffstat 3 files changed, 14 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/statistics/distributions/logncdf.m
+++ b/scripts/statistics/distributions/logncdf.m
@@ -20,13 +20,13 @@
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {} logncdf (@var{x})
 ## @deftypefnx {Function File} {} logncdf (@var{x}, @var{mu}, @var{sigma})
-## For each element of @var{x}, compute the cumulative distribution
-## function (CDF) at @var{x} of the lognormal distribution with
-## parameters @var{mu} and @var{sigma}.  If a random variable follows this
-## distribution, its logarithm is normally distributed with mean
-## @var{mu} and standard deviation @var{sigma}.
+## For each element of @var{x}, compute the cumulative distribution function
+## (CDF) at @var{x} of the lognormal distribution with parameters
+## @var{mu} and @var{sigma}.  If a random variable follows this distribution,
+## its logarithm is normally distributed with mean @var{mu} and standard
+## deviation @var{sigma}.
 ##
-## Default values are @var{mu} = 1, @var{sigma} = 1.
+## Default values are @var{mu} = 0, @var{sigma} = 1.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/logninv.m
+++ b/scripts/statistics/distributions/logninv.m
@@ -21,12 +21,12 @@
 ## @deftypefn  {Function File} {} logninv (@var{x})
 ## @deftypefnx {Function File} {} logninv (@var{x}, @var{mu}, @var{sigma})
 ## For each element of @var{x}, compute the quantile (the inverse of the
-## CDF) at @var{x} of the lognormal distribution with parameters @var{mu}
-## and @var{sigma}.  If a random variable follows this distribution, its
-## logarithm is normally distributed with mean @code{log (@var{mu})} and
-## variance @var{sigma}.
+## CDF) at @var{x} of the lognormal distribution with parameters
+## @var{mu} and @var{sigma}.  If a random variable follows this distribution,
+## its logarithm is normally distributed with mean @var{mu} and standard
+## deviation @var{sigma}.
 ##
-## Default values are @var{mu} = 1, @var{sigma} = 1.
+## Default values are @var{mu} = 0, @var{sigma} = 1.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/lognpdf.m
+++ b/scripts/statistics/distributions/lognpdf.m
@@ -23,10 +23,10 @@
 ## For each element of @var{x}, compute the probability density function
 ## (PDF) at @var{x} of the lognormal distribution with parameters
 ## @var{mu} and @var{sigma}.  If a random variable follows this distribution,
-## its logarithm is normally distributed with mean @var{mu}
-## and standard deviation @var{sigma}.
+## its logarithm is normally distributed with mean @var{mu} and standard
+## deviation @var{sigma}.
 ##
-## Default values are @var{mu} = 1, @var{sigma} = 1.
+## Default values are @var{mu} = 0, @var{sigma} = 1.
 ## @end deftypefn
 
 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>