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