1 /* Helper macros for type generic function implementations within libm.
2 Copyright (C) 2016-2017 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
19 #ifndef _MATH_TYPE_MACROS
20 #define _MATH_TYPE_MACROS
22 /* Each type imports a header which is expected to
25 M_LIT(x) - Paste the type specific suffix onto the constant x.
26 M_MLIT(x) - Paste the type specific suffix used by the macro
27 constants in math.h, i.e M_PI or M_PIl.
28 M_PFX - The prefixed used by float.h macros like FLT_MANT_DIG.
29 M_SUF(x) - Paste the the type specific suffix used by functions
31 FLOAT - Resolves to the C typename of M_TYPE.
32 CFLOAT - Resolves to the complex typename of M_TYPE.
33 M_STRTO_NAN - Resolves to the internal libc function which
34 converts a string into the appropriate FLOAT nan
37 Optionally, these headers may inject a non-standard
38 definition for the following:
40 declare_mgen_alias(from,to)
41 This exposes the appropriate symbol(s) for a
42 function f of type FLOAT. */
45 # error "M_PFX must be defined."
48 # error "M_LIT must be defined."
51 # error "M_MLIT must be defined."
54 # error "M_SUF must be defined."
57 # error "FLOAT must be defined."
60 # error "CFLOAT must be defined."
63 #define __M_CONCAT(a,b) a ## b
64 #define __M_CONCATX(a,b) __M_CONCAT(a,b)
66 #define M_NAN M_SUF (__builtin_nan) ("")
67 #define M_MIN_EXP __M_CONCATX (M_PFX, _MIN_EXP)
68 #define M_MAX_EXP __M_CONCATX (M_PFX, _MAX_EXP)
69 #define M_MIN __M_CONCATX (M_PFX, _MIN)
70 #define M_MAX __M_CONCATX (M_PFX, _MAX)
71 #define M_MANT_DIG __M_CONCATX (M_PFX, _MANT_DIG)
72 #define M_HUGE_VAL (M_SUF (__builtin_huge_val) ())
74 /* Helper macros for commonly used functions. */
75 #define M_COPYSIGN M_SUF (__copysign)
76 #define M_FABS M_SUF (fabs)
77 #define M_SINCOS M_SUF (__sincos)
78 #define M_SCALBN M_SUF (__scalbn)
79 #define M_LOG1P M_SUF (__log1p)
81 #define M_ATAN2 M_SUF (__ieee754_atan2)
82 #define M_COSH M_SUF (__ieee754_cosh)
83 #define M_EXP M_SUF (__ieee754_exp)
84 #define M_HYPOT M_SUF (__ieee754_hypot)
85 #define M_LOG M_SUF (__ieee754_log)
86 #define M_SINH M_SUF (__ieee754_sinh)
87 #define M_SQRT M_SUF (__ieee754_sqrt)
89 /* Needed to evaluate M_MANT_DIG below. */
92 /* Use a special epsilon value for IBM long double
93 to avoid spurious overflows/underflows. */
95 # define M_EPSILON __M_CONCATX (M_PFX, _EPSILON)
97 # define M_EPSILON M_LIT (0x1p-106)
100 /* Enable overloading of function name to assist reuse. */
102 # define M_DECL_FUNC(f) M_SUF (f)
105 /* If the type does not declare special aliasing, use the default. */
106 #ifndef declare_mgen_alias
107 # define declare_mgen_alias(from, to) weak_alias (M_SUF (from), M_SUF (to))
110 #endif /* _MATH_TYPE_MACROS */