annotate scripts/statistics/distributions/unidrnd.m @ 7016:93c65f2a5668

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