math: clean up atan2.c
[oweals/musl.git] / src / math / log2.c
1 /* origin: FreeBSD /usr/src/lib/msun/src/e_log2.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 2 logarithm of x.  See log.c and __log1p.h for most
14  * comments.
15  *
16  * This reduces x to {k, 1+f} exactly as in e_log.c, then calls the kernel,
17  * then does the combining and scaling steps
18  *    log2(x) = (f - 0.5*f*f + k_log1p(f)) / ln2 + k
19  * in not-quite-routine extra precision.
20  */
21
22 #include "libm.h"
23 #include "__log1p.h"
24
25 static const double
26 two54   = 1.80143985094819840000e+16, /* 0x43500000, 0x00000000 */
27 ivln2hi = 1.44269504072144627571e+00, /* 0x3ff71547, 0x65200000 */
28 ivln2lo = 1.67517131648865118353e-10; /* 0x3de705fc, 0x2eefa200 */
29
30 double log2(double x)
31 {
32         double f,hfsq,hi,lo,r,val_hi,val_lo,w,y;
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         /*
64          * f-hfsq must (for args near 1) be evaluated in extra precision
65          * to avoid a large cancellation when x is near sqrt(2) or 1/sqrt(2).
66          * This is fairly efficient since f-hfsq only depends on f, so can
67          * be evaluated in parallel with R.  Not combining hfsq with R also
68          * keeps R small (though not as small as a true `lo' term would be),
69          * so that extra precision is not needed for terms involving R.
70          *
71          * Compiler bugs involving extra precision used to break Dekker's
72          * theorem for spitting f-hfsq as hi+lo, unless double_t was used
73          * or the multi-precision calculations were avoided when double_t
74          * has extra precision.  These problems are now automatically
75          * avoided as a side effect of the optimization of combining the
76          * Dekker splitting step with the clear-low-bits step.
77          *
78          * y must (for args near sqrt(2) and 1/sqrt(2)) be added in extra
79          * precision to avoid a very large cancellation when x is very near
80          * these values.  Unlike the above cancellations, this problem is
81          * specific to base 2.  It is strange that adding +-1 is so much
82          * harder than adding +-ln2 or +-log10_2.
83          *
84          * This uses Dekker's theorem to normalize y+val_hi, so the
85          * compiler bugs are back in some configurations, sigh.  And I
86          * don't want to used double_t to avoid them, since that gives a
87          * pessimization and the support for avoiding the pessimization
88          * is not yet available.
89          *
90          * The multi-precision calculations for the multiplications are
91          * routine.
92          */
93         hi = f - hfsq;
94         SET_LOW_WORD(hi, 0);
95         lo = (f - hi) - hfsq + r;
96         val_hi = hi*ivln2hi;
97         val_lo = (lo+hi)*ivln2lo + lo*ivln2hi;
98
99         /* spadd(val_hi, val_lo, y), except for not using double_t: */
100         w = y + val_hi;
101         val_lo += (y - w) + val_hi;
102         val_hi = w;
103
104         return val_lo + val_hi;
105 }