annotate scripts/specfun/gammai.m @ 3426:f8dde1807dee

[project @ 2000-01-13 08:40:00 by jwe]
author jwe
date Thu, 13 Jan 2000 08:40:53 +0000
parents ae7adbb591e8
children fa0d84558faa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1998 John W. Eaton
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
2 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
4 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
9 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
14 ##
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
18 ## 02111-1307, USA.
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
19
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
20 ## -*- texinfo -*-
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
21 ## @deftypefn {Mapping Function} {} gammai (@var{a}, @var{x})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
22 ## Computes the incomplete gamma function,
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
23 ## @iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
24 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
25 ## $$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
26 ## \gamma (a, x) = {\displaystyle\int_0^x e^{-t} t^{a-1} dt \over \Gamma (a)}
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
27 ## $$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
28 ## @end tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
29 ## @end iftex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
30 ## @ifinfo
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
31 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
32 ## @smallexample
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
33 ## x
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
34 ## 1 /
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
35 ## gammai (a, x) = --------- | exp (-t) t^(a-1) dt
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
36 ## gamma (a) /
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
37 ## t=0
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
38 ## @end smallexample
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
39 ## @end ifinfo
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
40 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
41 ## If @var{a} is scalar, then @code{gammai (@var{a}, @var{x})} is returned
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
42 ## for each element of @var{x} and vice versa.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
43 ##
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
44 ## If neither @var{a} nor @var{x} is scalar, the sizes of @var{a} and
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
45 ## @var{x} must agree, and @var{gammai} is applied element-by-element.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 3133
diff changeset
46 ## @end deftypefn
3408
ae7adbb591e8 [project @ 2000-01-06 08:29:11 by jwe]
jwe
parents: 3407
diff changeset
47 ## @seealso{gamma and lgamma}
3133
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
48
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
49 ## Author: jwe
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
50 ## Created: 30 Jan 1998
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
51
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
52 function retval = gammai (a, x)
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
53
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
54 if (nargin == 2)
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
55 retval = gammainc (x, a);
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
56 else
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
57 usage ("gammai (a, x)");
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
58 endif
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
59
812645c63072 [project @ 1998-01-30 21:23:00 by jwe]
jwe
parents:
diff changeset
60 endfunction