annotate scripts/statistics/distributions/discrete_rnd.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 1bf0ce0930be
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1996, 1997, 1998, 2000, 2002, 2004, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
3 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
4 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
5 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
7 ## 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: 7007
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
9 ## your option) any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
10 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
14 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
15 ##
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
16 ## 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: 7007
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
19
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
20 ## -*- texinfo -*-
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
21 ## @deftypefn {Function File} {} discrete_rnd (@var{n}, @var{v}, @var{p})
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
22 ## @deftypefnx {Function File} {} discrete_rnd (@var{v}, @var{p}, @var{r}, @var{c})
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
23 ## @deftypefnx {Function File} {} discrete_rnd (@var{v}, @var{p}, @var{sz})
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
24 ## Generate a row vector containing a random sample of size @var{n} from
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
25 ## the univariate distribution which assumes the values in @var{v} with
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
26 ## probabilities @var{p}. @var{n} must be a scalar.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
27 ##
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
28 ## If @var{r} and @var{c} are given create a matrix with @var{r} rows and
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
29 ## @var{c} columns. Or if @var{sz} is a vector, create a matrix of size
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
30 ## @var{sz}.
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
31 ## @end deftypefn
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
32
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
33 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
34 ## Description: Random deviates from a discrete distribution
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
35
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
36 function rnd = discrete_rnd (v, p, r, c)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
37
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
38 if (nargin == 4)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
39 if (! (isscalar (r) && (r > 0) && (r == round (r))))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
40 error ("discrete_rnd: r must be a positive integer");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
41 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
42 if (! (isscalar (c) && (c > 0) && (c == round (c))))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
43 error ("discrete_rnd: c must be a positive integer");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
44 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
45 sz = [r, c];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
46 elseif (nargin == 3)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
47 ## A potential problem happens here if all args are scalar, as
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
48 ## we can't distiguish between the command syntax. Thankfully this
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
49 ## case doesn't make much sense. So we assume the first syntax
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
50 ## if the first arg is scalar
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
51
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
52 if (isscalar (v))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
53 sz = [1, floor(v)];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
54 v = p;
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
55 p = r;
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
56 else
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
57 if (isscalar (r) && (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
58 sz = [r, r];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
59 elseif (isvector(r) && all (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
60 sz = r(:)';
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
61 else
7007
6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe]
jwe
parents: 6350
diff changeset
62 error ("discrete_rnd: r must be a positive integer or vector");
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
63 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
64 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
65 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
66 print_usage ();
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
67 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
68
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
69 if (! isvector (v))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
70 error ("discrete_rnd: v must be a vector");
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
71 elseif (! isvector (p) || (length (p) != length (v)))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
72 error ("discrete_rnd: p must be a vector with length (v) elements");
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
73 elseif (! (all (p >= 0) && any (p)))
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
74 error ("discrete_rnd: p must be a nonzero, nonnegative vector");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
75 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
76
6350
d285f4ee2b0c [project @ 2007-02-23 14:29:19 by dbateman]
dbateman
parents: 6046
diff changeset
77 rnd = v (lookup (cumsum (p (1 : end-1)) / sum(p), rand (sz)) + 1);
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
78 endfunction