annotate src/DLD-FUNCTIONS/gammainc.cc @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 080c08b192d8
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
1 /*
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
2
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 1997 John W. Eaton
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
4
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
6
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
10 option) any later version.
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
11
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
15 for more details.
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
16
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
17 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: 5823
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5823
diff changeset
19 <http://www.gnu.org/licenses/>.
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
20
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
21 */
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
22
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
23 #ifdef HAVE_CONFIG_H
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
24 #include <config.h>
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
25 #endif
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
26
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
27 #include "lo-specfun.h"
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
28
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
29 #include "defun-dld.h"
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
30 #include "error.h"
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
31 #include "gripes.h"
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
32 #include "oct-obj.h"
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
33 #include "utils.h"
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
34
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
35 DEFUN_DLD (gammainc, args, ,
3548
ab7fa5a8f23f [project @ 2000-02-03 01:17:15 by jwe]
jwe
parents: 3444
diff changeset
36 "-*- texinfo -*-\n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
37 @deftypefn {Mapping Function} {} gammainc (@var{x}, @var{a})\n\
5517
947aa3464e1d [project @ 2005-10-28 14:21:11 by jwe]
jwe
parents: 5307
diff changeset
38 Compute the normalized incomplete gamma function,\n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
39 @iftex\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
40 @tex\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
41 $$\n\
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
42 \\gamma (x, a) = {\\displaystyle\\int_0^x e^{-t} t^{a-1} dt \\over \\Gamma (a)}\n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
43 $$\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
44 @end tex\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
45 @end iftex\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
46 @ifinfo\n\
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
47 \n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
48 @smallexample\n\
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
49 x\n\
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
50 1 /\n\
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
51 gammainc (x, a) = --------- | exp (-t) t^(a-1) dt\n\
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
52 gamma (a) /\n\
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
53 t=0\n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
54 @end smallexample\n\
5517
947aa3464e1d [project @ 2005-10-28 14:21:11 by jwe]
jwe
parents: 5307
diff changeset
55 \n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
56 @end ifinfo\n\
5517
947aa3464e1d [project @ 2005-10-28 14:21:11 by jwe]
jwe
parents: 5307
diff changeset
57 with the limiting value of 1 as @var{x} approaches infinity.\n\
947aa3464e1d [project @ 2005-10-28 14:21:11 by jwe]
jwe
parents: 5307
diff changeset
58 The standard notation is @math{P(a,x)}, e.g. Abramowitz and Stegun (6.5.1).\n\
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
59 \n\
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
60 If @var{a} is scalar, then @code{gammainc (@var{x}, @var{a})} is returned\n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
61 for each element of @var{x} and vice versa.\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
62 \n\
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
63 If neither @var{x} nor @var{a} is scalar, the sizes of @var{x} and\n\
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3548
diff changeset
64 @var{a} must agree, and @var{gammainc} is applied element-by-element.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5517
diff changeset
65 @seealso{gamma, lgamma}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5517
diff changeset
66 @end deftypefn")
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
67 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
68 octave_value retval;
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
69
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
70 int nargin = args.length ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
71
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
72 if (nargin == 2)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
73 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
74 octave_value x_arg = args(0);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
75 octave_value a_arg = args(1);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
76
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
77 if (x_arg.is_scalar_type ())
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
78 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
79 double x = x_arg.double_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
80
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
81 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
82 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
83 if (a_arg.is_scalar_type ())
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
84 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
85 double a = a_arg.double_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
86
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
87 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
88 retval = gammainc (x, a);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
89 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
90 else
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
91 {
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 3683
diff changeset
92 NDArray a = a_arg.array_value ();
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
93
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
94 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
95 retval = gammainc (x, a);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
96 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
97 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
98 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
99 else
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
100 {
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 3683
diff changeset
101 NDArray x = x_arg.array_value ();
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
102
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
103 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
104 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
105 if (a_arg.is_scalar_type ())
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
106 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
107 double a = a_arg.double_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
108
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
109 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
110 retval = gammainc (x, a);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
111 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
112 else
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
113 {
4844
9f7ef92b50b0 [project @ 2004-04-02 17:26:53 by jwe]
jwe
parents: 3683
diff changeset
114 NDArray a = a_arg.array_value ();
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
115
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
116 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
117 retval = gammainc (x, a);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
118 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
119 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
120 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
121 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
122 else
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5642
diff changeset
123 print_usage ();
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
124
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
125 return retval;
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
126 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
127
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
128 /*
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
129 ;;; Local Variables: ***
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
130 ;;; mode: C++ ***
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
131 ;;; End: ***
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
132 */
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
133