summaryrefslogtreecommitdiffstats
path: root/lib/libm/src/e_sqrtl.c
blob: 2e4db8f748aa3beb9d10c89442705f2ade0fb230 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*	$OpenBSD: e_sqrtl.c,v 1.3 2016/09/12 19:47:02 guenther Exp $	*/
/*-
 * Copyright (c) 2007 Steven G. Kargl
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice unmodified, this list of conditions, and the following
 *    disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/types.h>
#include <machine/ieee.h>	/* for struct ieee_ext */
#include <fenv.h>
#include <float.h>
#include <math.h>

#ifdef EXT_IMPLICIT_NBIT
#define	LDBL_NBIT	0
#else /* EXT_IMPLICIT_NBIT */
#define	LDBL_NBIT	0x80000000
#endif /* EXT_IMPLICIT_NBIT */

/* Return (x + ulp) for normal positive x. Assumes no overflow. */
static inline long double
inc(long double x)
{
	struct ieee_ext *p = (struct ieee_ext *)&x;

#ifdef EXT_FRACHMBITS
	uint64_t frach;

	frach = ((uint64_t)p->ext_frach << EXT_FRACHMBITS) | p->ext_frachm;
	frach++;
	p->ext_frach = frach >> EXT_FRACHMBITS;
	p->ext_frachm = frach & 0x00000000ffffffff;
#else /* EXT_FRACHMBITS */
	uint32_t frach;

	p->ext_frach++;
	frach = p->ext_frach;
#endif /* EXT_FRACHMBITS */

	if (frach == 0) {

#ifdef EXT_FRACLMBITS
		uint64_t fracl;

		fracl = ((uint64_t)p->ext_fraclm << EXT_FRACLBITS) |
			p->ext_fracl;
		fracl++;
		p->ext_fraclm = fracl >> EXT_FRACLBITS;
		p->ext_fracl = fracl & 0x00000000ffffffff;
#else /* EXT_FRACLMBITS */
		uint32_t fracl;

		p->ext_fracl++;
		fracl = p->ext_fracl;
#endif /* EXT_FRACLMBITS */

		if (fracl == 0) {
			p->ext_exp++;
			p->ext_frach |= LDBL_NBIT;
		}
	}

	return x;
}

/* Return (x - ulp) for normal positive x. Assumes no underflow. */
static inline long double
dec(long double x)
{
	struct ieee_ext *p = (struct ieee_ext *)&x;

#ifdef EXT_FRACLMBITS
	uint64_t fracl;

	fracl = ((uint64_t)p->ext_fraclm << EXT_FRACLBITS) | p->ext_fracl;
	fracl--;
	p->ext_fraclm = fracl >> EXT_FRACLBITS;
	p->ext_fracl = fracl & 0x00000000ffffffff;
#else /* EXT_FRACLMBITS */
	uint32_t fracl;

	p->ext_fracl--;
	fracl = p->ext_fracl;
#endif /* EXT_FRACLMBITS */

	if (fracl == 0) {

#ifdef EXT_FRACHMBITS
		uint64_t frach;

		frach = ((uint64_t)p->ext_frach << EXT_FRACHMBITS) |
			p->ext_frachm;
		frach--;
		p->ext_frach = frach >> EXT_FRACHMBITS;
		p->ext_frachm = frach & 0x00000000ffffffff;
#else /* EXT_FRACHMBITS */
		uint32_t frach;

		p->ext_frach--;
		frach = p->ext_frach;
#endif /* EXT_FRACHMBITS */

		if (frach == LDBL_NBIT) {
			p->ext_exp--;
			p->ext_frach |= LDBL_NBIT;
		}
	}

	return x;
}

/*
 * This is slow, but simple and portable. You should use hardware sqrt
 * if possible.
 */

long double
sqrtl(long double x)
{
	union {
		long double e;
		struct ieee_ext bits;
	} u;
	int k, r;
	long double lo, xn;

	u.e = x;

	/* If x = NaN, then sqrt(x) = NaN. */
	/* If x = Inf, then sqrt(x) = Inf. */
	/* If x = -Inf, then sqrt(x) = NaN. */
	if (u.bits.ext_exp == LDBL_MAX_EXP * 2 - 1)
		return (x * x + x);

	/* If x = +-0, then sqrt(x) = +-0. */
	if ((u.bits.ext_frach
#ifdef EXT_FRACHMBITS
		| u.bits.ext_frachm
#endif /* EXT_FRACHMBITS */
#ifdef EXT_FRACLMBITS
		| u.bits.ext_fraclm
#endif /* EXT_FRACLMBITS */
		| u.bits.ext_fracl | u.bits.ext_exp) == 0)
		return (x);

	/* If x < 0, then raise invalid and return NaN */
	if (u.bits.ext_sign)
		return ((x - x) / (x - x));

	if (u.bits.ext_exp == 0) {
		/* Adjust subnormal numbers. */
		u.e *= 0x1.0p514;
		k = -514;
	} else {
		k = 0;
	}
	/*
	 * u.e is a normal number, so break it into u.e = e*2^n where
	 * u.e = (2*e)*2^2k for odd n and u.e = (4*e)*2^2k for even n.
	 */
	if ((u.bits.ext_exp - 0x3ffe) & 1) {	/* n is odd.     */
		k += u.bits.ext_exp - 0x3fff;	/* 2k = n - 1.   */
		u.bits.ext_exp = 0x3fff;	/* u.e in [1,2). */
	} else {
		k += u.bits.ext_exp - 0x4000;	/* 2k = n - 2.   */
		u.bits.ext_exp = 0x4000;	/* u.e in [2,4). */
	}

	/*
	 * Newton's iteration.
	 * Split u.e into a high and low part to achieve additional precision.
	 */
	xn = sqrt(u.e);			/* 53-bit estimate of sqrtl(x). */
#if LDBL_MANT_DIG > 100
	xn = (xn + (u.e / xn)) * 0.5;	/* 106-bit estimate. */
#endif
	lo = u.e;
	u.bits.ext_fracl = 0;		/* Zero out lower bits. */
#ifdef EXT_FRACLMBITS
	u.bits.ext_fraclm = 0;
#endif /* EXT_FRACLMBITS */
	lo = (lo - u.e) / xn;		/* Low bits divided by xn. */
	xn = xn + (u.e / xn);		/* High portion of estimate. */
	u.e = xn + lo;			/* Combine everything. */
	u.bits.ext_exp += (k >> 1) - 1;

	feclearexcept(FE_INEXACT);
	r = fegetround();
	fesetround(FE_TOWARDZERO);	/* Set to round-toward-zero. */
	xn = x / u.e;			/* Chopped quotient (inexact?). */

	if (!fetestexcept(FE_INEXACT)) { /* Quotient is exact. */
		if (xn == u.e) {
			fesetround(r);
			return (u.e);
		}
		/* Round correctly for inputs like x = y**2 - ulp. */
		xn = dec(xn);		/* xn = xn - ulp. */
	}

	if (r == FE_TONEAREST) {
		xn = inc(xn);		/* xn = xn + ulp. */
	} else if (r == FE_UPWARD) {
		u.e = inc(u.e);		/* u.e = u.e + ulp. */
		xn = inc(xn);		/* xn  = xn + ulp. */
	}
	u.e = u.e + xn;			/* Chopped sum. */
	fesetround(r);			/* Restore env and raise inexact */
	u.bits.ext_exp--;
	return (u.e);
}
DEF_STD(sqrtl);