Mercurial > octave
comparison libinterp/corefcn/rand.cc @ 19040:0850b5212619
doc: Add @nospell macro around proper names in documentation.
* aspell-octave.en.pws: Remove proper names from Octave's custom dictionary.
* doc/interpreter/audio.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/emacs.txi,
doc/interpreter/func.txi, doc/interpreter/geometry.txi,
doc/interpreter/intro.txi, doc/interpreter/linalg.txi,
doc/interpreter/numbers.txi, doc/interpreter/preface.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
libinterp/corefcn/colloc.cc, libinterp/corefcn/ellipj.cc,
libinterp/corefcn/gammainc.cc, libinterp/corefcn/hess.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/sqrtm.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/symrcm.cc, scripts/general/quadgk.m, scripts/general/quadl.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/condest.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/krylov.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/qzhess.m,
scripts/optimization/fminsearch.m, scripts/optimization/glpk.m,
scripts/signal/arch_fit.m, scripts/signal/bartlett.m,
scripts/signal/blackman.m, scripts/signal/diffpara.m,
scripts/signal/durbinlevinson.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/sparse/eigs.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/specfun/ellipke.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/invhilb.m,
scripts/statistics/base/quantile.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m:
Add @nospell macro around proper names in documentation.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 21 Aug 2014 15:57:18 -0700 |
parents | a142f35f3cb6 |
children | 4197fc428c7d |
comparison
equal
deleted
inserted
replaced
19039:f45b60897316 | 19040:0850b5212619 |
---|---|
406 always initializes the state to the same state at startup. To obtain\n\ | 406 always initializes the state to the same state at startup. To obtain\n\ |
407 behavior comparable to @sc{matlab}, initialize with a deterministic state\n\ | 407 behavior comparable to @sc{matlab}, initialize with a deterministic state\n\ |
408 vector in Octave's startup files (@pxref{Startup Files}).\n\ | 408 vector in Octave's startup files (@pxref{Startup Files}).\n\ |
409 \n\ | 409 \n\ |
410 To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\ | 410 To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\ |
411 Twister with a period of @math{2^{19937}-1} (See M. Matsumoto and\n\ | 411 Twister with a period of @math{2^{19937}-1} (See\n\ |
412 T. Nishimura,\n\ | 412 @nospell{M. Matsumoto and T. Nishimura},\n\ |
413 @cite{Mersenne Twister: A 623-dimensionally equidistributed uniform\n\ | 413 @cite{Mersenne Twister: A 623-dimensionally equidistributed uniform\n\ |
414 pseudorandom number generator}, ACM Trans. on\n\ | 414 pseudorandom number generator}, ACM Trans. on\n\ |
415 Modeling and Computer Simulation Vol. 8, No. 1, pp. 3-30, January 1998,\n\ | 415 Modeling and Computer Simulation Vol. 8, No. 1, pp. 3-30, January 1998,\n\ |
416 @url{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html}).\n\ | 416 @url{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html}).\n\ |
417 Do @strong{not} use for cryptography without securely hashing\n\ | 417 Do @strong{not} use for cryptography without securely hashing\n\ |
565 @deftypefnx {Built-in Function} {} randn (@dots{}, \"double\")\n\ | 565 @deftypefnx {Built-in Function} {} randn (@dots{}, \"double\")\n\ |
566 Return a matrix with normally distributed random\n\ | 566 Return a matrix with normally distributed random\n\ |
567 elements having zero mean and variance one. The arguments are\n\ | 567 elements having zero mean and variance one. The arguments are\n\ |
568 handled the same as the arguments for @code{rand}.\n\ | 568 handled the same as the arguments for @code{rand}.\n\ |
569 \n\ | 569 \n\ |
570 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\ | 570 By default, @code{randn} uses the @nospell{Marsaglia and Tsang}\n\ |
571 to transform from a uniform to a normal distribution.\n\ | 571 ``Ziggurat technique'' to transform from a uniform to a normal distribution.\n\ |
572 \n\ | 572 \n\ |
573 The class of the value returned can be controlled by a trailing\n\ | 573 The class of the value returned can be controlled by a trailing\n\ |
574 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ | 574 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
575 classes.\n\ | 575 classes.\n\ |
576 \n\ | 576 \n\ |
577 Reference: G. Marsaglia and W.W. Tsang,\n\ | 577 Reference: @nospell{G. Marsaglia and W.W. Tsang},\n\ |
578 @cite{Ziggurat Method for Generating Random Variables},\n\ | 578 @cite{Ziggurat Method for Generating Random Variables},\n\ |
579 J. Statistical Software, vol 5, 2000,\n\ | 579 J. Statistical Software, vol 5, 2000,\n\ |
580 @url{http://www.jstatsoft.org/v05/i08/}\n\ | 580 @url{http://www.jstatsoft.org/v05/i08/}\n\ |
581 \n\ | 581 \n\ |
582 @seealso{rand, rande, randg, randp}\n\ | 582 @seealso{rand, rande, randg, randp}\n\ |
636 @deftypefnx {Built-in Function} {} rande (@dots{}, \"single\")\n\ | 636 @deftypefnx {Built-in Function} {} rande (@dots{}, \"single\")\n\ |
637 @deftypefnx {Built-in Function} {} rande (@dots{}, \"double\")\n\ | 637 @deftypefnx {Built-in Function} {} rande (@dots{}, \"double\")\n\ |
638 Return a matrix with exponentially distributed random elements. The\n\ | 638 Return a matrix with exponentially distributed random elements. The\n\ |
639 arguments are handled the same as the arguments for @code{rand}.\n\ | 639 arguments are handled the same as the arguments for @code{rand}.\n\ |
640 \n\ | 640 \n\ |
641 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\ | 641 By default, @code{randn} uses the @nospell{Marsaglia and Tsang}\n\ |
642 to transform from a uniform to an exponential distribution.\n\ | 642 ``Ziggurat technique'' to transform from a uniform to a normal distribution.\n\ |
643 \n\ | 643 \n\ |
644 The class of the value returned can be controlled by a trailing\n\ | 644 The class of the value returned can be controlled by a trailing\n\ |
645 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ | 645 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
646 classes.\n\ | 646 classes.\n\ |
647 \n\ | 647 \n\ |
648 Reference: G. Marsaglia and W.W. Tsang,\n\ | 648 Reference: @nospell{G. Marsaglia and W.W. Tsang},\n\ |
649 @cite{Ziggurat Method for Generating Random Variables},\n\ | 649 @cite{Ziggurat Method for Generating Random Variables},\n\ |
650 J. Statistical Software, vol 5, 2000,\n\ | 650 J. Statistical Software, vol 5, 2000,\n\ |
651 @url{http://www.jstatsoft.org/v05/i08/}\n\ | 651 @url{http://www.jstatsoft.org/v05/i08/}\n\ |
652 \n\ | 652 \n\ |
653 @seealso{rand, randn, randg, randp}\n\ | 653 @seealso{rand, randn, randg, randp}\n\ |
1001 @item For scalar @var{l} > 12, use rejection method.[1]\n\ | 1001 @item For scalar @var{l} > 12, use rejection method.[1]\n\ |
1002 W.H. Press, et al., @cite{Numerical Recipes in C},\n\ | 1002 W.H. Press, et al., @cite{Numerical Recipes in C},\n\ |
1003 Cambridge University Press, 1992.\n\ | 1003 Cambridge University Press, 1992.\n\ |
1004 \n\ | 1004 \n\ |
1005 @item For matrix @var{l} @leq{} 10, use inversion method.[2]\n\ | 1005 @item For matrix @var{l} @leq{} 10, use inversion method.[2]\n\ |
1006 E. Stadlober, et al., WinRand source code, available via FTP.\n\ | 1006 @nospell{E. Stadlober, et al., WinRand source code}, available via FTP.\n\ |
1007 \n\ | 1007 \n\ |
1008 @item For matrix @var{l} > 10, use patchwork rejection method.\n\ | 1008 @item For matrix @var{l} > 10, use patchwork rejection method.\n\ |
1009 E. Stadlober, et al., WinRand source code, available via FTP, or\n\ | 1009 @nospell{E. Stadlober, et al., WinRand source code}, available via FTP, or\n\ |
1010 H. Zechner, @cite{Efficient sampling from continuous and discrete\n\ | 1010 @nospell{H. Zechner}, @cite{Efficient sampling from continuous and discrete\n\ |
1011 unimodal distributions}, Doctoral Dissertation, 156pp., Technical\n\ | 1011 unimodal distributions}, Doctoral Dissertation, 156pp., Technical\n\ |
1012 University Graz, Austria, 1994.\n\ | 1012 University @nospell{Graz}, Austria, 1994.\n\ |
1013 \n\ | 1013 \n\ |
1014 @item For @var{l} > 1e8, use normal approximation.\n\ | 1014 @item For @var{l} > 1e8, use normal approximation.\n\ |
1015 L. Montanet, et al., @cite{Review of Particle Properties}, Physical Review\n\ | 1015 @nospell{L. Montanet}, et al., @cite{Review of Particle Properties},\n\ |
1016 D 50 p1284, 1994.\n\ | 1016 Physical Review D 50 p1284, 1994.\n\ |
1017 @end table\n\ | 1017 @end table\n\ |
1018 \n\ | 1018 \n\ |
1019 The class of the value returned can be controlled by a trailing\n\ | 1019 The class of the value returned can be controlled by a trailing\n\ |
1020 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ | 1020 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
1021 classes.\n\ | 1021 classes.\n\ |