lib/msun/man/lgamma.3

   1 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   2 .\" 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 .\"     from: @(#)lgamma.3      6.6 (Berkeley) 12/3/92
  33 .\" $FreeBSD: src/lib/msun/man/lgamma.3,v 1.7.2.6 2003/01/04 01:01:29 jdp Exp $
  34 .\" $DragonFly: src/lib/msun/man/Attic/lgamma.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
  35 .\"
  36 .Dd December 3, 1992
  37 .Dt LGAMMA 3
  38 .Os
  39 .Sh NAME
  40 .Nm lgamma ,
  41 .Nm lgammaf ,
  42 .Nm gamma ,
  43 .Nm gammaf
  44 .Nd log gamma functions, gamma functions
  45 .Sh LIBRARY
  46 .Lb libm
  47 .Sh SYNOPSIS
  48 .In math.h
  49 .Ft extern int
  50 .Fa signgam ;
  51 .sp
  52 .Ft double
  53 .Fn lgamma "double x"
  54 .Ft float
  55 .Fn lgammaf "float x"
  56 .Ft double
  57 .Fn gamma "double x"
  58 .Ft float
  59 .Fn gammaf "float x"
  60 .Sh DESCRIPTION
  61 .Fn lgamma x
  62 and
  63 .Fn lgammaf x
  64 .if t \{\
  65 return ln\||\(*G(x)| where
  66 .Bd -unfilled -offset indent
  67 \(*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
  68 .br
  69 \(*G(x) = \(*p/(\(*G(1\-x)\|sin(\(*px)) for x < 1.
  70 .Ed
  71 .\}
  72 .if n \
  73 return ln\||\(*G(x)|.
  74 .Pp
  75 The external integer
  76 .Fa signgam
  77 returns the sign of \(*G(x).
  78 .Pp
  79 .Fn gamma
  80 and
  81 .Fn gammaf
  82 are deprecated aliases for
  83 .Fn lgamma
  84 and
  85 .Fn lgammaf ,
  86 respectively.
  87 .Sh IDIOSYNCRASIES
  88 Do not use the expression
  89 .Dq Li signgam\(**exp(lgamma(x))
  90 to compute g := \(*G(x).
  91 Instead use a program like this (in C):
  92 .Bd -literal -offset indent
  93 lg = lgamma(x); g = signgam\(**exp(lg);
  94 .Ed
  95 .Pp
  96 Only after
  97 .Fn lgamma
  98 or
  99 .Fn lgammaf
 100 has returned can signgam be correct.
 101 .\".Pp
 102 .\"For arguments in its range,
 103 .\".Fn gamma
 104 .\"is preferred, as for positive arguments
 105 .\"it is accurate to within one unit in the last place.
 106 .\"Exponentiation of
 107 .\".Fn lgamma
 108 .\"will lose up to 10 significant bits.
 109 .Sh RETURN VALUES
 110 .Fn gamma ,
 111 .Fn gammaf ,
 112 .Fn lgamma ,
 113 and
 114 .Fn lgammaf
 115 return appropriate values unless an argument is out of range.
 116 Overflow will occur for sufficiently large positive values, and
 117 non-positive integers.
 118 On the
 119 .Tn VAX ,
 120 the reserved operator is returned,
 121 and
 122 .Va errno
 123 is set to
 124 .Er ERANGE .
 125 \."For large non-integer negative values,
 126 \.".Fn gamma
 127 \."will underflow.
 128 .Sh SEE ALSO
 129 .Xr math 3
 130 .Sh HISTORY
 131 The
 132 .Fn lgamma
 133 function appeared in
 134 .Bx 4.3 .
 135 The
 136 .Fn gamma
 137 function appeared in
 138 .Bx 4.4
 139 as a function which computed \(*G(x).
 140 This version was used in
 141 .Fx 1.1 .
 142 The name
 143 .Fn gamma
 144 was originally dedicated to the
 145 .Fn lgamma
 146 function,
 147 and that usage was restored by switching to Sun's fdlibm in
 148 .Fx 1.1.5 .
 149 The
 150 .St -isoC-99
 151 standard specifies a function
 152 .Fn tgamma
 153 for computing \(*G(x).
 154 This function is currently unimplemented in this library.