lib/libm/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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)lgamma.3      6.6 (Berkeley) 12/3/92
  29 .\"     $NetBSD: lgamma.3,v 1.21 2003/08/07 16:44:48 agc Exp $
  30 .\"     $DragonFly: src/lib/libm/man/lgamma.3,v 1.1 2005/07/26 21:15:20 joerg Exp $
  31 .\"
  32 .Dd December 3, 1992
  33 .Dt LGAMMA 3
  34 .Os
  35 .Sh NAME
  36 .Nm lgamma ,
  37 .Nm lgammaf ,
  38 .Nm lgamma_r ,
  39 .Nm lgammaf_r ,
  40 .Nm gamma ,
  41 .Nm gammaf ,
  42 .Nm gamma_r ,
  43 .Nm gammaf_r
  44 .Nd log gamma function
  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 lgamma_r "double x" "int *sign"
  58 .Ft float
  59 .Fn lgammaf_r "float x" "int *sign"
  60 .Ft double
  61 .Fn gamma "double x"
  62 .Ft float
  63 .Fn gammaf "float x"
  64 .Ft double
  65 .Fn gamma_r "double x" "int *sign"
  66 .Ft float
  67 .Fn gammaf_r "float x" "int *sign"
  68 .Sh DESCRIPTION
  69 .Fn lgamma x
  70 .if t \{\
  71 returns ln\||\(*G(x)| where
  72 .Bd -unfilled -offset indent
  73 \(*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 \*[Gt] 0 and
  74 .br
  75 \(*G(x) = \(*p/(\(*G(1\-x)\|sin(\(*px)) for x \*[Lt] 1.
  76 .Ed
  77 .\}
  78 .if n \
  79 returns ln\||\(*G(x)|.
  80 .Pp
  81 The external integer
  82 .Fa signgam
  83 returns the sign of \(*G(x).
  84 .Pp
  85 .Fn lgamma_r
  86 is a reentrant interface that performs identically to
  87 .Fn lgamma ,
  88 differing in that the sign of \(*G(x) is stored in the location
  89 pointed to by the
  90 .Fa sign
  91 argument and
  92 .Fa signgam
  93 is not modified.
  94 .Sh IDIOSYNCRASIES
  95 Do not use the expression
  96 .Dq Li signgam\(**exp(lgamma(x))
  97 to compute g := \(*G(x).
  98 Instead use a program like this (in C):
  99 .Bd -literal -offset indent
 100 lg = lgamma(x); g = signgam\(**exp(lg);
 101 .Ed
 102 .Pp
 103 Only after
 104 .Fn lgamma
 105 has returned can signgam be correct.
 106 .Sh RETURN VALUES
 107 .Fn lgamma
 108 returns appropriate values unless an argument is out of range.
 109 Overflow will occur for sufficiently large positive values, and
 110 non-positive integers.
 111 On the
 112 .Tn VAX ,
 113 the reserved operator is returned,
 114 and
 115 .Va errno
 116 is set to
 117 .Er ERANGE .
 118 .Sh SEE ALSO
 119 .Xr math 3
 120 .Sh HISTORY
 121 The
 122 .Nm lgamma
 123 function appeared in
 124 .Bx 4.3 .