lib/libm/common_source/lgamma.c

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * @(#)lgamma.c 8.2 (Berkeley) 11/30/93
  34  */
  35
  36 /*
  37  * Coded by Peter McIlroy, Nov 1992;
  38  *
  39  * The financial support of UUNET Communications Services is greatfully
  40  * acknowledged.
  41  */
  42
  43 #include <math.h>
  44 #include <errno.h>
  45
  46 #include "mathimpl.h"
  47
  48 /* Log gamma function.
  49  * Error:  x > 0 error < 1.3ulp.
  50  *         x > 4, error < 1ulp.
  51  *         x > 9, error < .6ulp.
  52  *         x < 0, all bets are off. (When G(x) ~ 1, log(G(x)) ~ 0)
  53  * Method:
  54  *      x > 6:
  55  *              Use the asymptotic expansion (Stirling's Formula)
  56  *      0 < x < 6:
  57  *              Use gamma(x+1) = x*gamma(x) for argument reduction.
  58  *              Use rational approximation in
  59  *              the range 1.2, 2.5
  60  *              Two approximations are used, one centered at the
  61  *              minimum to ensure monotonicity; one centered at 2
  62  *              to maintain small relative error.
  63  *      x < 0:
  64  *              Use the reflection formula,
  65  *              G(1-x)G(x) = PI/sin(PI*x)
  66  * Special values:
  67  *      non-positive integer    returns +Inf.
  68  *      NaN                     returns NaN
  69 */
  70 static int endian;
  71 #if defined(vax) || defined(tahoe)
  72 #define _IEEE           0
  73 /* double and float have same size exponent field */
  74 #define TRUNC(x)        x = (double) (float) (x)
  75 #else
  76 #define _IEEE           1
  77 #define TRUNC(x)        *(((int *) &x) + endian) &= 0xf8000000
  78 #define infnan(x)       0.0
  79 #endif
  80
  81 static double small_lgam(double);
  82 static double large_lgam(double);
  83 static double neg_lgam(double);
  84 static double zero = 0.0, one = 1.0;
  85 int signgam;
  86
  87 #define UNDERFL (1e-1020 * 1e-1020)
  88
  89 #define LEFT    (1.0 - (x0 + .25))
  90 #define RIGHT   (x0 - .218)
  91 /*
  92  * Constants for approximation in [1.244,1.712]
  93 */
  94 #define x0      0.461632144968362356785
  95 #define x0_lo   -.000000000000000015522348162858676890521
  96 #define a0_hi   -0.12148629128932952880859
  97 #define a0_lo   .0000000007534799204229502
  98 #define r0      -2.771227512955130520e-002
  99 #define r1      -2.980729795228150847e-001
 100 #define r2      -3.257411333183093394e-001
 101 #define r3      -1.126814387531706041e-001
 102 #define r4      -1.129130057170225562e-002
 103 #define r5      -2.259650588213369095e-005
 104 #define s0       1.714457160001714442e+000
 105 #define s1       2.786469504618194648e+000
 106 #define s2       1.564546365519179805e+000
 107 #define s3       3.485846389981109850e-001
 108 #define s4       2.467759345363656348e-002
 109 /*
 110  * Constants for approximation in [1.71, 2.5]
 111 */
 112 #define a1_hi   4.227843350984671344505727574870e-01
 113 #define a1_lo   4.670126436531227189e-18
 114 #define p0      3.224670334241133695662995251041e-01
 115 #define p1      3.569659696950364669021382724168e-01
 116 #define p2      1.342918716072560025853732668111e-01
 117 #define p3      1.950702176409779831089963408886e-02
 118 #define p4      8.546740251667538090796227834289e-04
 119 #define q0      1.000000000000000444089209850062e+00
 120 #define q1      1.315850076960161985084596381057e+00
 121 #define q2      6.274644311862156431658377186977e-01
 122 #define q3      1.304706631926259297049597307705e-01
 123 #define q4      1.102815279606722369265536798366e-02
 124 #define q5      2.512690594856678929537585620579e-04
 125 #define q6      -1.003597548112371003358107325598e-06
 126 /*
 127  * Stirling's Formula, adjusted for equal-ripple. x in [6,Inf].
 128 */
 129 #define lns2pi  .418938533204672741780329736405
 130 #define pb0      8.33333333333333148296162562474e-02
 131 #define pb1     -2.77777777774548123579378966497e-03
 132 #define pb2      7.93650778754435631476282786423e-04
 133 #define pb3     -5.95235082566672847950717262222e-04
 134 #define pb4      8.41428560346653702135821806252e-04
 135 #define pb5     -1.89773526463879200348872089421e-03
 136 #define pb6      5.69394463439411649408050664078e-03
 137 #define pb7     -1.44705562421428915453880392761e-02
 138
 139 __pure double
 140 lgamma(double x)
 141 {
 142         double r;
 143
 144         signgam = 1;
 145         endian = ((*(int *) &one)) ? 1 : 0;
 146
 147         if (!finite(x))
 148                 if (_IEEE)
 149                         return (x+x);
 150                 else return (infnan(EDOM));
 151
 152         if (x > 6 + RIGHT) {
 153                 r = large_lgam(x);
 154                 return (r);
 155         } else if (x > 1e-16)
 156                 return (small_lgam(x));
 157         else if (x > -1e-16) {
 158                 if (x < 0)
 159                         signgam = -1, x = -x;
 160                 return (-log(x));
 161         } else
 162                 return (neg_lgam(x));
 163 }
 164
 165 static double
 166 large_lgam(double x)
 167 {
 168         double z, p, x1;
 169         int i;
 170         struct Double t, u, v;
 171         u = __log__D(x);
 172         u.a -= 1.0;
 173         if (x > 1e15) {
 174                 v.a = x - 0.5;
 175                 TRUNC(v.a);
 176                 v.b = (x - v.a) - 0.5;
 177                 t.a = u.a*v.a;
 178                 t.b = x*u.b + v.b*u.a;
 179                 if (_IEEE == 0 && !finite(t.a))
 180                         return(infnan(ERANGE));
 181                 return(t.a + t.b);
 182         }
 183         x1 = 1./x;
 184         z = x1*x1;
 185         p = pb0+z*(pb1+z*(pb2+z*(pb3+z*(pb4+z*(pb5+z*(pb6+z*pb7))))));
 186                                         /* error in approximation = 2.8e-19 */
 187
 188         p = p*x1;                       /* error < 2.3e-18 absolute */
 189                                         /* 0 < p < 1/64 (at x = 5.5) */
 190         v.a = x = x - 0.5;
 191         TRUNC(v.a);                     /* truncate v.a to 26 bits. */
 192         v.b = x - v.a;
 193         t.a = v.a*u.a;                  /* t = (x-.5)*(log(x)-1) */
 194         t.b = v.b*u.a + x*u.b;
 195         t.b += p; t.b += lns2pi;        /* return t + lns2pi + p */
 196         return (t.a + t.b);
 197 }
 198
 199 static double
 200 small_lgam(double x)
 201 {
 202         int x_int;
 203         double y, z, t, r = 0, p, q, hi, lo;
 204         struct Double rr;
 205         x_int = (x + .5);
 206         y = x - x_int;
 207         if (x_int <= 2 && y > RIGHT) {
 208                 t = y - x0;
 209                 y--; x_int++;
 210                 goto CONTINUE;
 211         } else if (y < -LEFT) {
 212                 t = y +(1.0-x0);
 213 CONTINUE:
 214                 z = t - x0_lo;
 215                 p = r0+z*(r1+z*(r2+z*(r3+z*(r4+z*r5))));
 216                 q = s0+z*(s1+z*(s2+z*(s3+z*s4)));
 217                 r = t*(z*(p/q) - x0_lo);
 218                 t = .5*t*t;
 219                 z = 1.0;
 220                 switch (x_int) {
 221                 case 6: z  = (y + 5);
 222                 case 5: z *= (y + 4);
 223                 case 4: z *= (y + 3);
 224                 case 3: z *= (y + 2);
 225                         rr = __log__D(z);
 226                         rr.b += a0_lo; rr.a += a0_hi;
 227                         return(((r+rr.b)+t+rr.a));
 228                 case 2: return(((r+a0_lo)+t)+a0_hi);
 229                 case 0: r -= log1p(x);
 230                 default: rr = __log__D(x);
 231                         rr.a -= a0_hi; rr.b -= a0_lo;
 232                         return(((r - rr.b) + t) - rr.a);
 233                 }
 234         } else {
 235                 p = p0+y*(p1+y*(p2+y*(p3+y*p4)));
 236                 q = q0+y*(q1+y*(q2+y*(q3+y*(q4+y*(q5+y*q6)))));
 237                 p = p*(y/q);
 238                 t = (double)(float) y;
 239                 z = y-t;
 240                 hi = (double)(float) (p+a1_hi);
 241                 lo = a1_hi - hi; lo += p; lo += a1_lo;
 242                 r = lo*y + z*hi;        /* q + r = y*(a0+p/q) */
 243                 q = hi*t;
 244                 z = 1.0;
 245                 switch (x_int) {
 246                 case 6: z  = (y + 5);
 247                 case 5: z *= (y + 4);
 248                 case 4: z *= (y + 3);
 249                 case 3: z *= (y + 2);
 250                         rr = __log__D(z);
 251                         r += rr.b; r += q;
 252                         return(rr.a + r);
 253                 case 2: return (q+ r);
 254                 case 0: rr = __log__D(x);
 255                         r -= rr.b; r -= log1p(x);
 256                         r += q; r-= rr.a;
 257                         return(r);
 258                 default: rr = __log__D(x);
 259                         r -= rr.b;
 260                         q -= rr.a;
 261                         return (r+q);
 262                 }
 263         }
 264 }
 265
 266 static double
 267 neg_lgam(double x)
 268 {
 269         int xi;
 270         double y, z, one = 1.0, zero = 0.0;
 271         extern double gamma();
 272
 273         /* avoid destructive cancellation as much as possible */
 274         if (x > -170) {
 275                 xi = x;
 276                 if (xi == x)
 277                         if (_IEEE)
 278                                 return(one/zero);
 279                         else
 280                                 return(infnan(ERANGE));
 281                 y = gamma(x);
 282                 if (y < 0)
 283                         y = -y, signgam = -1;
 284                 return (log(y));
 285         }
 286         z = floor(x + .5);
 287         if (z == x) {           /* convention: G(-(integer)) -> +Inf */
 288                 if (_IEEE)
 289                         return (one/zero);
 290                 else
 291                         return (infnan(ERANGE));
 292         }
 293         y = .5*ceil(x);
 294         if (y == ceil(y))
 295                 signgam = -1;
 296         x = -x;
 297         z = fabs(x + z);        /* 0 < z <= .5 */
 298         if (z < .25)
 299                 z = sin(M_PI*z);
 300         else
 301                 z = cos(M_PI*(0.5-z));
 302         z = log(M_PI/(z*x));
 303         y = large_lgam(x);
 304         return (z - y);
 305 }