code cleanup of named constants
[musl] / src / math / log1pl.c
1 /* origin: OpenBSD /usr/src/lib/libm/src/ld80/s_log1pl.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  *      Relative error logarithm
19  *      Natural logarithm of 1+x, long double precision
20  *
21  *
22  * SYNOPSIS:
23  *
24  * long double x, y, log1pl();
25  *
26  * y = log1pl( x );
27  *
28  *
29  * DESCRIPTION:
30  *
31  * Returns the base e (2.718...) logarithm of 1+x.
32  *
33  * The argument 1+x is separated into its exponent and fractional
34  * parts.  If the exponent is between -1 and +1, the logarithm
35  * of the fraction is approximated by
36  *
37  *     log(1+x) = x - 0.5 x^2 + x^3 P(x)/Q(x).
38  *
39  * Otherwise, setting  z = 2(x-1)/x+1),
40  *
41  *     log(x) = z + z^3 P(z)/Q(z).
42  *
43  *
44  * ACCURACY:
45  *
46  *                      Relative error:
47  * arithmetic   domain     # trials      peak         rms
48  *    IEEE     -1.0, 9.0    100000      8.2e-20    2.5e-20
49  *
50  * ERROR MESSAGES:
51  *
52  * log singularity:  x-1 = 0; returns -INFINITY
53  * log domain:       x-1 < 0; returns NAN
54  */
55
56 #include "libm.h"
57
58 #if LDBL_MANT_DIG == 53 && LDBL_MAX_EXP == 1024
59 long double log1pl(long double x)
60 {
61         return log1p(x);
62 }
63 #elif LDBL_MANT_DIG == 64 && LDBL_MAX_EXP == 16384
64 /* Coefficients for log(1+x) = x - x^2 / 2 + x^3 P(x)/Q(x)
65  * 1/sqrt(2) <= x < sqrt(2)
66  * Theoretical peak relative error = 2.32e-20
67  */
68 static const long double P[] = {
69  4.5270000862445199635215E-5L,
70  4.9854102823193375972212E-1L,
71  6.5787325942061044846969E0L,
72  2.9911919328553073277375E1L,
73  6.0949667980987787057556E1L,
74  5.7112963590585538103336E1L,
75  2.0039553499201281259648E1L,
76 };
77 static const long double Q[] = {
78 /* 1.0000000000000000000000E0,*/
79  1.5062909083469192043167E1L,
80  8.3047565967967209469434E1L,
81  2.2176239823732856465394E2L,
82  3.0909872225312059774938E2L,
83  2.1642788614495947685003E2L,
84  6.0118660497603843919306E1L,
85 };
86
87 /* Coefficients for log(x) = z + z^3 P(z^2)/Q(z^2),
88  * where z = 2(x-1)/(x+1)
89  * 1/sqrt(2) <= x < sqrt(2)
90  * Theoretical peak relative error = 6.16e-22
91  */
92 static const long double R[4] = {
93  1.9757429581415468984296E-3L,
94 -7.1990767473014147232598E-1L,
95  1.0777257190312272158094E1L,
96 -3.5717684488096787370998E1L,
97 };
98 static const long double S[4] = {
99 /* 1.00000000000000000000E0L,*/
100 -2.6201045551331104417768E1L,
101  1.9361891836232102174846E2L,
102 -4.2861221385716144629696E2L,
103 };
104 static const long double C1 = 6.9314575195312500000000E-1L;
105 static const long double C2 = 1.4286068203094172321215E-6L;
106
107 #define SQRTH 0.70710678118654752440L
108
109 long double log1pl(long double xm1)
110 {
111         long double x, y, z;
112         int e;
113
114         if (isnan(xm1))
115                 return xm1;
116         if (xm1 == INFINITY)
117                 return xm1;
118         if (xm1 == 0.0)
119                 return xm1;
120
121         x = xm1 + 1.0;
122
123         /* Test for domain errors.  */
124         if (x <= 0.0) {
125                 if (x == 0.0)
126                         return -INFINITY;
127                 return NAN;
128         }
129
130         /* Separate mantissa from exponent.
131            Use frexp so that denormal numbers will be handled properly.  */
132         x = frexpl(x, &e);
133
134         /* logarithm using log(x) = z + z^3 P(z)/Q(z),
135            where z = 2(x-1)/x+1)  */
136         if (e > 2 || e < -2) {
137                 if (x < SQRTH) { /* 2(2x-1)/(2x+1) */
138                         e -= 1;
139                         z = x - 0.5;
140                         y = 0.5 * z + 0.5;
141                 } else { /*  2 (x-1)/(x+1)   */
142                         z = x - 0.5;
143                         z -= 0.5;
144                         y = 0.5 * x  + 0.5;
145                 }
146                 x = z / y;
147                 z = x*x;
148                 z = x * (z * __polevll(z, R, 3) / __p1evll(z, S, 3));
149                 z = z + e * C2;
150                 z = z + x;
151                 z = z + e * C1;
152                 return z;
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                 if (e != 0)
159                         x = 2.0 * x - 1.0;
160                 else
161                         x = xm1;
162         } else {
163                 if (e != 0)
164                         x = x - 1.0;
165                 else
166                         x = xm1;
167         }
168         z = x*x;
169         y = x * (z * __polevll(x, P, 6) / __p1evll(x, Q, 6));
170         y = y + e * C2;
171         z = y - 0.5 * z;
172         z = z + x;
173         z = z + e * C1;
174         return z;
175 }
176 #endif