annotate scripts/statistics/base/unidrnd.m @ 5503:08448daec293

[project @ 2005-10-20 20:56:59 by jwe]
author jwe
date Thu, 20 Oct 2005 20:56:59 +0000
parents 04fa51cb7e90
children 61d6cebd243b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5475
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2005 John W. Eaton
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
2 ##
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
4 ##
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
9 ##
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
14 ##
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
18 ## 02110-1301, USA.
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
19
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} unidrnd (@var{mx});
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefn {Function File} {} unidrnd (@var{mx}, @var{v});
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefn {Function File} {} unidrnd (@var{mx}, @var{m}, @var{n}, @dots{});
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
24 ## Return random values from discrete uniform distribution, with maximum
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
25 ## value(s) given by the integer @var{mx}, which may be a scalar or
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
26 ## multidimensional array.
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
27 ##
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
28 ## If @var{mx} is a scalar, the size of the result is specified by
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
29 ## the vector @var{v}, or by the optional arguments @var{m}, @var{n},
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
30 ## @dots{}. Otherwise, the size of the result is the same as the size
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
31 ## of @var{mx}.
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
32 ## @end deftypefn
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
33
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
34 ## Author: jwe
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
35
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
36 function retval = unidrnd (n, varargin)
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 1)
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
38 dims = size (n);
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
39 elseif (nargin == 2)
5503
08448daec293 [project @ 2005-10-20 20:56:59 by jwe]
jwe
parents: 5475
diff changeset
40 if (rows (varargin{1}) == 1 && columns (varargin{1}) > 1)
5475
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
41 dims = varargin{1};
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
42 else
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
43 error ("unidrnd: invalid dimension vector");
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
44 endif
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
45 elseif (nargin > 2)
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
46 for i = 1:nargin-1
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
47 if (! isscalar (varargin{i}))
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
48 error ("unidrnd: expecting scalar dimensions");
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
49 endif
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
50 endfor
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
51 dims = [varargin{:}];
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
52 else
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
53 error ("unidrnd (n, ...)");
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
54 endif
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
55 if (isscalar (n)
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
56 || (length (size (n)) == length (dims) && all (size (n) == dims)))
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
57 retval = ceil (rand (dims) .* n);
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
58 else
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
59 error ("unidrnd: dimension mismatch");
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
60 endif
04fa51cb7e90 [project @ 2005-09-28 21:14:47 by jwe]
jwe
parents:
diff changeset
61 endfunction