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