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

annotate scripts/general/randi.m @ 16108:3cce6b4e0f7c

Update gnuplot plotting scripts for faster or more modern synta * scripts/plot/__gnuplot_drawnow__.m: Use default values in function header. Check number of arguments to function immediately. Use single quotes to avoid lots of backslashing. Use strtok() to replace hand-coded functionality. Initialize persistent variables in declaration (10% faster). * scripts/plot/gnuplot_binary.in: Replace tabs with spaces. Simplify input validation. Add %!test block. * scripts/plot/private/__gnuplot_get_var__.m: Use default values in function header. Use "*char" in fread to automatically convert to char variable. * scripts/plot/private/__gnuplot_ginput__.m: Check immediately for required version of gnuplot. Use "*char" in fread to automatically convert to char variable. Use fputs in place of fprintf to match rest of code. * scripts/plot/private/__gnuplot_has_feature__.m: Initialize persistent varibles in declaration. Use false () rather than logical (zeros()) construction. * scripts/plot/private/__gnuplot_has_terminal__.m: Use strtok() to replace hand-coded functionality * scripts/plot/private/__gnuplot_print__.m: Replace sprintf calls with direct string char matrix concatenation (2.4x faster) where possible. Replace for loop with multiple argument form of set(). Use single quotes to avoid lots of backslashing. * scripts/plot/private/__gnuplot_version__.m: Use single quotes to avoid lots of backslashing.

author	Rik <rik@octave.org>
date	Mon, 25 Feb 2013 21:01:36 -0800
parents	460a3c6d8bf1
children	bc924baa2c4e

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 ##
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	37 ## The optional argument "@var{class}" will return a matrix of the requested
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	38 ## type. The default is "double".
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
20ce631f0f12 Add new randi function for random integers. Rik <octave@nomad.inbox5.com> parents: diff changeset	47 ## uses class "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 > hg > octave-nkf

annotate scripts/general/randi.m @ 16108:3cce6b4e0f7c