octave-nkf: scripts/general/randi.m annotate

annotate scripts/general/randi.m @ 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	460a3c6d8bf1
children	1c89599167a6

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	1 ## Copyright (C) 2010-2012 Rik Wehbring
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	2 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	3 ## This file is part of Octave.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	4 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	8 ## your option) any later version.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	9 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	13 ## General Public License for more details.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	14 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	18
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	19 ## -- texinfo --
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	20 ## @deftypefn {Function File} {} randi (@var{imax})
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	21 ## @deftypefnx {Function File} {} randi (@var{imax}, @var{n})
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	22 ## @deftypefnx {Function File} {} randi (@var{imax}, @var{m}, @var{n}, @dots{})
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	23 ## @deftypefnx {Function File} {} randi ([@var{imin} @var{imax}], @dots{})
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	24 ## @deftypefnx {Function File} {} randi (@dots{}, "@var{class}")
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	25 ## Return random integers in the range 1:@var{imax}.
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	26 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	27 ## Additional arguments determine the shape of the return matrix. When no
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	28 ## arguments are specified a single random integer is returned. If one
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	29 ## argument @var{n} is specified then a square matrix @w{(@var{n} x @var{n})} is
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	30 ## returned. Two or more arguments will return a multi-dimensional
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	31 ## matrix @w{(@var{m} x @var{n} x @dots{})}.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	32 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	33 ## The integer range may optionally be described by a two element matrix
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	34 ## with a lower and upper bound in which case the returned integers will be
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	35 ## on the interval @w{[@var{imin}, @var{imax}]}.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	36 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14846 diff changeset	37 ## The optional argument @var{class} will return a matrix of the requested
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14846 diff changeset	38 ## type. The default is @qcode{"double"}.
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	39 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	40 ## The following example returns 150 integers in the range 1-10.
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	41 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	42 ## @example
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	43 ## ri = randi (10, 150, 1)
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	44 ## @end example
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	45 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	46 ## Implementation Note: @code{randi} relies internally on @code{rand} which
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14846 diff changeset	47 ## uses class @qcode{"double"} to represent numbers. This limits the maximum
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	48 ## integer (@var{imax}) and range (@var{imax} - @var{imin}) to the value
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	49 ## returned by the @code{bitmax} function. For IEEE floating point numbers
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	50 ## this value is @w{@math{2^{53} - 1}}.
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	51 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	52 ## @seealso{rand}
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	53 ## @end deftypefn
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	54
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	55 ## Author: Rik Wehbring
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	56
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	57 function ri = randi (bounds, varargin)
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	58
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	59 if (nargin < 1)
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	60 print_usage ();
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	61 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	62
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	63 if (! (isnumeric (bounds) && isreal (bounds)))
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	64 error ("randi: IMIN and IMAX must be real numeric bounds");
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	65 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	66
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	67 if (isscalar (bounds))
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	68 imin = 1;
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	69 imax = fix (bounds);
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	70 if (imax < 1)
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	71 error ("randi: require IMAX >= 1");
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	72 endif
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	73 else
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	74 imin = fix (bounds(1));
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	75 imax = fix (bounds(2));
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	76 if (imax < imin)
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	77 error ("randi: require IMIN <= IMAX");
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78 endif
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	79 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	80
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	81 if (nargin > 1 && ischar (varargin{end}))
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	82 rclass = varargin{end};
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	83 varargin(end) = [];
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	84 else
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	85 rclass = "double";
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	86 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	87
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	88 if (strfind (rclass, "int"))
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	89 if (imax > intmax (rclass))
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	90 error ("randi: require IMAX < intmax (CLASS)");
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	91 endif
10898 4a2dabfb078b randi.m: Check IMAX for class "single" numbers Rik <octave@nomad.inbox5.com> parents: 10892 diff changeset	92 elseif (strcmp (rclass, "single"))
4a2dabfb078b randi.m: Check IMAX for class "single" numbers Rik <octave@nomad.inbox5.com> parents: 10892 diff changeset	93 if (imax > bitmax (rclass))
4a2dabfb078b randi.m: Check IMAX for class "single" numbers Rik <octave@nomad.inbox5.com> parents: 10892 diff changeset	94 error ("randi: require IMAX < bitmax (CLASS)");
4a2dabfb078b randi.m: Check IMAX for class "single" numbers Rik <octave@nomad.inbox5.com> parents: 10892 diff changeset	95 endif
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	96 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	97 ## Limit set by use of class double in rand()
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	98 if (imax > bitmax)
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	99 error ("randi: maximum integer IMAX must be smaller than bitmax ()");
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	100 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	101 if ((imax - imin) > bitmax)
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	102 error ("randi: maximum integer range must be smaller than bitmax ()");
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	103 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	104
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	105
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	106 ri = imin + floor ( (imax-imin+1)*rand (varargin{:}) );
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	107
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	108 if (! strcmp (rclass, "double"))
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	109 ri = cast (ri, rclass);
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	110 endif
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	111
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	112 endfunction
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	113
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	114 %!test
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	115 %! ri = randi (10, 1000, 1);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	116 %! assert (ri, fix (ri));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	117 %! assert (min (ri), 1);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	118 %! assert (max (ri), 10);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	119 %! assert (rows (ri), 1000);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	120 %! assert (columns (ri), 1);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	121 %! assert (class (ri), "double");
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	122 %!test
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	123 %! ri = randi ([-5, 10], 1000, 1, "int8");
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	124 %! assert (ri, fix (ri));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	125 %! assert (min (ri), int8 (-5));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	126 %! assert (max (ri), int8 (10));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	127 %! assert (class (ri), "int8");
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	128 %!
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	129 %!assert (size (randi (10, 3,1,2)), [3, 1, 2])
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	130
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	131 %% Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	132 %!error (randi ())
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	133 %!error (randi ("test"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	134 %!error (randi (10+2i))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	135 %!error (randi (0))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	136 %!error (randi ([10, 1]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	137 %!error (randi (256, "uint8"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	138 %!error (randi (2^25, "single"))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	139 %!error (randi (bitmax () + 1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	140 %!error (randi ([-1, bitmax()]))
10892 20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	141

Mercurial > octave-nkf

annotate scripts/general/randi.m @ 17281:bc924baa2c4e