initial cmath code and minor libm.h update
[libm] / src / math / log2l.c
1 /* origin: OpenBSD /usr/src/lib/libm/src/ld80/e_log2l.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 /*
18  *      Base 2 logarithm, long double precision
19  *
20  *
21  * SYNOPSIS:
22  *
23  * long double x, y, log2l();
24  *
25  * y = log2l( x );
26  *
27  *
28  * DESCRIPTION:
29  *
30  * Returns the base 2 logarithm of x.
31  *
32  * The argument is separated into its exponent and fractional
33  * parts.  If the exponent is between -1 and +1, the (natural)
34  * logarithm of the fraction is approximated by
35  *
36  *     log(1+x) = x - 0.5 x**2 + x**3 P(x)/Q(x).
37  *
38  * Otherwise, setting  z = 2(x-1)/x+1),
39  *
40  *     log(x) = z + z**3 P(z)/Q(z).
41  *
42  *
43  * ACCURACY:
44  *
45  *                      Relative error:
46  * arithmetic   domain     # trials      peak         rms
47  *    IEEE      0.5, 2.0     30000      9.8e-20     2.7e-20
48  *    IEEE     exp(+-10000)  70000      5.4e-20     2.3e-20
49  *
50  * In the tests over the interval exp(+-10000), the logarithms
51  * of the random arguments were uniformly distributed over
52  * [-10000, +10000].
53  *
54  * ERROR MESSAGES:
55  *
56  * log singularity:  x = 0; returns -INFINITY
57  * log domain:       x < 0; returns NAN
58  */
59
60 #include "libm.h"
61
62 #if LDBL_MANT_DIG == 53 && LDBL_MAX_EXP == 1024
63 long double log2l(long double x)
64 {
65         return log2(x);
66 }
67 #elif LDBL_MANT_DIG == 64 && LDBL_MAX_EXP == 16384
68 /* Coefficients for ln(1+x) = x - x**2/2 + x**3 P(x)/Q(x)
69  * 1/sqrt(2) <= x < sqrt(2)
70  * Theoretical peak relative error = 6.2e-22
71  */
72 static long double P[] = {
73  4.9962495940332550844739E-1L,
74  1.0767376367209449010438E1L,
75  7.7671073698359539859595E1L,
76  2.5620629828144409632571E2L,
77  4.2401812743503691187826E2L,
78  3.4258224542413922935104E2L,
79  1.0747524399916215149070E2L,
80 };
81 static long double Q[] = {
82 /* 1.0000000000000000000000E0,*/
83  2.3479774160285863271658E1L,
84  1.9444210022760132894510E2L,
85  7.7952888181207260646090E2L,
86  1.6911722418503949084863E3L,
87  2.0307734695595183428202E3L,
88  1.2695660352705325274404E3L,
89  3.2242573199748645407652E2L,
90 };
91
92 /* Coefficients for log(x) = z + z^3 P(z^2)/Q(z^2),
93  * where z = 2(x-1)/(x+1)
94  * 1/sqrt(2) <= x < sqrt(2)
95  * Theoretical peak relative error = 6.16e-22
96  */
97 static long double R[4] = {
98  1.9757429581415468984296E-3L,
99 -7.1990767473014147232598E-1L,
100  1.0777257190312272158094E1L,
101 -3.5717684488096787370998E1L,
102 };
103 static long double S[4] = {
104 /* 1.00000000000000000000E0L,*/
105 -2.6201045551331104417768E1L,
106  1.9361891836232102174846E2L,
107 -4.2861221385716144629696E2L,
108 };
109 /* log2(e) - 1 */
110 #define LOG2EA 4.4269504088896340735992e-1L
111
112 #define SQRTH 0.70710678118654752440L
113
114 long double log2l(long double x)
115 {
116         volatile long double z;
117         long double y;
118         int e;
119
120         if (isnan(x))
121                 return x;
122         if (x == INFINITY)
123                 return x;
124         if (x <= 0.0L) {
125                 if (x == 0.0L)
126                         return -INFINITY;
127                 return NAN;
128         }
129
130         /* separate mantissa from exponent */
131         /* Note, frexp is used so that denormal numbers
132          * will be handled properly.
133          */
134         x = frexpl(x, &e);
135
136         /* logarithm using log(x) = z + z**3 P(z)/Q(z),
137          * where z = 2(x-1)/x+1)
138          */
139         if (e > 2 || e < -2) {
140                 if (x < SQRTH) {  /* 2(2x-1)/(2x+1) */
141                         e -= 1;
142                         z = x - 0.5L;
143                         y = 0.5L * z + 0.5L;
144                 } else {  /*  2 (x-1)/(x+1)   */
145                         z = x - 0.5L;
146                         z -= 0.5L;
147                         y = 0.5L * x  + 0.5L;
148                 }
149                 x = z / y;
150                 z = x*x;
151                 y = x * (z * __polevll(z, R, 3) / __p1evll(z, S, 3));
152                 goto done;
153         }
154
155         /* logarithm using log(1+x) = x - .5x**2 + x**3 P(x)/Q(x) */
156         if (x < SQRTH) {
157                 e -= 1;
158                 x = ldexpl(x, 1) - 1.0L; /*  2x - 1  */
159         } else {
160                 x = x - 1.0L;
161         }
162         z = x*x;
163         y = x * (z * __polevll(x, P, 6) / __p1evll(x, Q, 7));
164         y = y - ldexpl(z, -1);   /* -0.5x^2 + ... */
165
166 done:
167         /* Multiply log of fraction by log2(e)
168          * and base 2 exponent by 1
169          *
170          * ***CAUTION***
171          *
172          * This sequence of operations is critical and it may
173          * be horribly defeated by some compiler optimizers.
174          */
175         z = y * LOG2EA;
176         z += x * LOG2EA;
177         z += y;
178         z += x;
179         z += e;
180         return z;
181 }
182 #endif