annotate scripts/statistics/distributions/gamma_rnd.m @ 4856:c89b9abf2ffd

[project @ 2004-04-08 03:24:12 by jwe]
author jwe
date Thu, 08 Apr 2004 03:24:12 +0000
parents 4b0f3b055331
children 9794d526639c
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) 1995, 1996, 1997 Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
2 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
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: 3457
diff changeset
6 ## under the terms of the GNU General Public License as published by
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
9 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
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: 3191
diff changeset
13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
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
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3457
diff changeset
18 ## 02111-1307, USA.
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} {} gamma_rnd (@var{a}, @var{b}, @var{r}, @var{c})
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
22 ## @deftypefnx {Function File} {} gamma_rnd (@var{a}, @var{b}, @var{sz})
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
23 ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
24 ## random samples from the Gamma distribution with parameters @var{a}
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
25 ## and @var{b}. Both @var{a} and @var{b} must be scalar or of size
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
26 ## @var{r} by @var{c}.
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
27 ##
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
28 ## If @var{r} and @var{c} are omitted, the size of the result matrix is
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
29 ## the common size of @var{a} and @var{b}.
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
30 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
31
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
32 ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at>
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
33 ## Description: Random deviates from the Gamma distribution
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
34
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
35 function rnd = gamma_rnd (a, b, r, c)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
36
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
37 if (nargin > 1)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
38 if (!isscalar(a) || !isscalar(b))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
39 [retval, a, b] = common_size (a, b);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
40 if (retval > 0)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
41 error ("gamma_rnd: a and b must be of common size or scalar");
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
42 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
43 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
44 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
45
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
46 if (nargin == 4)
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
47 if (! (isscalar (r) && (r > 0) && (r == round (r))))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
48 error ("gamma_rnd: r must be a positive integer");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
49 endif
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3922
diff changeset
50 if (! (isscalar (c) && (c > 0) && (c == round (c))))
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
51 error ("gamma_rnd: c must be a positive integer");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
52 endif
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
53 sz = [r, c];
4856
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
54
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
55 if (any (size (a) != 1) && ((length (size (a)) != length (sz)) ||
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
56 any (size (a) != sz)))
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
57 error ("gamma_rnd: a and b must be scalar or of size [r, c]");
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
58 endif
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
59 elseif (nargin == 3)
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
60 if (isscalar (r) && (r > 0))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
61 sz = [r, r];
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
62 elseif (isvector(r) && all (r > 0))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
63 sz = r(:)';
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
64 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
65 error ("uniform_rnd: r must be a postive integer or vector");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
66 endif
4856
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
67
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
68 if (any (size (a) != 1) && ((length (size (a)) != length (sz)) ||
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
69 any (size (a) != sz)))
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
70 error ("gamma_rnd: a and b must be scalar or of size sz");
c89b9abf2ffd [project @ 2004-04-08 03:24:12 by jwe]
jwe
parents: 4854
diff changeset
71 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
72 elseif (nargin == 2)
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
73 sz = size(a);
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
74 else
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
75 usage ("gamma_rnd (a, b, r, c)");
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
76 endif
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
77
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
78 rnd = zeros (sz);
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
79
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
80 if (isscalar (a) && isscalar(b))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
81 if (find (!(a > 0) | !(a < Inf) | !(b > 0) | !(b < Inf)))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
82 rnd = NaN * ones (sz);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
83 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
84 rnd = gamma_inv (rand (sz), a, b);
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
85 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
86 else
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
87 k = find (!(a > 0) | !(a < Inf) | !(b > 0) | !(b < Inf));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
88 if (any (k))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
89 rnd(k) = NaN;
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
90 endif
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
91 k = find ((a > 0) & (a < Inf) & (b > 0) & (b < Inf));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
92 if (any (k))
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
93 rnd(k) = gamma_inv (rand (size (k)), a(k), b(k));
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
94 endif
3191
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe]
jwe
parents:
diff changeset
95 endif
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3191
diff changeset
96
4854
4b0f3b055331 [project @ 2004-04-07 02:37:05 by jwe]
jwe
parents: 4030
diff changeset
97 endfunction