xref: /freebsd/include/tgmath.h (revision 8881d206f4e68b564c2c5f50fc717086fc3e827a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2004 Stefan Farfeleder.
5  * All rights reserved.
6  *
7  * Copyright (c) 2012 Ed Schouten <ed@FreeBSD.org>
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef _TGMATH_H_
35 #define	_TGMATH_H_
36 
37 #include <complex.h>
38 #include <math.h>
39 
40 /*
41  * This implementation of <tgmath.h> uses the two following macros,
42  * which are based on the macros described in C11 proposal N1404:
43  * __tg_impl_simple(x, y, z, fnl, fn, fnf, ...)
44  *	Invokes fnl() if the corresponding real type of x, y or z is long
45  *	double, fn() if it is double or any has an integer type, and fnf()
46  *	otherwise.
47  * __tg_impl_full(x, y, cfnl, cfn, cfnf, fnl, fn, fnf, ...)
48  *	Invokes [c]fnl() if the corresponding real type of x or y is long
49  *	double, [c]fn() if it is double or any has an integer type, and
50  *	[c]fnf() otherwise.  The function with the 'c' prefix is called if
51  *	any of x or y is a complex number.
52  * Both macros call the chosen function with all additional arguments passed
53  * to them, as given by __VA_ARGS__.
54  *
55  * Note that these macros cannot be implemented with C's ?: operator,
56  * because the return type of the whole expression would incorrectly be long
57  * double complex regardless of the argument types.
58  *
59  * The structure of the C11 implementation of these macros can in
60  * principle be reused for non-C11 compilers, but due to an integer
61  * promotion bug for complex types in GCC 4.2, simply let non-C11
62  * compilers use an inefficient yet reliable version.
63  */
64 
65 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L) || \
66     __has_extension(c_generic_selections)
67 #define	__tg_generic(x, cfnl, cfn, cfnf, fnl, fn, fnf)			\
68 	_Generic(x,							\
69 		long double _Complex: cfnl,				\
70 		double _Complex: cfn,					\
71 		float _Complex: cfnf,					\
72 		long double: fnl,					\
73 		default: fn,						\
74 		float: fnf						\
75 	)
76 #define	__tg_type(x)							\
77 	__tg_generic(x, (long double _Complex)0, (double _Complex)0,	\
78 	    (float _Complex)0, (long double)0, (double)0, (float)0)
79 #define	__tg_impl_simple(x, y, z, fnl, fn, fnf, ...)			\
80 	__tg_generic(							\
81 	    __tg_type(x) + __tg_type(y) + __tg_type(z),			\
82 	    fnl, fn, fnf, fnl, fn, fnf)(__VA_ARGS__)
83 #define	__tg_impl_full(x, y, cfnl, cfn, cfnf, fnl, fn, fnf, ...)	\
84 	__tg_generic(							\
85 	    __tg_type(x) + __tg_type(y),				\
86 	    cfnl, cfn, cfnf, fnl, fn, fnf)(__VA_ARGS__)
87 #elif defined(__generic)
88 #define	__tg_generic_simple(x, fnl, fn, fnf)				\
89 	__generic(x, long double _Complex, fnl,				\
90 	    __generic(x, double _Complex, fn,				\
91 	        __generic(x, float _Complex, fnf,			\
92 	            __generic(x, long double, fnl,			\
93 	                __generic(x, float, fnf, fn)))))
94 #define	__tg_impl_simple(x, y, z, fnl, fn, fnf, ...)			\
95 	__tg_generic_simple(x,						\
96 	    __tg_generic_simple(y,					\
97 	        __tg_generic_simple(z, fnl, fnl, fnl),			\
98 	        __tg_generic_simple(z, fnl, fnl, fnl),			\
99 	        __tg_generic_simple(z, fnl, fnl, fnl)),			\
100 	    __tg_generic_simple(y,					\
101 	        __tg_generic_simple(z, fnl, fnl, fnl),			\
102 	        __tg_generic_simple(z, fnl, fn , fn ),			\
103 	        __tg_generic_simple(z, fnl, fn , fn )),			\
104 	    __tg_generic_simple(y,					\
105 	        __tg_generic_simple(z, fnl, fnl, fnl),			\
106 	        __tg_generic_simple(z, fnl, fn , fn ),			\
107 	        __tg_generic_simple(z, fnl, fn , fnf)))(__VA_ARGS__)
108 #define	__tg_generic_full(x, cfnl, cfn, cfnf, fnl, fn, fnf)		\
109 	__generic(x, long double _Complex, cfnl,			\
110 	    __generic(x, double _Complex, cfn,				\
111 	        __generic(x, float _Complex, cfnf,			\
112 	            __generic(x, long double, fnl,			\
113 	                __generic(x, float, fnf, fn)))))
114 #define	__tg_impl_full(x, y, cfnl, cfn, cfnf, fnl, fn, fnf, ...)	\
115 	__tg_generic_full(x,						\
116 	    __tg_generic_full(y, cfnl, cfnl, cfnl, cfnl, cfnl, cfnl),	\
117 	    __tg_generic_full(y, cfnl, cfn , cfn , cfnl, cfn , cfn ),	\
118 	    __tg_generic_full(y, cfnl, cfn , cfnf, cfnl, cfn , cfnf),	\
119 	    __tg_generic_full(y, cfnl, cfnl, cfnl, fnl , fnl , fnl ),	\
120 	    __tg_generic_full(y, cfnl, cfn , cfn , fnl , fn  , fn  ),	\
121 	    __tg_generic_full(y, cfnl, cfn , cfnf, fnl , fn  , fnf ))	\
122 	    (__VA_ARGS__)
123 #else
124 #error "<tgmath.h> not implemented for this compiler"
125 #endif
126 
127 /* Macros to save lots of repetition below */
128 #define	__tg_simple(x, fn)						\
129 	__tg_impl_simple(x, x, x, fn##l, fn, fn##f, x)
130 #define	__tg_simple2(x, y, fn)						\
131 	__tg_impl_simple(x, x, y, fn##l, fn, fn##f, x, y)
132 #define	__tg_simple3(x, y, z, fn)					\
133 	__tg_impl_simple(x, y, z, fn##l, fn, fn##f, x, y, z)
134 #define	__tg_simplev(x, fn, ...)					\
135 	__tg_impl_simple(x, x, x, fn##l, fn, fn##f, __VA_ARGS__)
136 #define	__tg_full(x, fn)						\
137 	__tg_impl_full(x, x, c##fn##l, c##fn, c##fn##f, fn##l, fn, fn##f, x)
138 #define	__tg_full2(x, y, fn)						\
139 	__tg_impl_full(x, y, c##fn##l, c##fn, c##fn##f, fn##l, fn, fn##f, x, y)
140 
141 /* 7.22#4 -- These macros expand to real or complex functions, depending on
142  * the type of their arguments. */
143 #define	acos(x)		__tg_full(x, acos)
144 #define	asin(x)		__tg_full(x, asin)
145 #define	atan(x)		__tg_full(x, atan)
146 #define	acosh(x)	__tg_full(x, acosh)
147 #define	asinh(x)	__tg_full(x, asinh)
148 #define	atanh(x)	__tg_full(x, atanh)
149 #define	cos(x)		__tg_full(x, cos)
150 #define	sin(x)		__tg_full(x, sin)
151 #define	tan(x)		__tg_full(x, tan)
152 #define	cosh(x)		__tg_full(x, cosh)
153 #define	sinh(x)		__tg_full(x, sinh)
154 #define	tanh(x)		__tg_full(x, tanh)
155 #define	exp(x)		__tg_full(x, exp)
156 #define	log(x)		__tg_full(x, log)
157 #define	pow(x, y)	__tg_full2(x, y, pow)
158 #define	sqrt(x)		__tg_full(x, sqrt)
159 
160 /* "The corresponding type-generic macro for fabs and cabs is fabs." */
161 #define	fabs(x)		__tg_impl_full(x, x, cabsl, cabs, cabsf,	\
162     			    fabsl, fabs, fabsf, x)
163 
164 /* 7.22#5 -- These macros are only defined for arguments with real type. */
165 #define	atan2(x, y)	__tg_simple2(x, y, atan2)
166 #define	cbrt(x)		__tg_simple(x, cbrt)
167 #define	ceil(x)		__tg_simple(x, ceil)
168 #define	copysign(x, y)	__tg_simple2(x, y, copysign)
169 #define	erf(x)		__tg_simple(x, erf)
170 #define	erfc(x)		__tg_simple(x, erfc)
171 #define	exp2(x)		__tg_simple(x, exp2)
172 #define	expm1(x)	__tg_simple(x, expm1)
173 #define	fdim(x, y)	__tg_simple2(x, y, fdim)
174 #define	floor(x)	__tg_simple(x, floor)
175 #define	fma(x, y, z)	__tg_simple3(x, y, z, fma)
176 #define	fmax(x, y)	__tg_simple2(x, y, fmax)
177 #define	fmin(x, y)	__tg_simple2(x, y, fmin)
178 #define	fmod(x, y)	__tg_simple2(x, y, fmod)
179 #define	frexp(x, y)	__tg_simplev(x, frexp, x, y)
180 #define	hypot(x, y)	__tg_simple2(x, y, hypot)
181 #define	ilogb(x)	__tg_simple(x, ilogb)
182 #define	ldexp(x, y)	__tg_simplev(x, ldexp, x, y)
183 #define	lgamma(x)	__tg_simple(x, lgamma)
184 #define	llrint(x)	__tg_simple(x, llrint)
185 #define	llround(x)	__tg_simple(x, llround)
186 #define	log10(x)	__tg_simple(x, log10)
187 #define	log1p(x)	__tg_simple(x, log1p)
188 #define	log2(x)		__tg_simple(x, log2)
189 #define	logb(x)		__tg_simple(x, logb)
190 #define	lrint(x)	__tg_simple(x, lrint)
191 #define	lround(x)	__tg_simple(x, lround)
192 #define	nearbyint(x)	__tg_simple(x, nearbyint)
193 #define	nextafter(x, y)	__tg_simple2(x, y, nextafter)
194 #define	nexttoward(x, y) __tg_simplev(x, nexttoward, x, y)
195 #define	remainder(x, y)	__tg_simple2(x, y, remainder)
196 #define	remquo(x, y, z)	__tg_impl_simple(x, x, y, remquol, remquo,	\
197 			    remquof, x, y, z)
198 #define	rint(x)		__tg_simple(x, rint)
199 #define	round(x)	__tg_simple(x, round)
200 #define	scalbn(x, y)	__tg_simplev(x, scalbn, x, y)
201 #define	scalbln(x, y)	__tg_simplev(x, scalbln, x, y)
202 #define	tgamma(x)	__tg_simple(x, tgamma)
203 #define	trunc(x)	__tg_simple(x, trunc)
204 
205 /* 7.22#6 -- These macros always expand to complex functions. */
206 #define	carg(x)		__tg_simple(x, carg)
207 #define	cimag(x)	__tg_simple(x, cimag)
208 #define	conj(x)		__tg_simple(x, conj)
209 #define	cproj(x)	__tg_simple(x, cproj)
210 #define	creal(x)	__tg_simple(x, creal)
211 
212 #endif /* !_TGMATH_H_ */
213