annotate src/DLD-FUNCTIONS/gammainc.cc @ 3548:ab7fa5a8f23f

[project @ 2000-02-03 01:17:15 by jwe]
author jwe
date Thu, 03 Feb 2000 01:17:21 +0000
parents fa0d84558faa
children 505f5c35a2c9
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
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
10 later version.
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
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
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\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
38 Computes the incomplete gamma function,\n\
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\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
42 \\gamma (a, x) = {\\displaystyle\\int_0^x e^{-t} t^{a-1} dt \\over \\Gamma (a)}\n\
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\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
49 x\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
50 1 /\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
51 gammainc (a, x) = --------- | exp (-t) t^(a-1) dt\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
52 gamma (a) /\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
53 t=0\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
54 @end smallexample\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
55 @end ifinfo\n\
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
56 \n\
3444
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
57 If @var{a} is scalar, then @code{gammainc (@var{a}, @var{x})} is returned\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
58 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
59 \n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
60 If neither @var{a} nor @var{x} is scalar, the sizes of @var{a} and\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
61 @var{x} must agree, and @var{gammainc} is applied element-by-element.\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
62 @end deftypefn\n\
fa0d84558faa [project @ 2000-01-17 08:40:39 by jwe]
jwe
parents: 3254
diff changeset
63 @seealso{gamma and lgamma}")
3254
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
64 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
65 octave_value retval;
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
66
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
67 int nargin = args.length ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
68
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
69 if (nargin == 2)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
70 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
71 octave_value x_arg = args(0);
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
72 octave_value a_arg = args(1);
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 if (x_arg.is_scalar_type ())
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
75 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
76 double x = x_arg.double_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
77
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
78 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
79 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
80 if (a_arg.is_scalar_type ())
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
81 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
82 double a = a_arg.double_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
83
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
84 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
85 retval = gammainc (x, a);
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 else
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
88 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
89 Matrix a = a_arg.matrix_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
90
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
91 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
92 retval = gammainc (x, a);
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 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
95 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
96 else
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 Matrix x = x_arg.matrix_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
99
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
100 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
101 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
102 if (a_arg.is_scalar_type ())
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
103 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
104 double a = a_arg.double_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
105
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
106 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
107 retval = gammainc (x, a);
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 else
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
110 {
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
111 Matrix a = a_arg.matrix_value ();
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
112
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
113 if (! error_state)
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
114 retval = gammainc (x, a);
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 }
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
117 }
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 else
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
120 print_usage ("gammainc");
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 return retval;
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
123 }
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 /*
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
126 ;;; Local Variables: ***
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
127 ;;; mode: C++ ***
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
128 ;;; End: ***
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
129 */
28d5f556b8cf [project @ 1999-07-15 16:02:57 by jwe]
jwe
parents:
diff changeset
130