Mercurial > octave
comparison libinterp/corefcn/rand.cc @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Aug 2013 20:46:38 -0700 |
| parents | 213ee68b59da |
| children | b81b9d079515 |
comparison
equal
deleted
inserted
replaced
| 17280:1a5407bae739 | 17281:bc924baa2c4e |
|---|---|
| 422 The new generator is used by default\n\ | 422 The new generator is used by default\n\ |
| 423 as it is significantly faster than the old generator, and produces\n\ | 423 as it is significantly faster than the old generator, and produces\n\ |
| 424 random numbers with a significantly longer cycle time. However, in\n\ | 424 random numbers with a significantly longer cycle time. However, in\n\ |
| 425 some circumstances it might be desirable to obtain the same random\n\ | 425 some circumstances it might be desirable to obtain the same random\n\ |
| 426 sequences as used by the old generators. To do this the keyword\n\ | 426 sequences as used by the old generators. To do this the keyword\n\ |
| 427 \"seed\" is used to specify that the old generators should be use,\n\ | 427 @qcode{\"seed\"} is used to specify that the old generators should be use,\n\ |
| 428 as in\n\ | 428 as in\n\ |
| 429 \n\ | 429 \n\ |
| 430 @example\n\ | 430 @example\n\ |
| 431 rand (\"seed\", val)\n\ | 431 rand (\"seed\", val)\n\ |
| 432 @end example\n\ | 432 @end example\n\ |
| 440 @end example\n\ | 440 @end example\n\ |
| 441 \n\ | 441 \n\ |
| 442 However, it should be noted that querying the seed will not cause\n\ | 442 However, it should be noted that querying the seed will not cause\n\ |
| 443 @code{rand} to use the old generators, only setting the seed will.\n\ | 443 @code{rand} to use the old generators, only setting the seed will.\n\ |
| 444 To cause @code{rand} to once again use the new generators, the\n\ | 444 To cause @code{rand} to once again use the new generators, the\n\ |
| 445 keyword \"state\" should be used to reset the state of the @code{rand}.\n\ | 445 keyword @qcode{\"state\"} should be used to reset the state of the\n\ |
| 446 @code{rand}.\n\ | |
| 446 \n\ | 447 \n\ |
| 447 The state or seed of the generator can be reset to a new random value\n\ | 448 The state or seed of the generator can be reset to a new random value\n\ |
| 448 using the \"reset\" keyword.\n\ | 449 using the @qcode{\"reset\"} keyword.\n\ |
| 449 \n\ | 450 \n\ |
| 450 The class of the value returned can be controlled by a trailing \"double\"\n\ | 451 The class of the value returned can be controlled by a trailing\n\ |
| 451 or \"single\" argument. These are the only valid classes.\n\ | 452 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
| 453 classes.\n\ | |
| 452 @seealso{randn, rande, randg, randp}\n\ | 454 @seealso{randn, rande, randg, randp}\n\ |
| 453 @end deftypefn") | 455 @end deftypefn") |
| 454 { | 456 { |
| 455 octave_value retval; | 457 octave_value retval; |
| 456 | 458 |
| 566 handled the same as the arguments for @code{rand}.\n\ | 568 handled the same as the arguments for @code{rand}.\n\ |
| 567 \n\ | 569 \n\ |
| 568 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\ | 570 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\ |
| 569 to transform from a uniform to a normal distribution.\n\ | 571 to transform from a uniform to a normal distribution.\n\ |
| 570 \n\ | 572 \n\ |
| 571 The class of the value returned can be controlled by a trailing \"double\"\n\ | 573 The class of the value returned can be controlled by a trailing\n\ |
| 572 or \"single\" argument. These are the only valid classes.\n\ | 574 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
| 575 classes.\n\ | |
| 573 \n\ | 576 \n\ |
| 574 Reference: G. Marsaglia and W.W. Tsang,\n\ | 577 Reference: G. Marsaglia and W.W. Tsang,\n\ |
| 575 @cite{Ziggurat Method for Generating Random Variables},\n\ | 578 @cite{Ziggurat Method for Generating Random Variables},\n\ |
| 576 J. Statistical Software, vol 5, 2000,\n\ | 579 J. Statistical Software, vol 5, 2000,\n\ |
| 577 @url{http://www.jstatsoft.org/v05/i08/})\n\ | 580 @url{http://www.jstatsoft.org/v05/i08/})\n\ |
| 636 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\ |
| 637 \n\ | 640 \n\ |
| 638 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\ | 641 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\ |
| 639 to transform from a uniform to an exponential distribution.\n\ | 642 to transform from a uniform to an exponential distribution.\n\ |
| 640 \n\ | 643 \n\ |
| 641 The class of the value returned can be controlled by a trailing \"double\"\n\ | 644 The class of the value returned can be controlled by a trailing\n\ |
| 642 or \"single\" argument. These are the only valid classes.\n\ | 645 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
| 646 classes.\n\ | |
| 643 \n\ | 647 \n\ |
| 644 Reference: G. Marsaglia and W.W. Tsang,\n\ | 648 Reference: G. Marsaglia and W.W. Tsang,\n\ |
| 645 @cite{Ziggurat Method for Generating Random Variables},\n\ | 649 @cite{Ziggurat Method for Generating Random Variables},\n\ |
| 646 J. Statistical Software, vol 5, 2000,\n\ | 650 J. Statistical Software, vol 5, 2000,\n\ |
| 647 @url{http://www.jstatsoft.org/v05/i08/})\n\ | 651 @url{http://www.jstatsoft.org/v05/i08/})\n\ |
| 782 @end group\n\ | 786 @end group\n\ |
| 783 @end example\n\ | 787 @end example\n\ |
| 784 \n\ | 788 \n\ |
| 785 @end table\n\ | 789 @end table\n\ |
| 786 \n\ | 790 \n\ |
| 787 The class of the value returned can be controlled by a trailing \"double\"\n\ | 791 The class of the value returned can be controlled by a trailing\n\ |
| 788 or \"single\" argument. These are the only valid classes.\n\ | 792 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
| 793 classes.\n\ | |
| 789 @seealso{rand, randn, rande, randp}\n\ | 794 @seealso{rand, randn, rande, randp}\n\ |
| 790 @end deftypefn") | 795 @end deftypefn") |
| 791 { | 796 { |
| 792 octave_value retval; | 797 octave_value retval; |
| 793 | 798 |
| 1004 @item For @var{l} > 1e8, use normal approximation.\n\ | 1009 @item For @var{l} > 1e8, use normal approximation.\n\ |
| 1005 L. Montanet, et al., @cite{Review of Particle Properties}, Physical Review\n\ | 1010 L. Montanet, et al., @cite{Review of Particle Properties}, Physical Review\n\ |
| 1006 D 50 p1284, 1994.\n\ | 1011 D 50 p1284, 1994.\n\ |
| 1007 @end table\n\ | 1012 @end table\n\ |
| 1008 \n\ | 1013 \n\ |
| 1009 The class of the value returned can be controlled by a trailing \"double\"\n\ | 1014 The class of the value returned can be controlled by a trailing\n\ |
| 1010 or \"single\" argument. These are the only valid classes.\n\ | 1015 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\ |
| 1016 classes.\n\ | |
| 1011 @seealso{rand, randn, rande, randg}\n\ | 1017 @seealso{rand, randn, rande, randg}\n\ |
| 1012 @end deftypefn") | 1018 @end deftypefn") |
| 1013 { | 1019 { |
| 1014 octave_value retval; | 1020 octave_value retval; |
| 1015 | 1021 |