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 .\"     $Id$
  34 .\"
  35 .Dd December 11, 1993
  36 .Dt LGAMMA 3
  37 .Os BSD 4.3
  38 .Sh NAME
  39 .Nm lgamma
  40 .Nm gamma
  41 .Nd log gamma function, gamma function
  42 .Sh SYNOPSIS
  43 .Fd #include <math.h>
  44 .Ft extern int
  45 .Fa signgam ;
  46 .sp
  47 .Ft double
  48 .Fn lgamma "double x"
  49 .Ft double
  50 .Fn gamma "double x"
  51 .Sh DESCRIPTION
  52 .Fn Lgamma x
  53 .if t \{\
  54 returns ln\||\(*G(x)| where
  55 .Bd -unfilled -offset indent
  56 \(*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
  57 .br
  58 \(*G(x) = \(*p/(\(*G(1\-x)\|sin(\(*px)) for x < 1.
  59 .Ed
  60 .\}
  61 .if n \
  62 returns ln\||\(*G(x)|.
  63 .Pp
  64 The external integer
  65 .Fa signgam
  66 returns the sign of \(*G(x).
  67 .Pp
  68 .Fn Gamma x
  69 returns \(*G(x), with no effect on
  70 .Fa signgam .
  71 .Sh IDIOSYNCRASIES
  72 Do not use the expression
  73 .Dq Li signgam\(**exp(lgamma(x))
  74 to compute g := \(*G(x).
  75 Instead use a program like this (in C):
  76 .Bd -literal -offset indent
  77 lg = lgamma(x); g = signgam\(**exp(lg);
  78 .Ed
  79 .Pp
  80 Only after
  81 .Fn lgamma
  82 has returned can signgam be correct.
  83 .Pp
  84 For arguments in its range,
  85 .Fn gamma
  86 is preferred, as for positive arguments
  87 it is accurate to within one unit in the last place.
  88 Exponentiation of
  89 .Fn lgamma
  90 will lose up to 10 significant bits.
  91 .Sh RETURN VALUES
  92 .Fn Gamma
  93 and
  94 .Fn lgamma
  95 return appropriate values unless an argument is out of range.
  96 Overflow will occur for sufficiently large positive values, and
  97 non-positive integers.
  98 On the
  99 .Tn VAX,
 100 the reserved operator is returned,
 101 and
 102 .Va errno
 103 is set to
 104 .Er ERANGE
 105 For large non-integer negative values,
 106 .Fn gamma
 107 will underflow.
 108 .Sh SEE ALSO
 109 .Xr infnan 3 ,
 110 .Xr math 3
 111 .Sh HISTORY
 112 The
 113 .Nm lgamma
 114 function appeared in
 115 .Bx 4.3 .
 116 The
 117 .Nm gamma
 118 function appeared in
 119 .Bx 4.4 .
 120 The name
 121 .Fn gamma
 122 was originally dedicated to the
 123 .Fn lgamma
 124 function, so some old code may no longer be compatible.