about summary refs log tree commit diff
path: root/manual
diff options
context:
space:
mode:
authorJoseph Myers <joseph@codesourcery.com>2016-12-16 23:41:00 +0000
committerJoseph Myers <joseph@codesourcery.com>2016-12-16 23:41:00 +0000
commit3fdf17926c09fd403dd499005650e148774f1018 (patch)
tree35d77595a6a88399449d60caa766d9b06de4beab /manual
parentea1bd74defcf9d5291d14972e63105168ca9eb4f (diff)
downloadglibc-3fdf17926c09fd403dd499005650e148774f1018.tar.gz
glibc-3fdf17926c09fd403dd499005650e148774f1018.tar.xz
glibc-3fdf17926c09fd403dd499005650e148774f1018.zip
Document sNaN argument error handling.
TS 18661-1 says that "Whether a signaling NaN input causes a domain
error is implementation-defined.".  Considering it a domain error
would (given glibc's math_errhandling definition) mean setting errno
to EDOM.  glibc consistently does not set errno for sNaN inputs
(unless it does so for qNaN as well, i.e. iseqsig), so this patch adds
documentation of the implementation-defined choice not to treat this
case as a domain error.

	* manual/arith.texi (Math Error Reporting): Document that sNaN
	arguments are not considered domain errors.
Diffstat (limited to 'manual')
-rw-r--r--manual/arith.texi5
1 files changed, 5 insertions, 0 deletions
diff --git a/manual/arith.texi b/manual/arith.texi
index 41ab577237..a20a4dec6c 100644
--- a/manual/arith.texi
+++ b/manual/arith.texi
@@ -939,6 +939,11 @@ guaranteed; it is intended that @theglibc{} should set it when the
 underflow is to an appropriately signed zero, but not necessarily for
 other underflows.
 
+When a math function has an argument that is a signaling NaN,
+@theglibc{} does not consider this a domain error, so @code{errno} is
+unchanged, but the invalid exception is still raised (except for a few
+functions that are specified to handle signaling NaNs differently).
+
 Some of the math functions are defined mathematically to result in a
 complex value over parts of their domains.  The most familiar example of
 this is taking the square root of a negative number.  The complex math