man7/math_error.7

   1 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   5 .\"
   6 .TH math_error 7 (date) "Linux man-pages (unreleased)"
   7 .SH NAME
   8 math_error \- detecting errors from mathematical functions
   9 .SH SYNOPSIS
  10 .nf
  11 .B #include <math.h>
  12 .B #include <errno.h>
  13 .B #include <fenv.h>
  14 .fi
  15 .SH DESCRIPTION
  16 When an error occurs,
  17 most library functions indicate this fact by returning a special value
  18 (e.g., \-1 or NULL).
  19 Because they typically return a floating-point number,
  20 the mathematical functions declared in
  21 .I <math.h>
  22 indicate an error using other mechanisms.
  23 There are two error-reporting mechanisms:
  24 the older one sets
  25 .IR errno ;
  26 the newer one uses the floating-point exception mechanism (the use of
  27 .BR feclearexcept (3)
  28 and
  29 .BR fetestexcept (3),
  30 as outlined below)
  31 described in
  32 .BR fenv (3).
  33 .P
  34 A portable program that needs to check for an error from a mathematical
  35 function should set
  36 .I errno
  37 to zero, and make the following call
  38 .P
  39 .in +4n
  40 .EX
  41 feclearexcept(FE_ALL_EXCEPT);
  42 .EE
  43 .in
  44 .P
  45 before calling a mathematical function.
  46 .P
  47 Upon return from the mathematical function, if
  48 .I errno
  49 is nonzero, or the following call (see
  50 .BR fenv (3))
  51 returns nonzero
  52 .P
  53 .in +4n
  54 .EX
  55 fetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW |
  56              FE_UNDERFLOW);
  57 .EE
  58 .in
  59 .P
  60 .\" enum
  61 .\" {
  62 .\" FE_INVALID = 0x01,
  63 .\" __FE_DENORM = 0x02,
  64 .\" FE_DIVBYZERO = 0x04,
  65 .\" FE_OVERFLOW = 0x08,
  66 .\" FE_UNDERFLOW = 0x10,
  67 .\" FE_INEXACT = 0x20
  68 .\" };
  69 then an error occurred in the mathematical function.
  70 .P
  71 The error conditions that can occur for mathematical functions
  72 are described below.
  73 .SS Domain error
  74 A
  75 .I domain error
  76 occurs when a mathematical function is supplied with an argument whose
  77 value falls outside the domain for which the function
  78 is defined (e.g., giving a negative argument to
  79 .BR log (3)).
  80 When a domain error occurs,
  81 math functions commonly return a NaN
  82 (though some functions return a different value in this case);
  83 .I errno
  84 is set to
  85 .BR EDOM ,
  86 and an "invalid"
  87 .RB ( FE_INVALID )
  88 floating-point exception is raised.
  89 .SS Pole error
  90 A
  91 .I pole error
  92 occurs when the mathematical result of a function is an exact infinity
  93 (e.g., the logarithm of 0 is negative infinity).
  94 When a pole error occurs,
  95 the function returns the (signed) value
  96 .BR HUGE_VAL ,
  97 .BR HUGE_VALF ,
  98 or
  99 .BR HUGE_VALL ,
 100 depending on whether the function result type is
 101 .IR double ,
 102 .IR float ,
 103 or
 104 .IR "long double" .
 105 The sign of the result is that which is mathematically correct for
 106 the function.
 107 .I errno
 108 is set to
 109 .BR ERANGE ,
 110 and a "divide-by-zero"
 111 .RB ( FE_DIVBYZERO )
 112 floating-point exception is raised.
 113 .SS Range error
 114 A
 115 .I range error
 116 occurs when the magnitude of the function result means that it
 117 cannot be represented in the result type of the function.
 118 The return value of the function depends on whether the range error
 119 was an overflow or an underflow.
 120 .P
 121 A floating result
 122 .I overflows
 123 if the result is finite,
 124 but is too large to represented in the result type.
 125 When an overflow occurs,
 126 the function returns the value
 127 .BR HUGE_VAL ,
 128 .BR HUGE_VALF ,
 129 or
 130 .BR HUGE_VALL ,
 131 depending on whether the function result type is
 132 .IR double ,
 133 .IR float ,
 134 or
 135 .IR "long double" .
 136 .I errno
 137 is set to
 138 .BR ERANGE ,
 139 and an "overflow"
 140 .RB ( FE_OVERFLOW )
 141 floating-point exception is raised.
 142 .P
 143 A floating result
 144 .I underflows
 145 if the result is too small to be represented in the result type.
 146 If an underflow occurs,
 147 a mathematical function typically returns 0.0
 148 (C99 says a function shall return "an implementation-defined value
 149 whose magnitude is no greater than the smallest normalized
 150 positive number in the specified type").
 151 .I errno
 152 may be set to
 153 .BR ERANGE ,
 154 and an "underflow"
 155 .RB ( FE_UNDERFLOW )
 156 floating-point exception may be raised.
 157 .P
 158 Some functions deliver a range error if the supplied argument value,
 159 or the correct function result, would be
 160 .IR subnormal .
 161 A subnormal value is one that is nonzero,
 162 but with a magnitude that is so small that
 163 it can't be presented in normalized form
 164 (i.e., with a 1 in the most significant bit of the significand).
 165 The representation of a subnormal number will contain one
 166 or more leading zeros in the significand.
 167 .SH NOTES
 168 The
 169 .I math_errhandling
 170 identifier specified by C99 and POSIX.1 is not supported by glibc.
 171 .\" See CONFORMANCE in the glibc 2.8 (and earlier) source.
 172 This identifier is supposed to indicate which of the two
 173 error-notification mechanisms
 174 .RI ( errno ,
 175 exceptions retrievable via
 176 .BR fetestexcept (3))
 177 is in use.
 178 The standards require that at least one be in use,
 179 but permit both to be available.
 180 The current (glibc 2.8) situation under glibc is messy.
 181 Most (but not all) functions raise exceptions on errors.
 182 Some also set
 183 .IR errno .
 184 A few functions set
 185 .IR errno ,
 186 but don't raise an exception.
 187 A very few functions do neither.
 188 See the individual manual pages for details.
 189 .P
 190 To avoid the complexities of using
 191 .I errno
 192 and
 193 .BR fetestexcept (3)
 194 for error checking,
 195 it is often advised that one should instead check for bad argument
 196 values before each call.
 197 .\" http://www.securecoding.cert.org/confluence/display/seccode/FLP32-C.+Prevent+or+detect+domain+and+range+errors+in+math+functions
 198 For example, the following code ensures that
 199 .BR log (3)'s
 200 argument is not a NaN and is not zero (a pole error) or
 201 less than zero (a domain error):
 202 .P
 203 .in +4n
 204 .EX
 205 double x, r;
 206 \&
 207 if (isnan(x) || islessequal(x, 0)) {
 208     /* Deal with NaN / pole error / domain error */
 209 }
 210 \&
 211 r = log(x);
 212 .EE
 213 .in
 214 .P
 215 The discussion on this page does not apply to the complex
 216 mathematical functions (i.e., those declared by
 217 .IR <complex.h> ),
 218 which in general are not required to return errors by C99
 219 and POSIX.1.
 220 .P
 221 The
 222 .BR gcc (1)
 223 .I "\-fno\-math\-errno"
 224 option causes the executable to employ implementations of some
 225 mathematical functions that are faster than the standard
 226 implementations, but do not set
 227 .I errno
 228 on error.
 229 (The
 230 .BR gcc (1)
 231 .I "\-ffast\-math"
 232 option also enables
 233 .IR "\-fno\-math\-errno" .)
 234 An error can still be tested for using
 235 .BR fetestexcept (3).
 236 .SH SEE ALSO
 237 .BR gcc (1),
 238 .BR errno (3),
 239 .BR fenv (3),
 240 .BR fpclassify (3),
 241 .BR INFINITY (3),
 242 .BR isgreater (3),
 243 .BR matherr (3),
 244 .BR nan (3)
 245 .P
 246 .I "info libc"