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

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 6304d9ea0a30
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1996, 1997 Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
2 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
5 ## 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
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: 7007
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: 7007
diff changeset
8 ## your option) any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
9 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
12 ## 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
13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
14 ##
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
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: 7007
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: 7007
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
18
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
19 ## -*- texinfo -*-
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
20 ## @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
21 ## @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
22 ## @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
23 ## 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
24 ## 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
25 ## probabilities @var{p}. @var{n} must be a scalar.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
26 ##
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
27 ## 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
28 ## @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
29 ## @var{sz}.
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
30 ## @end deftypefn
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
31
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
32 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
33 ## Description: Random deviates from a discrete distribution
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
34
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
35 function rnd = discrete_rnd (v, p, r, c)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
36
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
37 if (nargin == 4)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
38 if (! (isscalar (r) && (r > 0) && (r == round (r))))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
39 error ("discrete_rnd: r must be a positive integer");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
40 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
41 if (! (isscalar (c) && (c > 0) && (c == round (c))))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
42 error ("discrete_rnd: c must be a positive integer");
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
43 endif
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
44 sz = [r, c];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
45 elseif (nargin == 3)
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
46 ## 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
47 ## 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
48 ## 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
49 ## if the first arg is scalar
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3418
diff changeset
50
4859
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
51 if (isscalar (v))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
52 sz = [1, floor(v)];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
53 v = p;
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
54 p = r;
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
55 else
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
56 if (isscalar (r) && (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
57 sz = [r, r];
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
58 elseif (isvector(r) && all (r > 0))
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
59 sz = r(:)';
265d566cc770 [project @ 2004-04-08 23:52:45 by jwe]
jwe
parents: 4030
diff changeset
60 else
7007
6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe]
jwe
parents: 6350
diff changeset
61 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
62 endif
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 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
65 print_usage ();
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
66 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
67
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
68 if (! isvector (v))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
69 error ("discrete_rnd: v must be a vector");
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
70 elseif (! isvector (p) || (length (p) != length (v)))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
71 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
72 elseif (! (all (p >= 0) && any (p)))
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
73 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
74 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
75
6350
d285f4ee2b0c [project @ 2007-02-23 14:29:19 by dbateman]
dbateman
parents: 6046
diff changeset
76 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
77 endfunction