[Pkg-octave-devel] Bug#335195: octave2.1: document incomplete gamma function

[James R. Van Zandt]

Package: octave2.1
Version: 2.1.69-1
Severity: minor


There are several functions called "incomplete gamma function" in the
literature.  I suggest this patch to relate this function to the
standard nomenclature - i.e. (using TeX) which one of

 $  \gamma(a,z)  $  with limiting value $ \gamma(a,\infty)=\Gamma(a) $
 $  \Gamma(a,z)  $  with limiting value $ \Gamma(a,\infty)=0 $
 $  P(a,z)  $       with limiting value $ P(a,\infty)=1 $

is being calculated.

          - Jim Van Zandt

--- src/DLD-FUNCTIONS/gammainc.cc-old	2005-10-22 09:55:46.000000000 -0400
+++ src/DLD-FUNCTIONS/gammainc.cc	2005-10-22 10:05:15.000000000 -0400
@@ -36,7 +36,7 @@
 DEFUN_DLD (gammainc, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} gammainc (@var{x}, @var{a})\n\
-Computes the incomplete gamma function,\n\
+Computes the normalized incomplete gamma function,\n\
 @iftex\n\
 @tex\n\
 $$\n\
@@ -55,6 +55,9 @@
 @end smallexample\n\
 @end ifinfo\n\
 \n\
+with the limiting value of 1 as X goes to infinity.
+The standard notation is P(A,X), e.g. Abramowitz & Stegun (6.5.1).
+\n\
 If @var{a} is scalar, then @code{gammainc (@var{x}, @var{a})} is returned\n\
 for each element of @var{x} and vice versa.\n\
 \n\


-- System Information:
Debian Release: testing/unstable
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'oldstable'), (500, 'unstable')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.4.29
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968)

Versions of packages octave2.1 depends on:
ii  atlas3-base [liblapack.s 3.6.0-19        Automatically Tuned Linear Algebra
ii  fftw3                    3.0.1-11        Library for computing Fast Fourier
ii  lapack3 [liblapack.so.3] 3.0.20000531a-6 library of linear algebra routines
ii  libc6                    2.3.5-6         GNU C Library: Shared libraries an
ii  libg2c0                  1:3.4.4-5       Runtime library for GNU Fortran 77
ii  libgcc1                  1:4.0.1-2       GCC support library
ii  libhdf5-serial-1.6.2-0 [ 1.6.2-3         Hierarchical Data Format 5 (HDF5) 
ii  libncurses5              5.4-9           Shared libraries for terminal hand
ii  libreadline5             5.0-10          GNU readline and history libraries
ii  libstdc++5               1:3.3.6-7       The GNU Standard C++ Library v3
ii  texinfo                  4.7-2.2         Documentation system for on-line i
ii  zlib1g                   1:1.2.2-4       compression library - runtime

octave2.1 recommends no packages.

-- no debconf information