xref: /netbsd-src/lib/libm/noieee_src/n_gamma.c (revision 76dfffe33547c37f8bdd446e3e4ab0f3c16cea4b)
1 /*      $NetBSD: n_gamma.c,v 1.1 1995/10/10 23:36:50 ragge Exp $ */
2 /*-
3  * Copyright (c) 1992, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by the University of
17  *	California, Berkeley and its contributors.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef lint
36 static char sccsid[] = "@(#)gamma.c	8.1 (Berkeley) 6/4/93";
37 #endif /* not lint */
38 
39 /*
40  * This code by P. McIlroy, Oct 1992;
41  *
42  * The financial support of UUNET Communications Services is greatfully
43  * acknowledged.
44  */
45 
46 #include <math.h>
47 #include "mathimpl.h"
48 #include <errno.h>
49 
50 /* METHOD:
51  * x < 0: Use reflection formula, G(x) = pi/(sin(pi*x)*x*G(x))
52  * 	At negative integers, return +Inf, and set errno.
53  *
54  * x < 6.5:
55  *	Use argument reduction G(x+1) = xG(x) to reach the
56  *	range [1.066124,2.066124].  Use a rational
57  *	approximation centered at the minimum (x0+1) to
58  *	ensure monotonicity.
59  *
60  * x >= 6.5: Use the asymptotic approximation (Stirling's formula)
61  *	adjusted for equal-ripples:
62  *
63  *	log(G(x)) ~= (x-.5)*(log(x)-1) + .5(log(2*pi)-1) + 1/x*P(1/(x*x))
64  *
65  *	Keep extra precision in multiplying (x-.5)(log(x)-1), to
66  *	avoid premature round-off.
67  *
68  * Special values:
69  *	non-positive integer:	Set overflow trap; return +Inf;
70  *	x > 171.63:		Set overflow trap; return +Inf;
71  *	NaN: 			Set invalid trap;  return NaN
72  *
73  * Accuracy: Gamma(x) is accurate to within
74  *	x > 0:  error provably < 0.9ulp.
75  *	Maximum observed in 1,000,000 trials was .87ulp.
76  *	x < 0:
77  *	Maximum observed error < 4ulp in 1,000,000 trials.
78  */
79 
80 static double neg_gam __P((double));
81 static double small_gam __P((double));
82 static double smaller_gam __P((double));
83 static struct Double large_gam __P((double));
84 static struct Double ratfun_gam __P((double, double));
85 
86 /*
87  * Rational approximation, A0 + x*x*P(x)/Q(x), on the interval
88  * [1.066.., 2.066..] accurate to 4.25e-19.
89  */
90 #define LEFT -.3955078125	/* left boundary for rat. approx */
91 #define x0 .461632144968362356785	/* xmin - 1 */
92 
93 #define a0_hi 0.88560319441088874992
94 #define a0_lo -.00000000000000004996427036469019695
95 #define P0	 6.21389571821820863029017800727e-01
96 #define P1	 2.65757198651533466104979197553e-01
97 #define P2	 5.53859446429917461063308081748e-03
98 #define P3	 1.38456698304096573887145282811e-03
99 #define P4	 2.40659950032711365819348969808e-03
100 #define Q0	 1.45019531250000000000000000000e+00
101 #define Q1	 1.06258521948016171343454061571e+00
102 #define Q2	-2.07474561943859936441469926649e-01
103 #define Q3	-1.46734131782005422506287573015e-01
104 #define Q4	 3.07878176156175520361557573779e-02
105 #define Q5	 5.12449347980666221336054633184e-03
106 #define Q6	-1.76012741431666995019222898833e-03
107 #define Q7	 9.35021023573788935372153030556e-05
108 #define Q8	 6.13275507472443958924745652239e-06
109 /*
110  * Constants for large x approximation (x in [6, Inf])
111  * (Accurate to 2.8*10^-19 absolute)
112  */
113 #define lns2pi_hi 0.418945312500000
114 #define lns2pi_lo -.000006779295327258219670263595
115 #define Pa0	 8.33333333333333148296162562474e-02
116 #define Pa1	-2.77777777774548123579378966497e-03
117 #define Pa2	 7.93650778754435631476282786423e-04
118 #define Pa3	-5.95235082566672847950717262222e-04
119 #define Pa4	 8.41428560346653702135821806252e-04
120 #define Pa5	-1.89773526463879200348872089421e-03
121 #define Pa6	 5.69394463439411649408050664078e-03
122 #define Pa7	-1.44705562421428915453880392761e-02
123 
124 static const double zero = 0., one = 1.0, tiny = 1e-300;
125 static int endian;
126 /*
127  * TRUNC sets trailing bits in a floating-point number to zero.
128  * is a temporary variable.
129  */
130 #if defined(vax) || defined(tahoe)
131 #define _IEEE		0
132 #define TRUNC(x)	x = (double) (float) (x)
133 #else
134 #define _IEEE		1
135 #define TRUNC(x)	*(((int *) &x) + endian) &= 0xf8000000
136 #define infnan(x)	0.0
137 #endif
138 
139 double
140 gamma(x)
141 	double x;
142 {
143 	struct Double u;
144 	endian = (*(int *) &one) ? 1 : 0;
145 
146 	if (x >= 6) {
147 		if(x > 171.63)
148 			return(one/zero);
149 		u = large_gam(x);
150 		return(__exp__D(u.a, u.b));
151 	} else if (x >= 1.0 + LEFT + x0)
152 		return (small_gam(x));
153 	else if (x > 1.e-17)
154 		return (smaller_gam(x));
155 	else if (x > -1.e-17) {
156 		if (x == 0.0)
157 			if (!_IEEE) return (infnan(ERANGE));
158 			else return (one/x);
159 		one+1e-20;		/* Raise inexact flag. */
160 		return (one/x);
161 	} else if (!finite(x)) {
162 		if (_IEEE)		/* x = NaN, -Inf */
163 			return (x*x);
164 		else
165 			return (infnan(EDOM));
166 	 } else
167 		return (neg_gam(x));
168 }
169 /*
170  * Accurate to max(ulp(1/128) absolute, 2^-66 relative) error.
171  */
172 static struct Double
173 large_gam(x)
174 	double x;
175 {
176 	double z, p;
177 	int i;
178 	struct Double t, u, v;
179 
180 	z = one/(x*x);
181 	p = Pa0+z*(Pa1+z*(Pa2+z*(Pa3+z*(Pa4+z*(Pa5+z*(Pa6+z*Pa7))))));
182 	p = p/x;
183 
184 	u = __log__D(x);
185 	u.a -= one;
186 	v.a = (x -= .5);
187 	TRUNC(v.a);
188 	v.b = x - v.a;
189 	t.a = v.a*u.a;			/* t = (x-.5)*(log(x)-1) */
190 	t.b = v.b*u.a + x*u.b;
191 	/* return t.a + t.b + lns2pi_hi + lns2pi_lo + p */
192 	t.b += lns2pi_lo; t.b += p;
193 	u.a = lns2pi_hi + t.b; u.a += t.a;
194 	u.b = t.a - u.a;
195 	u.b += lns2pi_hi; u.b += t.b;
196 	return (u);
197 }
198 /*
199  * Good to < 1 ulp.  (provably .90 ulp; .87 ulp on 1,000,000 runs.)
200  * It also has correct monotonicity.
201  */
202 static double
203 small_gam(x)
204 	double x;
205 {
206 	double y, ym1, t, x1;
207 	struct Double yy, r;
208 	y = x - one;
209 	ym1 = y - one;
210 	if (y <= 1.0 + (LEFT + x0)) {
211 		yy = ratfun_gam(y - x0, 0);
212 		return (yy.a + yy.b);
213 	}
214 	r.a = y;
215 	TRUNC(r.a);
216 	yy.a = r.a - one;
217 	y = ym1;
218 	yy.b = r.b = y - yy.a;
219 	/* Argument reduction: G(x+1) = x*G(x) */
220 	for (ym1 = y-one; ym1 > LEFT + x0; y = ym1--, yy.a--) {
221 		t = r.a*yy.a;
222 		r.b = r.a*yy.b + y*r.b;
223 		r.a = t;
224 		TRUNC(r.a);
225 		r.b += (t - r.a);
226 	}
227 	/* Return r*gamma(y). */
228 	yy = ratfun_gam(y - x0, 0);
229 	y = r.b*(yy.a + yy.b) + r.a*yy.b;
230 	y += yy.a*r.a;
231 	return (y);
232 }
233 /*
234  * Good on (0, 1+x0+LEFT].  Accurate to 1ulp.
235  */
236 static double
237 smaller_gam(x)
238 	double x;
239 {
240 	double t, d;
241 	struct Double r, xx;
242 	if (x < x0 + LEFT) {
243 		t = x, TRUNC(t);
244 		d = (t+x)*(x-t);
245 		t *= t;
246 		xx.a = (t + x), TRUNC(xx.a);
247 		xx.b = x - xx.a; xx.b += t; xx.b += d;
248 		t = (one-x0); t += x;
249 		d = (one-x0); d -= t; d += x;
250 		x = xx.a + xx.b;
251 	} else {
252 		xx.a =  x, TRUNC(xx.a);
253 		xx.b = x - xx.a;
254 		t = x - x0;
255 		d = (-x0 -t); d += x;
256 	}
257 	r = ratfun_gam(t, d);
258 	d = r.a/x, TRUNC(d);
259 	r.a -= d*xx.a; r.a -= d*xx.b; r.a += r.b;
260 	return (d + r.a/x);
261 }
262 /*
263  * returns (z+c)^2 * P(z)/Q(z) + a0
264  */
265 static struct Double
266 ratfun_gam(z, c)
267 	double z, c;
268 {
269 	int i;
270 	double p, q;
271 	struct Double r, t;
272 
273 	q = Q0 +z*(Q1+z*(Q2+z*(Q3+z*(Q4+z*(Q5+z*(Q6+z*(Q7+z*Q8)))))));
274 	p = P0 + z*(P1 + z*(P2 + z*(P3 + z*P4)));
275 
276 	/* return r.a + r.b = a0 + (z+c)^2*p/q, with r.a truncated to 26 bits. */
277 	p = p/q;
278 	t.a = z, TRUNC(t.a);		/* t ~= z + c */
279 	t.b = (z - t.a) + c;
280 	t.b *= (t.a + z);
281 	q = (t.a *= t.a);		/* t = (z+c)^2 */
282 	TRUNC(t.a);
283 	t.b += (q - t.a);
284 	r.a = p, TRUNC(r.a);		/* r = P/Q */
285 	r.b = p - r.a;
286 	t.b = t.b*p + t.a*r.b + a0_lo;
287 	t.a *= r.a;			/* t = (z+c)^2*(P/Q) */
288 	r.a = t.a + a0_hi, TRUNC(r.a);
289 	r.b = ((a0_hi-r.a) + t.a) + t.b;
290 	return (r);			/* r = a0 + t */
291 }
292 
293 static double
294 neg_gam(x)
295 	double x;
296 {
297 	int sgn = 1;
298 	struct Double lg, lsine;
299 	double y, z;
300 
301 	y = floor(x + .5);
302 	if (y == x)		/* Negative integer. */
303 		if(!_IEEE)
304 			return (infnan(ERANGE));
305 		else
306 			return (one/zero);
307 	z = fabs(x - y);
308 	y = .5*ceil(x);
309 	if (y == ceil(y))
310 		sgn = -1;
311 	if (z < .25)
312 		z = sin(M_PI*z);
313 	else
314 		z = cos(M_PI*(0.5-z));
315 	/* Special case: G(1-x) = Inf; G(x) may be nonzero. */
316 	if (x < -170) {
317 		if (x < -190)
318 			return ((double)sgn*tiny*tiny);
319 		y = one - x;		/* exact: 128 < |x| < 255 */
320 		lg = large_gam(y);
321 		lsine = __log__D(M_PI/z);	/* = TRUNC(log(u)) + small */
322 		lg.a -= lsine.a;		/* exact (opposite signs) */
323 		lg.b -= lsine.b;
324 		y = -(lg.a + lg.b);
325 		z = (y + lg.a) + lg.b;
326 		y = __exp__D(y, z);
327 		if (sgn < 0) y = -y;
328 		return (y);
329 	}
330 	y = one-x;
331 	if (one-y == x)
332 		y = gamma(y);
333 	else		/* 1-x is inexact */
334 		y = -x*gamma(-x);
335 	if (sgn < 0) y = -y;
336 	return (M_PI / (y*z));
337 }
338