math: add fma TODO comments about the underflow issue
[oweals/musl.git] / src / math / log10.c
1 /* origin: FreeBSD /usr/src/lib/msun/src/e_log10.c */
2 /*
3  * ====================================================
4  * Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
5  *
6  * Developed at SunSoft, a Sun Microsystems, Inc. business.
7  * Permission to use, copy, modify, and distribute this
8  * software is freely granted, provided that this notice
9  * is preserved.
10  * ====================================================
11  */
12 /*
13  * Return the base 10 logarithm of x.  See e_log.c and k_log.h for most
14  * comments.
15  *
16  *    log10(x) = (f - 0.5*f*f + k_log1p(f)) / ln10 + k * log10(2)
17  * in not-quite-routine extra precision.
18  */
19
20 #include "libm.h"
21 #include "__log1p.h"
22
23 static const double
24 two54     = 1.80143985094819840000e+16, /* 0x43500000, 0x00000000 */
25 ivln10hi  = 4.34294481878168880939e-01, /* 0x3fdbcb7b, 0x15200000 */
26 ivln10lo  = 2.50829467116452752298e-11, /* 0x3dbb9438, 0xca9aadd5 */
27 log10_2hi = 3.01029995663611771306e-01, /* 0x3FD34413, 0x509F6000 */
28 log10_2lo = 3.69423907715893078616e-13; /* 0x3D59FEF3, 0x11F12B36 */
29
30 double log10(double x)
31 {
32         double f,hfsq,hi,lo,r,val_hi,val_lo,w,y,y2;
33         int32_t i,k,hx;
34         uint32_t lx;
35
36         EXTRACT_WORDS(hx, lx, x);
37
38         k = 0;
39         if (hx < 0x00100000) {  /* x < 2**-1022  */
40                 if (((hx&0x7fffffff)|lx) == 0)
41                         return -two54/0.0;  /* log(+-0)=-inf */
42                 if (hx<0)
43                         return (x-x)/0.0;   /* log(-#) = NaN */
44                 /* subnormal number, scale up x */
45                 k -= 54;
46                 x *= two54;
47                 GET_HIGH_WORD(hx, x);
48         }
49         if (hx >= 0x7ff00000)
50                 return x+x;
51         if (hx == 0x3ff00000 && lx == 0)
52                 return 0.0;  /* log(1) = +0 */
53         k += (hx>>20) - 1023;
54         hx &= 0x000fffff;
55         i = (hx+0x95f64)&0x100000;
56         SET_HIGH_WORD(x, hx|(i^0x3ff00000));  /* normalize x or x/2 */
57         k += i>>20;
58         y = (double)k;
59         f = x - 1.0;
60         hfsq = 0.5*f*f;
61         r = __log1p(f);
62
63         /* See log2.c for details. */
64         hi = f - hfsq;
65         SET_LOW_WORD(hi, 0);
66         lo = (f - hi) - hfsq + r;
67         val_hi = hi*ivln10hi;
68         y2 = y*log10_2hi;
69         val_lo = y*log10_2lo + (lo+hi)*ivln10lo + lo*ivln10hi;
70
71         /*
72          * Extra precision in for adding y*log10_2hi is not strictly needed
73          * since there is no very large cancellation near x = sqrt(2) or
74          * x = 1/sqrt(2), but we do it anyway since it costs little on CPUs
75          * with some parallelism and it reduces the error for many args.
76          */
77         w = y2 + val_hi;
78         val_lo += (y2 - w) + val_hi;
79         val_hi = w;
80
81         return val_lo + val_hi;
82 }