sysdeps/generic/math-type-macros.h

   1 /* Helper macros for type generic function implementations within libm.
   2    Copyright (C) 2016-2018 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    <http://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 #ifndef M_PFX
  46 # error "M_PFX must be defined."
  47 #endif
  48 #ifndef M_LIT
  49 # error "M_LIT must be defined."
  50 #endif
  51 #ifndef M_MLIT
  52 # error "M_MLIT must be defined."
  53 #endif
  54 #ifndef M_SUF
  55 # error "M_SUF must be defined."
  56 #endif
  57 #ifndef FLOAT
  58 # error "FLOAT must be defined."
  59 #endif
  60 #ifndef CFLOAT
  61 # error "CFLOAT must be defined."
  62 #endif
  63 #ifndef declare_mgen_alias
  64 # error "declare_mgen_alias must be defined."
  65 #endif
  66 #ifndef declare_mgen_alias_r
  67 # error "declare_mgen_alias_r must be defined."
  68 #endif
  69
  70 #define __M_CONCAT(a,b) a ## b
  71 #define __M_CONCATX(a,b) __M_CONCAT(a,b)
  72
  73 #define M_NAN M_SUF (__builtin_nan) ("")
  74 #define M_MIN_EXP __M_CONCATX (M_PFX, _MIN_EXP)
  75 #define M_MAX_EXP __M_CONCATX (M_PFX, _MAX_EXP)
  76 #define M_MIN __M_CONCATX (M_PFX, _MIN)
  77 #define M_MAX __M_CONCATX (M_PFX, _MAX)
  78 #define M_MANT_DIG __M_CONCATX (M_PFX, _MANT_DIG)
  79 #define M_HUGE_VAL (M_SUF (__builtin_huge_val) ())
  80
  81 /* Helper macros for commonly used functions.  */
  82 #define M_COPYSIGN M_SUF (__copysign)
  83 #define M_FABS M_SUF (fabs)
  84 #define M_SINCOS M_SUF (__sincos)
  85 #define M_SCALBN M_SUF (__scalbn)
  86 #define M_LOG1P M_SUF (__log1p)
  87
  88 #define M_ATAN2 M_SUF (__ieee754_atan2)
  89 #define M_COSH M_SUF (__ieee754_cosh)
  90 #define M_EXP M_SUF (__ieee754_exp)
  91 #define M_HYPOT M_SUF (__ieee754_hypot)
  92 #define M_LOG M_SUF (__ieee754_log)
  93 #define M_SINH M_SUF (__ieee754_sinh)
  94 #define M_SQRT M_SUF (__ieee754_sqrt)
  95
  96 /* Needed to evaluate M_MANT_DIG below.  */
  97 #include <float.h>
  98
  99 /* Use a special epsilon value for IBM long double
 100    to avoid spurious overflows/underflows.  */
 101 #if M_MANT_DIG != 106
 102 # define M_EPSILON __M_CONCATX (M_PFX, _EPSILON)
 103 #else
 104 # define M_EPSILON M_LIT (0x1p-106)
 105 #endif
 106
 107 /* Enable overloading of function name to assist reuse.  */
 108 #ifndef M_DECL_FUNC
 109 # define M_DECL_FUNC(f) M_SUF (f)
 110 #endif
 111
 112 #endif /* _MATH_TYPE_MACROS */