diff options
author | Po Lu <luangruo@yahoo.com> | 2023-05-04 22:08:44 +0800 |
---|---|---|
committer | Po Lu <luangruo@yahoo.com> | 2023-05-04 22:09:14 +0800 |
commit | 2f3a514b6db5e0d0453c56a4f201088ea99d5139 (patch) | |
tree | 8c950c38605cd5a562b853f870fde33bbeba595b /doc | |
parent | 94e984e6700c805c3aaac6f8d9c56381a8d0673a (diff) | |
download | emacs-2f3a514b6db5e0d0453c56a4f201088ea99d5139.tar.gz |
Clarify documentation wrt floating point division by zero and NaN
* doc/lispref/numbers.texi (Float Basics)
(Arithmetic Operations): Document what happens on a VAX.
Tested on NetBSD 9.3.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/numbers.texi | 39 |
1 files changed, 26 insertions, 13 deletions
diff --git a/doc/lispref/numbers.texi b/doc/lispref/numbers.texi index 9bfb771fc07..3e45aa90fda 100644 --- a/doc/lispref/numbers.texi +++ b/doc/lispref/numbers.texi @@ -219,17 +219,25 @@ creates huge integers. @cindex @acronym{IEEE} floating point Floating-point numbers are useful for representing numbers that are -not integral. The range of floating-point numbers is -the same as the range of the C data type @code{double} on the machine -you are using. On all computers supported by Emacs, this is -@acronym{IEEE} binary64 floating point format, which is standardized by -@url{https://standards.ieee.org/standard/754-2019.html,,IEEE Std 754-2019} -and is discussed further in David Goldberg's paper +not integral. The range of floating-point numbers is the same as the +range of the C data type @code{double} on the machine you are using. +On almost all computers supported by Emacs, this is @acronym{IEEE} +binary64 floating point format, which is standardized by +@url{https://standards.ieee.org/standard/754-2019.html,,IEEE Std +754-2019} and is discussed further in David Goldberg's paper ``@url{https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html, -What Every Computer Scientist Should Know About Floating-Point Arithmetic}''. -On modern platforms, floating-point operations follow the IEEE-754 -standard closely; however, results are not always rounded correctly on -some obsolescent platforms, notably 32-bit x86. +What Every Computer Scientist Should Know About Floating-Point +Arithmetic}''. On modern platforms, floating-point operations follow +the IEEE-754 standard closely; however, results are not always rounded +correctly on some systems, notably 32-bit x86. + + On some old computer systems, Emacs may not use IEEE floating-point. +We know of one such system on which Emacs runs correctly, but does not +follow IEEE-754: the VAX running NetBSD using GCC 10.4.0, where the +VAX @samp{D_Floating} format is used instead. IBM System/370-derived +mainframes and their XL/C compiler are also capable of utilizing a +hexadecimal floating point format, but Emacs has not yet been built in +such a configuration. The read syntax for floating-point numbers requires either a decimal point, an exponent, or both. Optional signs (@samp{+} or @samp{-}) @@ -262,6 +270,10 @@ two NaNs as equal when their signs and significands agree. Significands of NaNs are machine-dependent, as are the digits in their string representation. + NaNs are not available on systems which do not use IEEE +floating-point arithmetic; if the read syntax for a NaN is used on a +VAX, for example, the reader signals an error. + When NaNs and signed zeros are involved, non-numeric functions like @code{eql}, @code{equal}, @code{sxhash-eql}, @code{sxhash-equal} and @code{gethash} determine whether values are indistinguishable, not @@ -742,9 +754,10 @@ by rounding the quotient towards zero after each division. @cindex @code{arith-error} in division If you divide an integer by the integer 0, Emacs signals an -@code{arith-error} error (@pxref{Errors}). Floating-point division of -a nonzero number by zero yields either positive or negative infinity -(@pxref{Float Basics}). +@code{arith-error} error (@pxref{Errors}). On systems using IEEE-754 +floating-point, floating-point division of a nonzero number by zero +yields either positive or negative infinity (@pxref{Float Basics}); +otherwise, an @code{arith-error} is signaled as usual. @end defun @defun % dividend divisor |