annotate scripts/specfun/gammai.m @ 1887:5d29638dd524

[project @ 1996-02-06 15:41:33 by jwe]
author jwe
date Tue, 06 Feb 1996 15:49:10 +0000
parents 54350c98055c
children 5cffc4b8de57
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1887
5d29638dd524 [project @ 1996-02-06 15:41:33 by jwe]
jwe
parents: 1586
diff changeset
1 # Copyright (C) 1996 John W. Eaton
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
2 #
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
3 # This file is part of Octave.
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
4 #
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
5 # Octave is free software; you can redistribute it and/or modify it
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
6 # under the terms of the GNU General Public License as published by the
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
7 # Free Software Foundation; either version 2, or (at your option) any
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
8 # later version.
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
9 #
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
10 # Octave is distributed in the hope that it will be useful, but WITHOUT
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
13 # for more details.
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
14 #
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
15 # You should have received a copy of the GNU General Public License
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
16 # along with Octave; see the file COPYING. If not, write to the Free
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1026
diff changeset
17 # Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
18
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
19 function y = gammai (a, x)
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
20
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
21 # usage: gammai (a, x)
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
22 #
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
23 # Computes the incomplete gamma function
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
24 #
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
25 # gammai (a, x)
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
26 # = (integral from 0 to x of exp(-t) t^(a-1) dt) / gamma(a).
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
27 #
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
28 # If a is scalar, then gammai(a, x) is returned for each element of x
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
29 # and vice versa.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
30 #
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
31 # If neither a nor x is scalar, the sizes of a and x must agree, and
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
32 # gammai is applied pointwise.
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
33
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
34 # Written by KH (Kurt.Hornik@ci.tuwien.ac.at) on Aug 13, 1994
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
35
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
36 if (nargin != 2)
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
37 usage ("gammai (a, x)");
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
38 endif
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
39
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
40 [r_a, c_a] = size (a);
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
41 [r_x, c_x] = size (x);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
42 e_a = r_a * c_a;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
43 e_x = r_x * c_x;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
44
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
45 # The following code is rather ugly. We want the function to work
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
46 # whenever a and x have the same size or a or x is scalar.
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
47 # We do this by reducing the latter cases to the former.
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
48
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
49 if (e_a == 0 || e_x == 0)
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
50 error ("gammai: both a and x must be nonempty");
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
51 endif
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
52 if (r_a == r_x && c_a == c_x)
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
53 n = e_a;
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
54 a = reshape (a, 1, n);
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
55 x = reshape (x, 1, n);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
56 r_y = r_a;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
57 c_y = c_a;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
58 elseif (e_a == 1)
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
59 n = e_x;
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
60 a = a * ones (1, n);
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
61 x = reshape (x, 1, n);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
62 r_y = r_x;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
63 c_y = c_x;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
64 elseif (e_x == 1)
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
65 n = e_a;
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
66 a = reshape (a, 1, n);
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
67 x = x * ones (1, n);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
68 r_y = r_a;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
69 c_y = c_a;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
70 else
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
71 error ("gammai: a and x must have the same size if neither is scalar");
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
72 endif
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
73
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
74 # Now we can do sanity checking ...
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
75
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
76 if (any (a <= 0) || any (a == Inf))
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
77 error ("gammai: all entries of a must be positive anf finite");
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
78 endif
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
79 if (any (x < 0))
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
80 error ("gammai: all entries of x must be nonnegative");
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
81 endif
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
82
1586
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
83 y = zeros (1, n);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
84
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
85 # For x < a + 1, use summation. The below choice of k should ensure
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
86 # that the overall error is less than eps ...
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
87
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
88 S = find ((x > 0) & (x < a + 1));
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
89 s = length (S);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
90 if (s > 0)
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
91 k = ceil (- max ([a(S), x(S)]) * log (eps));
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
92 K = (1:k)';
1586
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
93 M = ones (k, 1);
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
94 A = cumprod ((M * x(S)) ./ (M * a(S) + K * ones(1, s)));
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
95 y(S) = exp (-x(S) + a(S) .* log (x(S))) .* (1 + sum (A)) ./ gamma (a(S)+1);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
96 endif
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
97
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
98 # For x >= a + 1, use the continued fraction.
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
99 # Note, however, that this converges MUCH slower than the series
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
100 # expansion for small a and x not too large!
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
101
1586
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
102 S = find ((x >= a + 1) & (x < Inf));
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
103 s = length (S);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
104 if (s > 0)
1586
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
105 t1 = zeros (1, s);
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
106 t2 = ones (1, s);
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
107 u = [t1; t2];
54350c98055c [project @ 1995-10-31 05:22:53 by jwe]
jwe
parents: 1585
diff changeset
108 v = [t2; x(S)];
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
109 c_old = 0;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
110 c_new = v(1,:) ./ v(2,:);
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
111 n = 1;
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
112 while (max (abs (c_old ./ c_new - 1)) > 10 * eps)
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
113 c_old = c_new;
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
114 u = v + u .* (ones (2, 1) * (n - a(S)));
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
115 v = u .* (ones (2, 1) * x(S)) + n * v;
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
116 c_new = v(1,:) ./ v(2,:);
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
117 n = n + 1;
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
118 endwhile
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
119 y(S) = 1 - exp (-x(S) + a(S) .* log (x(S))) .* c_new ./ gamma (a(S));
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
120 endif
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
121
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
122 y (find (x == Inf)) = ones (1, sum (x == Inf));
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
123
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
124 y = reshape (y, r_y, c_y);
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
125
1585
100413a7e8a2 [project @ 1995-10-31 05:14:06 by jwe]
jwe
parents: 1315
diff changeset
126 endfunction