lib/libm/src/b_tgamma.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  * @(#)gamma.c  8.1 (Berkeley) 6/4/93
  34  * FreeBSD SVN: 176449 (2008-02-22)
  35  */
  36
  37 /*
  38  * This code by P. McIlroy, Oct 1992;
  39  *
  40  * The financial support of UUNET Communications Services is greatfully
  41  * acknowledged.
  42  */
  43
  44 #include <math.h>
  45 #include "mathimpl.h"
  46
  47 /* METHOD:
  48  * x < 0: Use reflection formula, G(x) = pi/(sin(pi*x)*x*G(x))
  49  *      At negative integers, return NaN and raise invalid.
  50  *
  51  * x < 6.5:
  52  *      Use argument reduction G(x+1) = xG(x) to reach the
  53  *      range [1.066124,2.066124].  Use a rational
  54  *      approximation centered at the minimum (x0+1) to
  55  *      ensure monotonicity.
  56  *
  57  * x >= 6.5: Use the asymptotic approximation (Stirling's formula)
  58  *      adjusted for equal-ripples:
  59  *
  60  *      log(G(x)) ~= (x-.5)*(log(x)-1) + .5(log(2*pi)-1) + 1/x*P(1/(x*x))
  61  *
  62  *      Keep extra precision in multiplying (x-.5)(log(x)-1), to
  63  *      avoid premature round-off.
  64  *
  65  * Special values:
  66  *      -Inf:                   return NaN and raise invalid;
  67  *      negative integer:       return NaN and raise invalid;
  68  *      other x ~< 177.79:      return +-0 and raise underflow;
  69  *      +-0:                    return +-Inf and raise divide-by-zero;
  70  *      finite x ~> 171.63:     return +Inf and raise overflow;
  71  *      +Inf:                   return +Inf;
  72  *      NaN:                    return NaN.
  73  *
  74  * Accuracy: tgamma(x) is accurate to within
  75  *      x > 0:  error provably < 0.9ulp.
  76  *      Maximum observed in 1,000,000 trials was .87ulp.
  77  *      x < 0:
  78  *      Maximum observed error < 4ulp in 1,000,000 trials.
  79  */
  80
  81 static double neg_gam(double);
  82 static double small_gam(double);
  83 static double smaller_gam(double);
  84 static struct Double large_gam(double);
  85 static struct Double ratfun_gam(double, double);
  86
  87 /*
  88  * Rational approximation, A0 + x*x*P(x)/Q(x), on the interval
  89  * [1.066.., 2.066..] accurate to 4.25e-19.
  90  */
  91 #define LEFT -.3955078125       /* left boundary for rat. approx */
  92 #define x0 .461632144968362356785       /* xmin - 1 */
  93
  94 #define a0_hi 0.88560319441088874992
  95 #define a0_lo -.00000000000000004996427036469019695
  96 #define P0       6.21389571821820863029017800727e-01
  97 #define P1       2.65757198651533466104979197553e-01
  98 #define P2       5.53859446429917461063308081748e-03
  99 #define P3       1.38456698304096573887145282811e-03
 100 #define P4       2.40659950032711365819348969808e-03
 101 #define Q0       1.45019531250000000000000000000e+00
 102 #define Q1       1.06258521948016171343454061571e+00
 103 #define Q2      -2.07474561943859936441469926649e-01
 104 #define Q3      -1.46734131782005422506287573015e-01
 105 #define Q4       3.07878176156175520361557573779e-02
 106 #define Q5       5.12449347980666221336054633184e-03
 107 #define Q6      -1.76012741431666995019222898833e-03
 108 #define Q7       9.35021023573788935372153030556e-05
 109 #define Q8       6.13275507472443958924745652239e-06
 110 /*
 111  * Constants for large x approximation (x in [6, Inf])
 112  * (Accurate to 2.8*10^-19 absolute)
 113  */
 114 #define lns2pi_hi 0.418945312500000
 115 #define lns2pi_lo -.000006779295327258219670263595
 116 #define Pa0      8.33333333333333148296162562474e-02
 117 #define Pa1     -2.77777777774548123579378966497e-03
 118 #define Pa2      7.93650778754435631476282786423e-04
 119 #define Pa3     -5.95235082566672847950717262222e-04
 120 #define Pa4      8.41428560346653702135821806252e-04
 121 #define Pa5     -1.89773526463879200348872089421e-03
 122 #define Pa6      5.69394463439411649408050664078e-03
 123 #define Pa7     -1.44705562421428915453880392761e-02
 124
 125 static const double zero = 0., one = 1.0, tiny = 1e-300;
 126
 127 double
 128 tgamma(x)
 129         double x;
 130 {
 131         struct Double u;
 132
 133         if (x >= 6) {
 134                 if(x > 171.63)
 135                         return (x / zero);
 136                 u = large_gam(x);
 137                 return(__exp__D(u.a, u.b));
 138         } else if (x >= 1.0 + LEFT + x0)
 139                 return (small_gam(x));
 140         else if (x > 1.e-17)
 141                 return (smaller_gam(x));
 142         else if (x > -1.e-17) {
 143                 if (x != 0.0)
 144                         u.a = one - tiny;       /* raise inexact */
 145                 return (one/x);
 146         } else if (!finite(x))
 147                 return (x - x);         /* x is NaN or -Inf */
 148         else
 149                 return (neg_gam(x));
 150 }
 151 /*
 152  * Accurate to max(ulp(1/128) absolute, 2^-66 relative) error.
 153  */
 154 static struct Double
 155 large_gam(x)
 156         double x;
 157 {
 158         double z, p;
 159         struct Double t, u, v;
 160
 161         z = one/(x*x);
 162         p = Pa0+z*(Pa1+z*(Pa2+z*(Pa3+z*(Pa4+z*(Pa5+z*(Pa6+z*Pa7))))));
 163         p = p/x;
 164
 165         u = __log__D(x);
 166         u.a -= one;
 167         v.a = (x -= .5);
 168         TRUNC(v.a);
 169         v.b = x - v.a;
 170         t.a = v.a*u.a;                  /* t = (x-.5)*(log(x)-1) */
 171         t.b = v.b*u.a + x*u.b;
 172         /* return t.a + t.b + lns2pi_hi + lns2pi_lo + p */
 173         t.b += lns2pi_lo; t.b += p;
 174         u.a = lns2pi_hi + t.b; u.a += t.a;
 175         u.b = t.a - u.a;
 176         u.b += lns2pi_hi; u.b += t.b;
 177         return (u);
 178 }
 179 /*
 180  * Good to < 1 ulp.  (provably .90 ulp; .87 ulp on 1,000,000 runs.)
 181  * It also has correct monotonicity.
 182  */
 183 static double
 184 small_gam(x)
 185         double x;
 186 {
 187         double y, ym1, t;
 188         struct Double yy, r;
 189         y = x - one;
 190         ym1 = y - one;
 191         if (y <= 1.0 + (LEFT + x0)) {
 192                 yy = ratfun_gam(y - x0, 0);
 193                 return (yy.a + yy.b);
 194         }
 195         r.a = y;
 196         TRUNC(r.a);
 197         yy.a = r.a - one;
 198         y = ym1;
 199         yy.b = r.b = y - yy.a;
 200         /* Argument reduction: G(x+1) = x*G(x) */
 201         for (ym1 = y-one; ym1 > LEFT + x0; y = ym1--, yy.a--) {
 202                 t = r.a*yy.a;
 203                 r.b = r.a*yy.b + y*r.b;
 204                 r.a = t;
 205                 TRUNC(r.a);
 206                 r.b += (t - r.a);
 207         }
 208         /* Return r*tgamma(y). */
 209         yy = ratfun_gam(y - x0, 0);
 210         y = r.b*(yy.a + yy.b) + r.a*yy.b;
 211         y += yy.a*r.a;
 212         return (y);
 213 }
 214 /*
 215  * Good on (0, 1+x0+LEFT].  Accurate to 1ulp.
 216  */
 217 static double
 218 smaller_gam(x)
 219         double x;
 220 {
 221         double t, d;
 222         struct Double r, xx;
 223         if (x < x0 + LEFT) {
 224                 t = x, TRUNC(t);
 225                 d = (t+x)*(x-t);
 226                 t *= t;
 227                 xx.a = (t + x), TRUNC(xx.a);
 228                 xx.b = x - xx.a; xx.b += t; xx.b += d;
 229                 t = (one-x0); t += x;
 230                 d = (one-x0); d -= t; d += x;
 231                 x = xx.a + xx.b;
 232         } else {
 233                 xx.a =  x, TRUNC(xx.a);
 234                 xx.b = x - xx.a;
 235                 t = x - x0;
 236                 d = (-x0 -t); d += x;
 237         }
 238         r = ratfun_gam(t, d);
 239         d = r.a/x, TRUNC(d);
 240         r.a -= d*xx.a; r.a -= d*xx.b; r.a += r.b;
 241         return (d + r.a/x);
 242 }
 243 /*
 244  * returns (z+c)^2 * P(z)/Q(z) + a0
 245  */
 246 static struct Double
 247 ratfun_gam(z, c)
 248         double z, c;
 249 {
 250         double p, q;
 251         struct Double r, t;
 252
 253         q = Q0 +z*(Q1+z*(Q2+z*(Q3+z*(Q4+z*(Q5+z*(Q6+z*(Q7+z*Q8)))))));
 254         p = P0 + z*(P1 + z*(P2 + z*(P3 + z*P4)));
 255
 256         /* return r.a + r.b = a0 + (z+c)^2*p/q, with r.a truncated to 26 bits. */
 257         p = p/q;
 258         t.a = z, TRUNC(t.a);            /* t ~= z + c */
 259         t.b = (z - t.a) + c;
 260         t.b *= (t.a + z);
 261         q = (t.a *= t.a);               /* t = (z+c)^2 */
 262         TRUNC(t.a);
 263         t.b += (q - t.a);
 264         r.a = p, TRUNC(r.a);            /* r = P/Q */
 265         r.b = p - r.a;
 266         t.b = t.b*p + t.a*r.b + a0_lo;
 267         t.a *= r.a;                     /* t = (z+c)^2*(P/Q) */
 268         r.a = t.a + a0_hi, TRUNC(r.a);
 269         r.b = ((a0_hi-r.a) + t.a) + t.b;
 270         return (r);                     /* r = a0 + t */
 271 }
 272
 273 static double
 274 neg_gam(x)
 275         double x;
 276 {
 277         int sgn = 1;
 278         struct Double lg, lsine;
 279         double y, z;
 280
 281         y = ceil(x);
 282         if (y == x)             /* Negative integer. */
 283                 return ((x - x) / zero);
 284         z = y - x;
 285         if (z > 0.5)
 286                 z = one - z;
 287         y = 0.5 * y;
 288         if (y == ceil(y))
 289                 sgn = -1;
 290         if (z < .25)
 291                 z = sin(M_PI*z);
 292         else
 293                 z = cos(M_PI*(0.5-z));
 294         /* Special case: G(1-x) = Inf; G(x) may be nonzero. */
 295         if (x < -170) {
 296                 if (x < -190)
 297                         return ((double)sgn*tiny*tiny);
 298                 y = one - x;            /* exact: 128 < |x| < 255 */
 299                 lg = large_gam(y);
 300                 lsine = __log__D(M_PI/z);       /* = TRUNC(log(u)) + small */
 301                 lg.a -= lsine.a;                /* exact (opposite signs) */
 302                 lg.b -= lsine.b;
 303                 y = -(lg.a + lg.b);
 304                 z = (y + lg.a) + lg.b;
 305                 y = __exp__D(y, z);
 306                 if (sgn < 0) y = -y;
 307                 return (y);
 308         }
 309         y = one-x;
 310         if (one-y == x)
 311                 y = tgamma(y);
 312         else            /* 1-x is inexact */
 313                 y = -x*tgamma(-x);
 314         if (sgn < 0) y = -y;
 315         return (M_PI / (y*z));
 316 }