lib/libm/common_source/lgamma.3

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)lgamma.3    8.2 (Berkeley) 12/11/93
  33 .\"
  34 .Dd December 11, 1993
  35 .Dt LGAMMA 3
  36 .Os BSD 4.3
  37 .Sh NAME
  38 .Nm lgamma
  39 .Nm gamma
  40 .Nd log gamma function, gamma function
  41 .Sh SYNOPSIS
  42 .Fd #include <math.h>
  43 .Ft extern int
  44 .Fa signgam ;
  45 .sp
  46 .Ft double
  47 .Fn lgamma "double x"
  48 .Ft double
  49 .Fn gamma "double x"
  50 .Sh DESCRIPTION
  51 .Fn Lgamma x
  52 .if t \{\
  53 returns ln\||\(*G(x)| where
  54 .Bd -unfilled -offset indent
  55 \(*G(x) = \(is\d\s8\z0\s10\u\u\s8\(if\s10\d t\u\s8x\-1\s10\d e\u\s8\-t\s10\d dt for x > 0 and
  56 .br
  57 \(*G(x) = \(*p/(\(*G(1\-x)\|sin(\(*px)) for x < 1.
  58 .Ed
  59 .\}
  60 .if n \
  61 returns ln\||\(*G(x)|.
  62 .Pp
  63 The external integer
  64 .Fa signgam
  65 returns the sign of \(*G(x).
  66 .Pp
  67 .Fn Gamma x
  68 returns \(*G(x), with no effect on
  69 .Fa signgam .
  70 .Sh IDIOSYNCRASIES
  71 Do not use the expression
  72 .Dq Li signgam\(**exp(lgamma(x))
  73 to compute g := \(*G(x).
  74 Instead use a program like this (in C):
  75 .Bd -literal -offset indent
  76 lg = lgamma(x); g = signgam\(**exp(lg);
  77 .Ed
  78 .Pp
  79 Only after
  80 .Fn lgamma
  81 has returned can signgam be correct.
  82 .Pp
  83 For arguments in its range,
  84 .Fn gamma
  85 is preferred, as for positive arguments
  86 it is accurate to within one unit in the last place.
  87 Exponentiation of
  88 .Fn lgamma
  89 will lose up to 10 significant bits.
  90 .Sh RETURN VALUES
  91 .Fn Gamma
  92 and
  93 .Fn lgamma
  94 return appropriate values unless an argument is out of range.
  95 Overflow will occur for sufficiently large positive values, and
  96 non-positive integers.
  97 On the
  98 .Tn VAX,
  99 the reserved operator is returned,
 100 and
 101 .Va errno
 102 is set to
 103 .Er ERANGE
 104 For large non-integer negative values,
 105 .Fn gamma
 106 will underflow.
 107 .Sh SEE ALSO
 108 .Xr infnan 3 ,
 109 .Xr math 3
 110 .Sh HISTORY
 111 The
 112 .Nm lgamma
 113 function appeared in
 114 .Bx 4.3 .
 115 The
 116 .Nm gamma
 117 function appeared in
 118 .Bx 4.4 .
 119 The name
 120 .Fn gamma
 121 was originally dedicated to the
 122 .Fn lgamma
 123 function, so some old code may no longer be compatible.