2ee0b10b979b02811d964feabdc6d59964f12b35
[musl] / src / math / powl.c
1 /* origin: OpenBSD /usr/src/lib/libm/src/ld80/e_powl.c */
2 /*
3  * Copyright (c) 2008 Stephen L. Moshier <steve@moshier.net>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 /*                                                      powl.c
18  *
19  *      Power function, long double precision
20  *
21  *
22  * SYNOPSIS:
23  *
24  * long double x, y, z, powl();
25  *
26  * z = powl( x, y );
27  *
28  *
29  * DESCRIPTION:
30  *
31  * Computes x raised to the yth power.  Analytically,
32  *
33  *      x**y  =  exp( y log(x) ).
34  *
35  * Following Cody and Waite, this program uses a lookup table
36  * of 2**-i/32 and pseudo extended precision arithmetic to
37  * obtain several extra bits of accuracy in both the logarithm
38  * and the exponential.
39  *
40  *
41  * ACCURACY:
42  *
43  * The relative error of pow(x,y) can be estimated
44  * by   y dl ln(2),   where dl is the absolute error of
45  * the internally computed base 2 logarithm.  At the ends
46  * of the approximation interval the logarithm equal 1/32
47  * and its relative error is about 1 lsb = 1.1e-19.  Hence
48  * the predicted relative error in the result is 2.3e-21 y .
49  *
50  *                      Relative error:
51  * arithmetic   domain     # trials      peak         rms
52  *
53  *    IEEE     +-1000       40000      2.8e-18      3.7e-19
54  * .001 < x < 1000, with log(x) uniformly distributed.
55  * -1000 < y < 1000, y uniformly distributed.
56  *
57  *    IEEE     0,8700       60000      6.5e-18      1.0e-18
58  * 0.99 < x < 1.01, 0 < y < 8700, uniformly distributed.
59  *
60  *
61  * ERROR MESSAGES:
62  *
63  *   message         condition      value returned
64  * pow overflow     x**y > MAXNUM      INFINITY
65  * pow underflow   x**y < 1/MAXNUM       0.0
66  * pow domain      x<0 and y noninteger  0.0
67  *
68  */
69
70 #include "libm.h"
71
72 #if LDBL_MANT_DIG == 53 && LDBL_MAX_EXP == 1024
73 long double powl(long double x, long double y)
74 {
75         return pow(x, y);
76 }
77 #elif LDBL_MANT_DIG == 64 && LDBL_MAX_EXP == 16384
78
79 /* Table size */
80 #define NXT 32
81
82 /* log(1+x) =  x - .5x^2 + x^3 *  P(z)/Q(z)
83  * on the domain  2^(-1/32) - 1  <=  x  <=  2^(1/32) - 1
84  */
85 static const long double P[] = {
86  8.3319510773868690346226E-4L,
87  4.9000050881978028599627E-1L,
88  1.7500123722550302671919E0L,
89  1.4000100839971580279335E0L,
90 };
91 static const long double Q[] = {
92 /* 1.0000000000000000000000E0L,*/
93  5.2500282295834889175431E0L,
94  8.4000598057587009834666E0L,
95  4.2000302519914740834728E0L,
96 };
97 /* A[i] = 2^(-i/32), rounded to IEEE long double precision.
98  * If i is even, A[i] + B[i/2] gives additional accuracy.
99  */
100 static const long double A[33] = {
101  1.0000000000000000000000E0L,
102  9.7857206208770013448287E-1L,
103  9.5760328069857364691013E-1L,
104  9.3708381705514995065011E-1L,
105  9.1700404320467123175367E-1L,
106  8.9735453750155359320742E-1L,
107  8.7812608018664974155474E-1L,
108  8.5930964906123895780165E-1L,
109  8.4089641525371454301892E-1L,
110  8.2287773907698242225554E-1L,
111  8.0524516597462715409607E-1L,
112  7.8799042255394324325455E-1L,
113  7.7110541270397041179298E-1L,
114  7.5458221379671136985669E-1L,
115  7.3841307296974965571198E-1L,
116  7.2259040348852331001267E-1L,
117  7.0710678118654752438189E-1L,
118  6.9195494098191597746178E-1L,
119  6.7712777346844636413344E-1L,
120  6.6261832157987064729696E-1L,
121  6.4841977732550483296079E-1L,
122  6.3452547859586661129850E-1L,
123  6.2092890603674202431705E-1L,
124  6.0762367999023443907803E-1L,
125  5.9460355750136053334378E-1L,
126  5.8186242938878875689693E-1L,
127  5.6939431737834582684856E-1L,
128  5.5719337129794626814472E-1L,
129  5.4525386633262882960438E-1L,
130  5.3357020033841180906486E-1L,
131  5.2213689121370692017331E-1L,
132  5.1094857432705833910408E-1L,
133  5.0000000000000000000000E-1L,
134 };
135 static const long double B[17] = {
136  0.0000000000000000000000E0L,
137  2.6176170809902549338711E-20L,
138 -1.0126791927256478897086E-20L,
139  1.3438228172316276937655E-21L,
140  1.2207982955417546912101E-20L,
141 -6.3084814358060867200133E-21L,
142  1.3164426894366316434230E-20L,
143 -1.8527916071632873716786E-20L,
144  1.8950325588932570796551E-20L,
145  1.5564775779538780478155E-20L,
146  6.0859793637556860974380E-21L,
147 -2.0208749253662532228949E-20L,
148  1.4966292219224761844552E-20L,
149  3.3540909728056476875639E-21L,
150 -8.6987564101742849540743E-22L,
151 -1.2327176863327626135542E-20L,
152  0.0000000000000000000000E0L,
153 };
154
155 /* 2^x = 1 + x P(x),
156  * on the interval -1/32 <= x <= 0
157  */
158 static const long double R[] = {
159  1.5089970579127659901157E-5L,
160  1.5402715328927013076125E-4L,
161  1.3333556028915671091390E-3L,
162  9.6181291046036762031786E-3L,
163  5.5504108664798463044015E-2L,
164  2.4022650695910062854352E-1L,
165  6.9314718055994530931447E-1L,
166 };
167
168 #define douba(k) A[k]
169 #define doubb(k) B[k]
170 #define MEXP (NXT*16384.0L)
171 /* The following if denormal numbers are supported, else -MEXP: */
172 #define MNEXP (-NXT*(16384.0L+64.0L))
173 /* log2(e) - 1 */
174 #define LOG2EA 0.44269504088896340735992L
175
176 #define F W
177 #define Fa Wa
178 #define Fb Wb
179 #define G W
180 #define Ga Wa
181 #define Gb u
182 #define H W
183 #define Ha Wb
184 #define Hb Wb
185
186 static const long double MAXLOGL = 1.1356523406294143949492E4L;
187 static const long double MINLOGL = -1.13994985314888605586758E4L;
188 static const long double LOGE2L = 6.9314718055994530941723E-1L;
189 static const long double huge = 0x1p10000L;
190 /* XXX Prevent gcc from erroneously constant folding this. */
191 static const volatile long double twom10000 = 0x1p-10000L;
192
193 static long double reducl(long double);
194 static long double powil(long double, int);
195
196 long double powl(long double x, long double y)
197 {
198         /* double F, Fa, Fb, G, Ga, Gb, H, Ha, Hb */
199         int i, nflg, iyflg, yoddint;
200         long e;
201         volatile long double z=0;
202         long double w=0, W=0, Wa=0, Wb=0, ya=0, yb=0, u=0;
203
204         /* make sure no invalid exception is raised by nan comparision */
205         if (isnan(x)) {
206                 if (!isnan(y) && y == 0.0)
207                         return 1.0;
208                 return x;
209         }
210         if (isnan(y)) {
211                 if (x == 1.0)
212                         return 1.0;
213                 return y;
214         }
215         if (x == 1.0)
216                 return 1.0; /* 1**y = 1, even if y is nan */
217         if (x == -1.0 && !isfinite(y))
218                 return 1.0; /* -1**inf = 1 */
219         if (y == 0.0)
220                 return 1.0; /* x**0 = 1, even if x is nan */
221         if (y == 1.0)
222                 return x;
223         if (y >= LDBL_MAX) {
224                 if (x > 1.0 || x < -1.0)
225                         return INFINITY;
226                 if (x != 0.0)
227                         return 0.0;
228         }
229         if (y <= -LDBL_MAX) {
230                 if (x > 1.0 || x < -1.0)
231                         return 0.0;
232                 if (x != 0.0)
233                         return INFINITY;
234         }
235         if (x >= LDBL_MAX) {
236                 if (y > 0.0)
237                         return INFINITY;
238                 return 0.0;
239         }
240
241         w = floorl(y);
242
243         /* Set iyflg to 1 if y is an integer. */
244         iyflg = 0;
245         if (w == y)
246                 iyflg = 1;
247
248         /* Test for odd integer y. */
249         yoddint = 0;
250         if (iyflg) {
251                 ya = fabsl(y);
252                 ya = floorl(0.5 * ya);
253                 yb = 0.5 * fabsl(w);
254                 if( ya != yb )
255                         yoddint = 1;
256         }
257
258         if (x <= -LDBL_MAX) {
259                 if (y > 0.0) {
260                         if (yoddint)
261                                 return -INFINITY;
262                         return INFINITY;
263                 }
264                 if (y < 0.0) {
265                         if (yoddint)
266                                 return -0.0;
267                         return 0.0;
268                 }
269         }
270         nflg = 0; /* (x<0)**(odd int) */
271         if (x <= 0.0) {
272                 if (x == 0.0) {
273                         if (y < 0.0) {
274                                 if (signbit(x) && yoddint)
275                                         /* (-0.0)**(-odd int) = -inf, divbyzero */
276                                         return -1.0/0.0;
277                                 /* (+-0.0)**(negative) = inf, divbyzero */
278                                 return 1.0/0.0;
279                         }
280                         if (signbit(x) && yoddint)
281                                 return -0.0;
282                         return 0.0;
283                 }
284                 if (iyflg == 0)
285                         return (x - x) / (x - x); /* (x<0)**(non-int) is NaN */
286                 /* (x<0)**(integer) */
287                 if (yoddint)
288                         nflg = 1; /* negate result */
289                 x = -x;
290         }
291         /* (+integer)**(integer)  */
292         if (iyflg && floorl(x) == x && fabsl(y) < 32768.0) {
293                 w = powil(x, (int)y);
294                 return nflg ? -w : w;
295         }
296
297         /* separate significand from exponent */
298         x = frexpl(x, &i);
299         e = i;
300
301         /* find significand in antilog table A[] */
302         i = 1;
303         if (x <= douba(17))
304                 i = 17;
305         if (x <= douba(i+8))
306                 i += 8;
307         if (x <= douba(i+4))
308                 i += 4;
309         if (x <= douba(i+2))
310                 i += 2;
311         if (x >= douba(1))
312                 i = -1;
313         i += 1;
314
315         /* Find (x - A[i])/A[i]
316          * in order to compute log(x/A[i]):
317          *
318          * log(x) = log( a x/a ) = log(a) + log(x/a)
319          *
320          * log(x/a) = log(1+v),  v = x/a - 1 = (x-a)/a
321          */
322         x -= douba(i);
323         x -= doubb(i/2);
324         x /= douba(i);
325
326         /* rational approximation for log(1+v):
327          *
328          * log(1+v)  =  v  -  v**2/2  +  v**3 P(v) / Q(v)
329          */
330         z = x*x;
331         w = x * (z * __polevll(x, P, 3) / __p1evll(x, Q, 3));
332         w = w - 0.5*z;
333
334         /* Convert to base 2 logarithm:
335          * multiply by log2(e) = 1 + LOG2EA
336          */
337         z = LOG2EA * w;
338         z += w;
339         z += LOG2EA * x;
340         z += x;
341
342         /* Compute exponent term of the base 2 logarithm. */
343         w = -i / NXT;
344         w += e;
345         /* Now base 2 log of x is w + z. */
346
347         /* Multiply base 2 log by y, in extended precision. */
348
349         /* separate y into large part ya
350          * and small part yb less than 1/NXT
351          */
352         ya = reducl(y);
353         yb = y - ya;
354
355         /* (w+z)(ya+yb)
356          * = w*ya + w*yb + z*y
357          */
358         F = z * y  +  w * yb;
359         Fa = reducl(F);
360         Fb = F - Fa;
361
362         G = Fa + w * ya;
363         Ga = reducl(G);
364         Gb = G - Ga;
365
366         H = Fb + Gb;
367         Ha = reducl(H);
368         w = (Ga + Ha) * NXT;
369
370         /* Test the power of 2 for overflow */
371         if (w > MEXP)
372                 return huge * huge;  /* overflow */
373         if (w < MNEXP)
374                 return twom10000 * twom10000;  /* underflow */
375
376         e = w;
377         Hb = H - Ha;
378
379         if (Hb > 0.0) {
380                 e += 1;
381                 Hb -= 1.0/NXT;  /*0.0625L;*/
382         }
383
384         /* Now the product y * log2(x)  =  Hb + e/NXT.
385          *
386          * Compute base 2 exponential of Hb,
387          * where -0.0625 <= Hb <= 0.
388          */
389         z = Hb * __polevll(Hb, R, 6);  /*  z = 2**Hb - 1  */
390
391         /* Express e/NXT as an integer plus a negative number of (1/NXT)ths.
392          * Find lookup table entry for the fractional power of 2.
393          */
394         if (e < 0)
395                 i = 0;
396         else
397                 i = 1;
398         i = e/NXT + i;
399         e = NXT*i - e;
400         w = douba(e);
401         z = w * z;  /*  2**-e * ( 1 + (2**Hb-1) )  */
402         z = z + w;
403         z = scalbnl(z, i);  /* multiply by integer power of 2 */
404
405         if (nflg)
406                 z = -z;
407         return z;
408 }
409
410
411 /* Find a multiple of 1/NXT that is within 1/NXT of x. */
412 static long double reducl(long double x)
413 {
414         long double t;
415
416         t = x * NXT;
417         t = floorl(t);
418         t = t / NXT;
419         return t;
420 }
421
422 /*
423  *      Positive real raised to integer power, long double precision
424  *
425  *
426  * SYNOPSIS:
427  *
428  * long double x, y, powil();
429  * int n;
430  *
431  * y = powil( x, n );
432  *
433  *
434  * DESCRIPTION:
435  *
436  * Returns argument x>0 raised to the nth power.
437  * The routine efficiently decomposes n as a sum of powers of
438  * two. The desired power is a product of two-to-the-kth
439  * powers of x.  Thus to compute the 32767 power of x requires
440  * 28 multiplications instead of 32767 multiplications.
441  *
442  *
443  * ACCURACY:
444  *
445  *                      Relative error:
446  * arithmetic   x domain   n domain  # trials      peak         rms
447  *    IEEE     .001,1000  -1022,1023  50000       4.3e-17     7.8e-18
448  *    IEEE        1,2     -1022,1023  20000       3.9e-17     7.6e-18
449  *    IEEE     .99,1.01     0,8700    10000       3.6e-16     7.2e-17
450  *
451  * Returns MAXNUM on overflow, zero on underflow.
452  */
453
454 static long double powil(long double x, int nn)
455 {
456         long double ww, y;
457         long double s;
458         int n, e, sign, lx;
459
460         if (nn == 0)
461                 return 1.0;
462
463         if (nn < 0) {
464                 sign = -1;
465                 n = -nn;
466         } else {
467                 sign = 1;
468                 n = nn;
469         }
470
471         /* Overflow detection */
472
473         /* Calculate approximate logarithm of answer */
474         s = x;
475         s = frexpl( s, &lx);
476         e = (lx - 1)*n;
477         if ((e == 0) || (e > 64) || (e < -64)) {
478                 s = (s - 7.0710678118654752e-1L) / (s +  7.0710678118654752e-1L);
479                 s = (2.9142135623730950L * s - 0.5 + lx) * nn * LOGE2L;
480         } else {
481                 s = LOGE2L * e;
482         }
483
484         if (s > MAXLOGL)
485                 return huge * huge;  /* overflow */
486
487         if (s < MINLOGL)
488                 return twom10000 * twom10000;  /* underflow */
489         /* Handle tiny denormal answer, but with less accuracy
490          * since roundoff error in 1.0/x will be amplified.
491          * The precise demarcation should be the gradual underflow threshold.
492          */
493         if (s < -MAXLOGL+2.0) {
494                 x = 1.0/x;
495                 sign = -sign;
496         }
497
498         /* First bit of the power */
499         if (n & 1)
500                 y = x;
501         else
502                 y = 1.0;
503
504         ww = x;
505         n >>= 1;
506         while (n) {
507                 ww = ww * ww;   /* arg to the 2-to-the-kth power */
508                 if (n & 1)     /* if that bit is set, then include in product */
509                         y *= ww;
510                 n >>= 1;
511         }
512
513         if (sign < 0)
514                 y = 1.0/y;
515         return y;
516 }
517
518 #endif