randn's help text

Moritz Borgmann octave at moriborg.de
Sun May 18 17:03:00 CDT 2008


I think the attached is even slightly more precise. I find the term 
"unitary" confusing in scalar context, so I replaced it with 
"variance one". I didn't bother to add my name, hope that's OK with 
you, Thomas.

-M

At 22:42 Uhr +0200 2008-05-18, Thomas Weber wrote:
>Hi,
>
>Francesco Potorti` suggested the attached extension of randn's help
>text.
>
>	Thomas
-------------- next part --------------
# HG changeset patch
# User Thomas Weber <thomas.weber.mail at gmail.com>
# Date 1211143228 -7200
# Node ID 8c8c7cd544c8389334c8073aa4a59fd287970706
# Parent  ce52af0e4a10028397e8c8931ae95fa6a2ef76cd
Extend explanation of randn's return value

diff -r ce52af0e4a10 -r 8c8c7cd544c8 src/ChangeLog
--- a/src/ChangeLog	Tue May 13 17:45:35 2008 +0200
+++ b/src/ChangeLog	Sun May 18 22:40:28 2008 +0200
@@ -1,3 +1,7 @@
+2008-05-18  Thomas Weber  <thomas.weber.mail at gmail.com>
+
+	* Extend explanation of randn's return value.
+
  2008-05-07  John W. Eaton  <jwe at octave.org>

  	* pt-arg-list.cc, pt-arg-list.h (tree_argument_list::dup):
diff -r ce52af0e4a10 -r 8c8c7cd544c8 src/DLD-FUNCTIONS/rand.cc
--- a/src/DLD-FUNCTIONS/rand.cc	Tue May 13 17:45:35 2008 +0200
+++ b/src/DLD-FUNCTIONS/rand.cc	Sun May 18 22:40:28 2008 +0200
@@ -471,8 +471,9 @@
  @deftypefnx {Loadable Function} {} randn (@var{n}, @var{m})\n\
  @deftypefnx {Loadable Function} {} randn (\"state\", @var{x})\n\
  @deftypefnx {Loadable Function} {} randn (\"seed\", @var{x})\n\
-Return a matrix with normally distributed random elements. The\n\
-arguments are handled the same as the arguments for @code{rand}.\n\
+Return a matrix with normally distributed pseudo-random\n\
+elements having zero mean and variance one. The arguments are\n\
+handled the same as the arguments for @code{rand}.\n\
  \n\
  By default, @code{randn} uses a Marsaglia and Tsang Ziggurat technique to\n\
  transform from a uniform to a normal distribution. (G. Marsaglia and\n\


More information about the Octave-maintainers mailing list