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

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents b353c370a315
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1997 Kurt Hornik
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
2 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
4 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
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: 7009
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: 7009
diff changeset
8 ## your option) any later version.
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
9 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
14 ##
56e066f5efc1 [project @ 2005-07-13 17:43:35 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: 7009
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: 7009
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
18
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
7002
12ab7f5fc663 [project @ 2007-10-10 18:27:06 by jwe]
jwe
parents: 6046
diff changeset
20 ## @deftypefn {Function File} {} hygernd (@var{t}, @var{m}, @var{n}, @var{r}, @var{c})
12ab7f5fc663 [project @ 2007-10-10 18:27:06 by jwe]
jwe
parents: 6046
diff changeset
21 ## @deftypefnx {Function File} {} hygernd (@var{t}, @var{m}, @var{n}, @var{sz})
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
22 ## @deftypefnx {Function File} {} hygernd (@var{t}, @var{m}, @var{n})
5691
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5411
diff changeset
23 ## Return an @var{r} by @var{c} matrix of random samples from the
7002
12ab7f5fc663 [project @ 2007-10-10 18:27:06 by jwe]
jwe
parents: 6046
diff changeset
24 ## hypergeometric distribution with parameters @var{t}, @var{m},
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
25 ## and @var{n}.
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
26 ##
7002
12ab7f5fc663 [project @ 2007-10-10 18:27:06 by jwe]
jwe
parents: 6046
diff changeset
27 ## The parameters @var{t}, @var{m}, and @var{n} must positive integers
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
28 ## with @var{m} and @var{n} not greater than @var{t}.
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
29 ##
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
30 ## The parameter @var{sz} must be scalar or a vector of matrix
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
31 ## dimensions. If @var{sz} is scalar, then a @var{sz} by @var{sz}
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
32 ## matrix of random samples is generated.
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
33 ## @end deftypefn
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
34
7002
12ab7f5fc663 [project @ 2007-10-10 18:27:06 by jwe]
jwe
parents: 6046
diff changeset
35 function rnd = hygernd (t, m, n, r, c)
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
36
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 5)
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
38 if (! (isscalar (r) && (r > 0) && (r == round (r))))
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents: 5410
diff changeset
39 error ("hygernd: r must be a positive integer");
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
40 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
41 if (! (isscalar (c) && (c > 0) && (c == round (c))))
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents: 5410
diff changeset
42 error ("hygernd: c must be a positive integer");
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
43 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
44 sz = [r, c];
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
45 elseif (nargin == 4)
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
46 if (isvector (r) && all (r > 0) && all (r == round (r)))
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
47 if (isscalar (r))
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
48 sz = [r, r];
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
49 else
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
50 sz = r(:)';
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
51 endif
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
52 else
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents: 5410
diff changeset
53 error ("hygernd: r must be a vector of positive integers");
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
54 endif
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
55 elseif (nargin != 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5691
diff changeset
56 print_usage ();
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
57 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
58
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
59 if (! isscalar (t) || ! isscalar (m) || ! isscalar (n))
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
60 [retval, t, m, n] = common_size (t, m, n);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
61 if (retval > 0)
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
62 error ("hygernd: t, m and n must be of common size or scalar");
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
63 endif
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
64 if (nargin > 3)
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
65 if (any (sz != size (t)))
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
66 error ("hygernd: t, m and n must have the same size as implied by r and c or must be scalar");
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
67 endif
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
68 else
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
69 sz = size (t);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
70 endif
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
71 elseif (nargin == 3)
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
72 sz = 1;
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
73 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
74
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
75 ## NaN elements
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
76 ne = (! (t >= 0) | ! (m >= 0) | ! (n > 0) | ! (t == round (t)) | ! (m == round (m)) | ! (n == round (n)) | ! (m <= t) | ! (n <= t));
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
77
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
78 if (! isscalar (t))
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
79 rnd = zeros (sz);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
80 rnd(ne) = NaN;
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
81 rn = rand (sz);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
82 for i = find (! ne)
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
83 v = 0 : n(i);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
84 p = hygepdf (v, t(i), m(i), n(i));
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
85 rnd(i) = v(lookup (cumsum (p(1 : end-1)) / sum (p), rn(i)) + 1);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
86 endfor
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
87 else
7009
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
88 if (ne)
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
89 rnd = NaN * ones (sz);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
90 else
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
91 v = 0:n;
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
92 p = hygepdf (v, t, m, n);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
93 rnd = v(lookup (cumsum (p(1:end-1)) / sum (p), rand (sz)) + 1);
b353c370a315 [project @ 2007-10-11 17:27:28 by jwe]
jwe
parents: 7002
diff changeset
94 endif
5410
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
95 endif
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
96
56e066f5efc1 [project @ 2005-07-13 17:43:35 by jwe]
jwe
parents:
diff changeset
97 endfunction