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