sysdeps/generic/math-type-macros.h

   1 /* Helper macros for type generic function implementations within libm.
   2    Copyright (C) 2016-2019 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   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.
   9
  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.
  14
  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    <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _MATH_TYPE_MACROS
  20 #define _MATH_TYPE_MACROS
  21
  22 /* Each type imports a header which is expected to
  23    define:
  24
  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
  30                 i.e expf expl exp.
  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
  35                 value.
  36
  37   declare_mgen_alias(from,to)
  38       This exposes the appropriate symbol(s) for a
  39       function f of type FLOAT.
  40
  41   declare_mgen_alias_r(from,to)
  42       This exposes the appropriate symbol(s) for a
  43       function f_r of type FLOAT.
  44
  45   SET_NAN_PAYLOAD(flt, mant)
  46       Set the NaN payload bits of the variable FLT of type FLOAT to
  47       the mantissa MANT.  */
  48
  49 #ifndef M_PFX
  50 # error "M_PFX must be defined."
  51 #endif
  52 #ifndef M_LIT
  53 # error "M_LIT must be defined."
  54 #endif
  55 #ifndef M_MLIT
  56 # error "M_MLIT must be defined."
  57 #endif
  58 #ifndef M_SUF
  59 # error "M_SUF must be defined."
  60 #endif
  61 #ifndef FLOAT
  62 # error "FLOAT must be defined."
  63 #endif
  64 #ifndef CFLOAT
  65 # error "CFLOAT must be defined."
  66 #endif
  67 #ifndef declare_mgen_alias
  68 # error "declare_mgen_alias must be defined."
  69 #endif
  70 #ifndef declare_mgen_alias_r
  71 # error "declare_mgen_alias_r must be defined."
  72 #endif
  73 #ifndef SET_NAN_PAYLOAD
  74 # error "SET_NAN_PAYLOAD must be defined."
  75 #endif
  76
  77 #ifndef declare_mgen_finite_alias_x
  78 #define declare_mgen_finite_alias_x(from, to)   \
  79   strong_alias (from, to ## _finite)
  80 #endif
  81
  82 #ifndef declare_mgen_finite_alias_s
  83 # define declare_mgen_finite_alias_s(from,to)   \
  84   declare_mgen_finite_alias_x (from, to)
  85 #endif
  86
  87 #ifndef declare_mgen_finite_alias
  88 # define declare_mgen_finite_alias(from, to)    \
  89   declare_mgen_finite_alias_s (M_SUF (from), M_SUF (to))
  90 #endif
  91
  92 #define __M_CONCAT(a,b) a ## b
  93 #define __M_CONCATX(a,b) __M_CONCAT(a,b)
  94
  95 #define M_NAN M_SUF (__builtin_nan) ("")
  96 #define M_MIN_EXP __M_CONCATX (M_PFX, _MIN_EXP)
  97 #define M_MAX_EXP __M_CONCATX (M_PFX, _MAX_EXP)
  98 #define M_MIN __M_CONCATX (M_PFX, _MIN)
  99 #define M_MAX __M_CONCATX (M_PFX, _MAX)
 100 #define M_MANT_DIG __M_CONCATX (M_PFX, _MANT_DIG)
 101 #define M_HUGE_VAL (M_SUF (__builtin_huge_val) ())
 102
 103 /* Helper macros for commonly used functions.  */
 104 #define M_COPYSIGN M_SUF (copysign)
 105 #define M_FABS M_SUF (fabs)
 106 #define M_SINCOS M_SUF (__sincos)
 107 #define M_SCALBN M_SUF (__scalbn)
 108 #define M_LOG1P M_SUF (__log1p)
 109
 110 #define M_ATAN2 M_SUF (__ieee754_atan2)
 111 #define M_COSH M_SUF (__ieee754_cosh)
 112 #define M_EXP M_SUF (__ieee754_exp)
 113 #define M_HYPOT M_SUF (__ieee754_hypot)
 114 #define M_LOG M_SUF (__ieee754_log)
 115 #define M_SINH M_SUF (__ieee754_sinh)
 116 #define M_SQRT M_SUF (sqrt)
 117
 118 /* Needed to evaluate M_MANT_DIG below.  */
 119 #include <float.h>
 120
 121 /* Use a special epsilon value for IBM long double
 122    to avoid spurious overflows/underflows.  */
 123 #if M_MANT_DIG != 106
 124 # define M_EPSILON __M_CONCATX (M_PFX, _EPSILON)
 125 #else
 126 # define M_EPSILON M_LIT (0x1p-106)
 127 #endif
 128
 129 /* Enable overloading of function name to assist reuse.  */
 130 #ifndef M_DECL_FUNC
 131 # define M_DECL_FUNC(f) M_SUF (f)
 132 #endif
 133
 134 #endif /* _MATH_TYPE_MACROS */