xref: /freebsd/lib/msun/src/math.h (revision 271c3a9060f2ee55607ebe146523f888e1db2654)
1 /*
2  * ====================================================
3  * Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
4  *
5  * Developed at SunPro, a Sun Microsystems, Inc. business.
6  * Permission to use, copy, modify, and distribute this
7  * software is freely granted, provided that this notice
8  * is preserved.
9  * ====================================================
10  */
11 
12 /*
13  * from: @(#)fdlibm.h 5.1 93/09/24
14  * $FreeBSD$
15  */
16 
17 #ifndef _MATH_H_
18 #define	_MATH_H_
19 
20 #include <sys/cdefs.h>
21 #include <sys/_types.h>
22 #include <machine/_limits.h>
23 
24 /*
25  * ANSI/POSIX
26  */
27 extern const union __infinity_un {
28 	unsigned char	__uc[8];
29 	double		__ud;
30 } __infinity;
31 
32 extern const union __nan_un {
33 	unsigned char	__uc[sizeof(float)];
34 	float		__uf;
35 } __nan;
36 
37 #if __GNUC_PREREQ__(3, 3) || (defined(__INTEL_COMPILER) && __INTEL_COMPILER >= 800)
38 #define	__MATH_BUILTIN_CONSTANTS
39 #endif
40 
41 #if __GNUC_PREREQ__(3, 0) && !defined(__INTEL_COMPILER)
42 #define	__MATH_BUILTIN_RELOPS
43 #endif
44 
45 #ifdef __MATH_BUILTIN_CONSTANTS
46 #define	HUGE_VAL	__builtin_huge_val()
47 #else
48 #define	HUGE_VAL	(__infinity.__ud)
49 #endif
50 
51 #if __ISO_C_VISIBLE >= 1999
52 #define	FP_ILOGB0	(-__INT_MAX)
53 #define	FP_ILOGBNAN	__INT_MAX
54 
55 #ifdef __MATH_BUILTIN_CONSTANTS
56 #define	HUGE_VALF	__builtin_huge_valf()
57 #define	HUGE_VALL	__builtin_huge_vall()
58 #define	INFINITY	__builtin_inf()
59 #define	NAN		__builtin_nan("")
60 #else
61 #define	HUGE_VALF	(float)HUGE_VAL
62 #define	HUGE_VALL	(long double)HUGE_VAL
63 #define	INFINITY	HUGE_VALF
64 #define	NAN		(__nan.__uf)
65 #endif /* __MATH_BUILTIN_CONSTANTS */
66 
67 #define	MATH_ERRNO	1
68 #define	MATH_ERREXCEPT	2
69 #define	math_errhandling	MATH_ERREXCEPT
70 
71 /* XXX We need a <machine/math.h>. */
72 #if defined(__ia64__) || defined(__sparc64__)
73 #define	FP_FAST_FMA
74 #endif
75 #ifdef __ia64__
76 #define	FP_FAST_FMAL
77 #endif
78 #define	FP_FAST_FMAF
79 
80 /* Symbolic constants to classify floating point numbers. */
81 #define	FP_INFINITE	0x01
82 #define	FP_NAN		0x02
83 #define	FP_NORMAL	0x04
84 #define	FP_SUBNORMAL	0x08
85 #define	FP_ZERO		0x10
86 #define	fpclassify(x) \
87     ((sizeof (x) == sizeof (float)) ? __fpclassifyf(x) \
88     : (sizeof (x) == sizeof (double)) ? __fpclassifyd(x) \
89     : __fpclassifyl(x))
90 
91 #define	isfinite(x)					\
92     ((sizeof (x) == sizeof (float)) ? __isfinitef(x)	\
93     : (sizeof (x) == sizeof (double)) ? __isfinite(x)	\
94     : __isfinitel(x))
95 #define	isinf(x)					\
96     ((sizeof (x) == sizeof (float)) ? __isinff(x)	\
97     : (sizeof (x) == sizeof (double)) ? isinf(x)	\
98     : __isinfl(x))
99 #define	isnan(x)					\
100     ((sizeof (x) == sizeof (float)) ? isnanf(x)		\
101     : (sizeof (x) == sizeof (double)) ? isnan(x)	\
102     : __isnanl(x))
103 #define	isnormal(x)					\
104     ((sizeof (x) == sizeof (float)) ? __isnormalf(x)	\
105     : (sizeof (x) == sizeof (double)) ? __isnormal(x)	\
106     : __isnormall(x))
107 
108 #ifdef __MATH_BUILTIN_RELOPS
109 #define	isgreater(x, y)		__builtin_isgreater((x), (y))
110 #define	isgreaterequal(x, y)	__builtin_isgreaterequal((x), (y))
111 #define	isless(x, y)		__builtin_isless((x), (y))
112 #define	islessequal(x, y)	__builtin_islessequal((x), (y))
113 #define	islessgreater(x, y)	__builtin_islessgreater((x), (y))
114 #define	isunordered(x, y)	__builtin_isunordered((x), (y))
115 #else
116 #define	isgreater(x, y)		(!isunordered((x), (y)) && (x) > (y))
117 #define	isgreaterequal(x, y)	(!isunordered((x), (y)) && (x) >= (y))
118 #define	isless(x, y)		(!isunordered((x), (y)) && (x) < (y))
119 #define	islessequal(x, y)	(!isunordered((x), (y)) && (x) <= (y))
120 #define	islessgreater(x, y)	(!isunordered((x), (y)) && \
121 					((x) > (y) || (y) > (x)))
122 #define	isunordered(x, y)	(isnan(x) || isnan(y))
123 #endif /* __MATH_BUILTIN_RELOPS */
124 
125 #define	signbit(x)					\
126     ((sizeof (x) == sizeof (float)) ? __signbitf(x)	\
127     : (sizeof (x) == sizeof (double)) ? __signbit(x)	\
128     : __signbitl(x))
129 
130 typedef	__double_t	double_t;
131 typedef	__float_t	float_t;
132 #endif /* __ISO_C_VISIBLE >= 1999 */
133 
134 /*
135  * XOPEN/SVID
136  */
137 #if __BSD_VISIBLE || __XSI_VISIBLE
138 #define	M_E		2.7182818284590452354	/* e */
139 #define	M_LOG2E		1.4426950408889634074	/* log 2e */
140 #define	M_LOG10E	0.43429448190325182765	/* log 10e */
141 #define	M_LN2		0.69314718055994530942	/* log e2 */
142 #define	M_LN10		2.30258509299404568402	/* log e10 */
143 #define	M_PI		3.14159265358979323846	/* pi */
144 #define	M_PI_2		1.57079632679489661923	/* pi/2 */
145 #define	M_PI_4		0.78539816339744830962	/* pi/4 */
146 #define	M_1_PI		0.31830988618379067154	/* 1/pi */
147 #define	M_2_PI		0.63661977236758134308	/* 2/pi */
148 #define	M_2_SQRTPI	1.12837916709551257390	/* 2/sqrt(pi) */
149 #define	M_SQRT2		1.41421356237309504880	/* sqrt(2) */
150 #define	M_SQRT1_2	0.70710678118654752440	/* 1/sqrt(2) */
151 
152 #define	MAXFLOAT	((float)3.40282346638528860e+38)
153 extern int signgam;
154 #endif /* __BSD_VISIBLE || __XSI_VISIBLE */
155 
156 #if __BSD_VISIBLE
157 #if 0
158 /* Old value from 4.4BSD-Lite math.h; this is probably better. */
159 #define	HUGE		HUGE_VAL
160 #else
161 #define	HUGE		MAXFLOAT
162 #endif
163 #endif /* __BSD_VISIBLE */
164 
165 /*
166  * Most of these functions depend on the rounding mode and have the side
167  * effect of raising floating-point exceptions, so they are not declared
168  * as __pure2.  In C99, FENV_ACCESS affects the purity of these functions.
169  */
170 __BEGIN_DECLS
171 /*
172  * ANSI/POSIX
173  */
174 int	__fpclassifyd(double) __pure2;
175 int	__fpclassifyf(float) __pure2;
176 int	__fpclassifyl(long double) __pure2;
177 int	__isfinitef(float) __pure2;
178 int	__isfinite(double) __pure2;
179 int	__isfinitel(long double) __pure2;
180 int	__isinff(float) __pure2;
181 int	__isinfl(long double) __pure2;
182 int	__isnanl(long double) __pure2;
183 int	__isnormalf(float) __pure2;
184 int	__isnormal(double) __pure2;
185 int	__isnormall(long double) __pure2;
186 int	__signbit(double) __pure2;
187 int	__signbitf(float) __pure2;
188 int	__signbitl(long double) __pure2;
189 
190 double	acos(double);
191 double	asin(double);
192 double	atan(double);
193 double	atan2(double, double);
194 double	cos(double);
195 double	sin(double);
196 double	tan(double);
197 
198 double	cosh(double);
199 double	sinh(double);
200 double	tanh(double);
201 
202 double	exp(double);
203 double	frexp(double, int *);	/* fundamentally !__pure2 */
204 double	ldexp(double, int);
205 double	log(double);
206 double	log10(double);
207 double	modf(double, double *);	/* fundamentally !__pure2 */
208 
209 double	pow(double, double);
210 double	sqrt(double);
211 
212 double	ceil(double);
213 double	fabs(double) __pure2;
214 double	floor(double);
215 double	fmod(double, double);
216 
217 /*
218  * These functions are not in C90.
219  */
220 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 1999 || __XSI_VISIBLE
221 double	acosh(double);
222 double	asinh(double);
223 double	atanh(double);
224 double	cbrt(double);
225 double	erf(double);
226 double	erfc(double);
227 double	exp2(double);
228 double	expm1(double);
229 double	fma(double, double, double);
230 double	hypot(double, double);
231 int	ilogb(double) __pure2;
232 int	(isinf)(double) __pure2;
233 int	(isnan)(double) __pure2;
234 double	lgamma(double);
235 long long llrint(double);
236 long long llround(double);
237 double	log1p(double);
238 double	logb(double);
239 long	lrint(double);
240 long	lround(double);
241 double	nan(const char *) __pure2;
242 double	nextafter(double, double);
243 double	remainder(double, double);
244 double	remquo(double, double, int *);
245 double	rint(double);
246 #endif /* __BSD_VISIBLE || __ISO_C_VISIBLE >= 1999 || __XSI_VISIBLE */
247 
248 #if __BSD_VISIBLE || __XSI_VISIBLE
249 double	j0(double);
250 double	j1(double);
251 double	jn(int, double);
252 double	scalb(double, double);
253 double	y0(double);
254 double	y1(double);
255 double	yn(int, double);
256 
257 #if __XSI_VISIBLE <= 500 || __BSD_VISIBLE
258 double	gamma(double);
259 #endif
260 #endif /* __BSD_VISIBLE || __XSI_VISIBLE */
261 
262 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 1999
263 double	copysign(double, double) __pure2;
264 double	fdim(double, double);
265 double	fmax(double, double) __pure2;
266 double	fmin(double, double) __pure2;
267 double	nearbyint(double);
268 double	round(double);
269 double	scalbln(double, long);
270 double	scalbn(double, int);
271 double	tgamma(double);
272 double	trunc(double);
273 #endif
274 
275 /*
276  * BSD math library entry points
277  */
278 #if __BSD_VISIBLE
279 double	drem(double, double);
280 int	finite(double) __pure2;
281 int	isnanf(float) __pure2;
282 
283 /*
284  * Reentrant version of gamma & lgamma; passes signgam back by reference
285  * as the second argument; user must allocate space for signgam.
286  */
287 double	gamma_r(double, int *);
288 double	lgamma_r(double, int *);
289 
290 /*
291  * IEEE Test Vector
292  */
293 double	significand(double);
294 #endif /* __BSD_VISIBLE */
295 
296 /* float versions of ANSI/POSIX functions */
297 #if __ISO_C_VISIBLE >= 1999
298 float	acosf(float);
299 float	asinf(float);
300 float	atanf(float);
301 float	atan2f(float, float);
302 float	cosf(float);
303 float	sinf(float);
304 float	tanf(float);
305 
306 float	coshf(float);
307 float	sinhf(float);
308 float	tanhf(float);
309 
310 float	exp2f(float);
311 float	expf(float);
312 float	expm1f(float);
313 float	frexpf(float, int *);	/* fundamentally !__pure2 */
314 int	ilogbf(float) __pure2;
315 float	ldexpf(float, int);
316 float	log10f(float);
317 float	log1pf(float);
318 float	logf(float);
319 float	modff(float, float *);	/* fundamentally !__pure2 */
320 
321 float	powf(float, float);
322 float	sqrtf(float);
323 
324 float	ceilf(float);
325 float	fabsf(float) __pure2;
326 float	floorf(float);
327 float	fmodf(float, float);
328 float	roundf(float);
329 
330 float	erff(float);
331 float	erfcf(float);
332 float	hypotf(float, float);
333 float	lgammaf(float);
334 float	tgammaf(float);
335 
336 float	acoshf(float);
337 float	asinhf(float);
338 float	atanhf(float);
339 float	cbrtf(float);
340 float	logbf(float);
341 float	copysignf(float, float) __pure2;
342 long long llrintf(float);
343 long long llroundf(float);
344 long	lrintf(float);
345 long	lroundf(float);
346 float	nanf(const char *) __pure2;
347 float	nearbyintf(float);
348 float	nextafterf(float, float);
349 float	remainderf(float, float);
350 float	remquof(float, float, int *);
351 float	rintf(float);
352 float	scalblnf(float, long);
353 float	scalbnf(float, int);
354 float	truncf(float);
355 
356 float	fdimf(float, float);
357 float	fmaf(float, float, float);
358 float	fmaxf(float, float) __pure2;
359 float	fminf(float, float) __pure2;
360 #endif
361 
362 /*
363  * float versions of BSD math library entry points
364  */
365 #if __BSD_VISIBLE
366 float	dremf(float, float);
367 int	finitef(float) __pure2;
368 float	gammaf(float);
369 float	j0f(float);
370 float	j1f(float);
371 float	jnf(int, float);
372 float	scalbf(float, float);
373 float	y0f(float);
374 float	y1f(float);
375 float	ynf(int, float);
376 
377 /*
378  * Float versions of reentrant version of gamma & lgamma; passes
379  * signgam back by reference as the second argument; user must
380  * allocate space for signgam.
381  */
382 float	gammaf_r(float, int *);
383 float	lgammaf_r(float, int *);
384 
385 /*
386  * float version of IEEE Test Vector
387  */
388 float	significandf(float);
389 #endif	/* __BSD_VISIBLE */
390 
391 /*
392  * long double versions of ISO/POSIX math functions
393  */
394 #if __ISO_C_VISIBLE >= 1999
395 #if 0
396 long double	acoshl(long double);
397 #endif
398 long double	acosl(long double);
399 #if 0
400 long double	asinhl(long double);
401 #endif
402 long double	asinl(long double);
403 long double	atan2l(long double, long double);
404 #if 0
405 long double	atanhl(long double);
406 #endif
407 long double	atanl(long double);
408 #if 0
409 long double	cbrtl(long double);
410 #endif
411 long double	ceill(long double);
412 long double	copysignl(long double, long double) __pure2;
413 #if 0
414 long double	coshl(long double);
415 #endif
416 long double	cosl(long double);
417 #if 0
418 long double	erfcl(long double);
419 long double	erfl(long double);
420 #endif
421 long double	exp2l(long double);
422 #if 0
423 long double	expl(long double);
424 long double	expm1l(long double);
425 #endif
426 long double	fabsl(long double) __pure2;
427 long double	fdiml(long double, long double);
428 long double	floorl(long double);
429 long double	fmal(long double, long double, long double);
430 long double	fmaxl(long double, long double) __pure2;
431 long double	fminl(long double, long double) __pure2;
432 long double	fmodl(long double, long double);
433 long double	frexpl(long double value, int *); /* fundamentally !__pure2 */
434 long double	hypotl(long double, long double);
435 int		ilogbl(long double) __pure2;
436 long double	ldexpl(long double, int);
437 #if 0
438 long double	lgammal(long double);
439 #endif
440 long long	llrintl(long double);
441 long long	llroundl(long double);
442 #if 0
443 long double	log10l(long double);
444 long double	log1pl(long double);
445 long double	log2l(long double);
446 #endif
447 long double	logbl(long double);
448 #if 0
449 long double	logl(long double);
450 #endif
451 long		lrintl(long double);
452 long		lroundl(long double);
453 long double	modfl(long double, long double *); /* fundamentally !__pure2 */
454 long double	nanl(const char *) __pure2;
455 long double	nearbyintl(long double);
456 long double	nextafterl(long double, long double);
457 double		nexttoward(double, long double);
458 float		nexttowardf(float, long double);
459 long double	nexttowardl(long double, long double);
460 #if 0
461 long double	powl(long double, long double);
462 #endif
463 long double	remainderl(long double, long double);
464 long double	remquol(long double, long double, int *);
465 long double	rintl(long double);
466 long double	roundl(long double);
467 long double	scalblnl(long double, long);
468 long double	scalbnl(long double, int);
469 #if 0
470 long double	sinhl(long double);
471 #endif
472 long double	sinl(long double);
473 long double	sqrtl(long double);
474 #if 0
475 long double	tanhl(long double);
476 #endif
477 long double	tanl(long double);
478 #if 0
479 long double	tgammal(long double);
480 #endif
481 long double	truncl(long double);
482 
483 #endif /* __ISO_C_VISIBLE >= 1999 */
484 __END_DECLS
485 
486 #endif /* !_MATH_H_ */
487