htswanalysis/MACS/lib/gsl/gsl-1.11/doc/specfunc-psi.texi

   1 @cindex psi function
   2 @cindex digamma function
   3 @cindex polygamma functions
   4
   5 The polygamma functions of order @math{n} are defined by
   6 @tex
   7 \beforedisplay
   8 $$
   9 \psi^{(n)}(x) = \left(d \over dx\right)^n \psi(x) = \left(d \over dx\right)^{n+1} \log(\Gamma(x))
  10 $$
  11 \afterdisplay
  12 @end tex
  13 @ifinfo
  14
  15 @example
  16 \psi^@{(n)@}(x) = (d/dx)^n \psi(x) = (d/dx)^@{n+1@} \log(\Gamma(x))
  17 @end example
  18
  19 @end ifinfo
  20 @noindent
  21 where @math{\psi(x) = \Gamma'(x)/\Gamma(x)} is known as the digamma function.
  22 These functions are declared in the header file @file{gsl_sf_psi.h}.
  23
  24 @menu
  25 * Digamma Function::
  26 * Trigamma Function::
  27 * Polygamma Function::
  28 @end menu
  29
  30 @node Digamma Function
  31 @subsection Digamma Function
  32
  33 @deftypefun double gsl_sf_psi_int (int @var{n})
  34 @deftypefunx int gsl_sf_psi_int_e (int @var{n}, gsl_sf_result * @var{result})
  35 These routines compute the digamma function @math{\psi(n)} for positive
  36 integer @var{n}.  The digamma function is also called the Psi function.
  37 @comment Domain: n integer, n > 0
  38 @comment Exceptional Return Values: GSL_EDOM
  39 @end deftypefun
  40
  41
  42 @deftypefun double gsl_sf_psi (double @var{x})
  43 @deftypefunx int gsl_sf_psi_e (double @var{x}, gsl_sf_result * @var{result})
  44 These routines compute the digamma function @math{\psi(x)} for general
  45 @math{x}, @math{x \ne 0}.
  46 @comment Domain: x != 0.0, -1.0, -2.0, ...
  47 @comment Exceptional Return Values: GSL_EDOM, GSL_ELOSS
  48 @end deftypefun
  49
  50
  51 @deftypefun double gsl_sf_psi_1piy (double @var{y})
  52 @deftypefunx int gsl_sf_psi_1piy_e (double @var{y}, gsl_sf_result * @var{result})
  53 These routines compute the real part of the digamma function on the line
  54 @math{1+i y}, @math{\Re[\psi(1 + i y)]}.
  55 @comment exceptions: none
  56 @comment Exceptional Return Values: none
  57 @end deftypefun
  58
  59
  60 @node Trigamma Function
  61 @subsection Trigamma Function
  62
  63 @deftypefun double gsl_sf_psi_1_int (int @var{n})
  64 @deftypefunx int gsl_sf_psi_1_int_e (int @var{n}, gsl_sf_result * @var{result})
  65 These routines compute the Trigamma function @math{\psi'(n)} for
  66 positive integer @math{n}.
  67 @comment Domain: n integer, n > 0
  68 @comment Exceptional Return Values: GSL_EDOM
  69 @end deftypefun
  70
  71 @deftypefun double gsl_sf_psi_1 (double @var{x})
  72 @deftypefunx int gsl_sf_psi_1_e (double @var{x}, gsl_sf_result * @var{result})
  73 These routines compute the Trigamma function @math{\psi'(x)} for
  74 general @math{x}.
  75 @comment Domain: x != 0.0, -1.0, -2.0, ...
  76 @comment Exceptional Return Values: GSL_EDOM, GSL_ELOSS
  77 @end deftypefun
  78
  79 @node Polygamma Function
  80 @subsection Polygamma Function
  81
  82 @deftypefun double gsl_sf_psi_n (int @var{n}, double @var{x})
  83 @deftypefunx int gsl_sf_psi_n_e (int @var{n}, double @var{x}, gsl_sf_result * @var{result})
  84 These routines compute the polygamma function @c{$\psi^{(n)}(x)$}
  85 @math{\psi^@{(n)@}(x)} for
  86 @c{$n \ge 0$}
  87 @math{n >= 0}, @math{x > 0}.
  88 @comment Domain: n >= 0, x > 0.0
  89 @comment Exceptional Return Values: GSL_EDOM
  90 @end deftypefun