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

   1 @cindex logarithm and related functions
   2
   3 Information on the properties of the Logarithm function can be found in
   4 Abramowitz & Stegun, Chapter 4.  The functions described in this section
   5 are declared in the header file @file{gsl_sf_log.h}.
   6
   7 @deftypefun double gsl_sf_log (double @var{x})
   8 @deftypefunx int gsl_sf_log_e (double @var{x}, gsl_sf_result * @var{result})
   9 These routines compute the logarithm of @var{x}, @math{\log(x)}, for
  10 @math{x > 0}.
  11 @comment Exceptional Return Values: GSL_EDOM
  12 @end deftypefun
  13
  14
  15 @deftypefun double gsl_sf_log_abs (double @var{x})
  16 @deftypefunx int gsl_sf_log_abs_e (double @var{x}, gsl_sf_result * @var{result})
  17 These routines compute the logarithm of the magnitude of @var{x},
  18 @math{\log(|x|)}, for @math{x \ne 0}.
  19 @comment Exceptional Return Values: GSL_EDOM
  20 @end deftypefun
  21
  22
  23 @deftypefun int gsl_sf_complex_log_e (double @var{zr}, double @var{zi}, gsl_sf_result * @var{lnr}, gsl_sf_result * @var{theta})
  24 This routine computes the complex logarithm of @math{z = z_r + i
  25 z_i}. The results are returned as @var{lnr}, @var{theta} such that
  26 @math{\exp(lnr + i \theta) = z_r + i z_i}, where @math{\theta} lies in
  27 the range @math{[-\pi,\pi]}.
  28 @comment Exceptional Return Values: GSL_EDOM
  29 @end deftypefun
  30
  31
  32 @deftypefun double gsl_sf_log_1plusx (double @var{x})
  33 @deftypefunx int gsl_sf_log_1plusx_e (double @var{x}, gsl_sf_result * @var{result})
  34 These routines compute @math{\log(1 + x)} for @math{x > -1} using an
  35 algorithm that is accurate for small @math{x}.
  36 @comment Domain: x > -1.0
  37 @comment Exceptional Return Values: GSL_EDOM
  38 @end deftypefun
  39
  40
  41 @deftypefun double gsl_sf_log_1plusx_mx (double @var{x})
  42 @deftypefunx int gsl_sf_log_1plusx_mx_e (double @var{x}, gsl_sf_result * @var{result})
  43 These routines compute @math{\log(1 + x) - x} for @math{x > -1} using an
  44 algorithm that is accurate for small @math{x}.
  45 @comment Domain: x > -1.0
  46 @comment Exceptional Return Values: GSL_EDOM
  47 @end deftypefun