Module Name: src
Committed By: wiz
Date: Sat Sep 17 13:28:51 UTC 2011
Modified Files:
src/lib/libm/man: math.3
Log Message:
Convert to mdoc.
To generate a diff of this commit:
cvs rdiff -u -r1.22 -r1.23 src/lib/libm/man/math.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libm/man/math.3
diff -u src/lib/libm/man/math.3:1.22 src/lib/libm/man/math.3:1.23
--- src/lib/libm/man/math.3:1.22 Mon Feb 26 12:10:56 2007
+++ src/lib/libm/man/math.3 Sat Sep 17 13:28:51 2011
@@ -1,4 +1,4 @@
-.\" $NetBSD: math.3,v 1.22 2007/02/26 12:10:56 drochner Exp $
+.\" $NetBSD: math.3,v 1.23 2011/09/17 13:28:51 wiz Exp $
.\"
.\" Copyright (c) 1985 Regents of the University of California.
.\" All rights reserved.
@@ -29,103 +29,90 @@
.\"
.\" from: @(#)math.3 6.10 (Berkeley) 5/6/91
.\"
-.TH MATH 3 "February 23, 2007"
-.UC 4
-.ds up \fIulp\fR
-.ds nn \fINaN\fR
-.de If
-.if n \\
-\\$1Infinity\\$2
-.if t \\
-\\$1\\(if\\$2
-..
-.SH NAME
-math \- introduction to mathematical library functions
-.SH DESCRIPTION
-These functions constitute the C math library,
-.I libm.
-The link editor searches this library under the \*(lq\-lm\*(rq option.
+.Dd February 23, 2007
+.Dt MATH 3
+.Os
+.Sh NAME
+.Nm math
+.Nd introduction to mathematical library functions
+.Sh LIBRARY
+.Lb libm
+.Sh SYNOPSIS
+.In math.h
+.Sh DESCRIPTION
+These functions constitute the C
+.Lb libm .
Declarations for these functions may be obtained from the include file
-.RI \*[Lt] math.h \*[Gt].
+.In math.h .
.\" The Fortran math library is described in ``man 3f intro''.
-.SH "LIST OF FUNCTIONS"
-.sp 2
-.nf
-.ta \w'copysign'u+2n +\w'lgamma.3'u+10n +\w'inverse trigonometric func'u
-\fIName\fP \fIAppears on Page\fP \fIDescription\fP \fIError Bound (ULPs)\fP
-.ta \w'copysign'u+4n +\w'lgamma.3'u+4n +\w'inverse trigonometric function'u+6nC
-.sp 5p
-acos acos.3 inverse trigonometric function 3
-acosh acosh.3 inverse hyperbolic function 3
-asin asin.3 inverse trigonometric function 3
-asinh asinh.3 inverse hyperbolic function 3
-atan atan.3 inverse trigonometric function 1
-atanh atanh.3 inverse hyperbolic function 3
-atan2 atan2.3 inverse trigonometric function 2
-cbrt sqrt.3 cube root 1
-ceil ceil.3 integer no less than 0
-copysign ieee.3 copy sign bit 0
-cos cos.3 trigonometric function 1
-cosh cosh.3 hyperbolic function 3
-erf erf.3 error function ???
-erfc erf.3 complementary error function ???
-exp exp.3 exponential 1
-expm1 exp.3 exp(x)\-1 1
-fabs fabs.3 absolute value 0
-finite ieee.3 test for finity 0
-floor floor.3 integer no greater than 0
-fmod fmod.3 remainder ???
-hypot hypot.3 Euclidean distance 1
-ilogb ieee.3 exponent extraction 0
-isinf isinf.3 test for infinity 0
-isnan isnan.3 test for not-a-number 0
-j0 j0.3 Bessel function ???
-j1 j0.3 Bessel function ???
-jn j0.3 Bessel function ???
-lgamma lgamma.3 log gamma function ???
-log exp.3 natural logarithm 1
-log10 exp.3 logarithm to base 10 3
-log1p exp.3 log(1+x) 1
-nan nan.3 return quiet \*(nn 0
-nextafter ieee.3 next representable number 0
-pow exp.3 exponential x**y 60\-500
-remainder ieee.3 remainder 0
-rint rint.3 round to nearest integer 0
-scalbn ieee.3 exponent adjustment 0
-sin sin.3 trigonometric function 1
-sinh sinh.3 hyperbolic function 3
-sqrt sqrt.3 square root 1
-tan tan.3 trigonometric function 3
-tanh tanh.3 hyperbolic function 3
-trunc trunc.3 nearest integral value 3
-y0 j0.3 Bessel function ???
-y1 j0.3 Bessel function ???
-yn j0.3 Bessel function ???
-.ta
-.fi
-.SH "LIST OF DEFINED VALUES"
-.sp 2
-.nf
-.ta \w'M_2_SQRTPI'u+2n +\w'1.12837916709551257390'u+4n +\w'2/sqrt(pi)'u+6nC
-\fIName\fP \fIValue\fP \fIDescription\fP
-.ta \w'M_2_SQRTPI'u+2n +\w'1.12837916709551257390'u+4n +\w'2/sqrt(pi)'u+6nC
-.sp 3p
-M_E 2.7182818284590452354 e
-M_LOG2E 1.4426950408889634074 log 2e
-M_LOG10E 0.43429448190325182765 log 10e
-M_LN2 0.69314718055994530942 log e2
-M_LN10 2.30258509299404568402 log e10
-M_PI 3.14159265358979323846 pi
-M_PI_2 1.57079632679489661923 pi/2
-M_PI_4 0.78539816339744830962 pi/4
-M_1_PI 0.31830988618379067154 1/pi
-M_2_PI 0.63661977236758134308 2/pi
-M_2_SQRTPI 1.12837916709551257390 2/sqrt(pi)
-M_SQRT2 1.41421356237309504880 sqrt(2)
-M_SQRT1_2 0.70710678118654752440 1/sqrt(2)
-.ta
-.fi
-.SH NOTES
+.Ss List of Functions
+.Bl -column "copysignX" "gammaX3XX" "inverse trigonometric funcX"
+.It Sy Name Ta Sy Man page Ta Sy Description Ta Sy Error Bound Dv ( ULP Ns No s)
+.It acos Xr acos 3 inverse trigonometric function 3
+.It acosh Xr acosh 3 inverse hyperbolic function 3
+.It asin Xr asin 3 inverse trigonometric function 3
+.It asinh Xr asinh 3 inverse hyperbolic function 3
+.It atan Xr atan 3 inverse trigonometric function 1
+.It atanh Xr atanh 3 inverse hyperbolic function 3
+.It atan2 atan2.3 inverse trigonometric function 2
+.It cbrt Xr sqrt 3 cube root 1
+.It ceil Xr ceil 3 integer no less than 0
+.It copysign Xr ieee 3 copy sign bit 0
+.It cos Xr cos 3 trigonometric function 1
+.It cosh Xr cosh 3 hyperbolic function 3
+.It erf Xr erf 3 error function ???
+.It erfc Xr erf 3 complementary error function ???
+.It exp Xr exp 3 exponential 1
+.It expm1 Xr exp 3 exp(x)\-1 1
+.It fabs Xr fabs 3 absolute value 0
+.It finite Xr ieee 3 test for finity 0
+.It floor Xr floor 3 integer no greater than 0
+.It fmod Xr fmod 3 remainder ???
+.It hypot Xr hypot 3 Euclidean distance 1
+.It ilogb Xr ieee 3 exponent extraction 0
+.It isinf Xr isinf 3 test for infinity 0
+.It isnan Xr isnan 3 test for not-a-number 0
+.It j0 Xr j0 3 Bessel function ???
+.It j1 Xr j0 3 Bessel function ???
+.It jn Xr j0 3 Bessel function ???
+.It lgamma Xr lgamma 3 log gamma function ???
+.It log Xr exp 3 natural logarithm 1
+.It log10 Xr exp 3 logarithm to base 10 3
+.It log1p Xr exp 3 log(1+x) 1
+.It nan Xr nan 3 return quiet \*(Na 0
+.It nextafter Xr ieee 3 next representable number 0
+.It pow Xr exp 3 exponential x**y 60\-500
+.It remainder Xr ieee 3 remainder 0
+.It rint Xr rint 3 round to nearest integer 0
+.It scalbn Xr ieee 3 exponent adjustment 0
+.It sin Xr sin 3 trigonometric function 1
+.It sinh Xr sinh 3 hyperbolic function 3
+.It sqrt Xr sqrt 3 square root 1
+.It tan Xr tan 3 trigonometric function 3
+.It tanh Xr tanh 3 hyperbolic function 3
+.It trunc Xr trunc 3 nearest integral value 3
+.It y0 Xr j0 3 Bessel function ???
+.It y1 Xr j0 3 Bessel function ???
+.It yn Xr j0 3 Bessel function ???
+.El
+.Ss List of Defined Values
+.Bl -column "M_2_SQRTPIXX" "1.12837916709551257390XX" "2/sqrt(pi)XXX"
+.It Sy Name Ta Sy Value Ta Sy Description
+.It M_E 2.7182818284590452354 e
+.It M_LOG2E 1.4426950408889634074 log 2e
+.It M_LOG10E 0.43429448190325182765 log 10e
+.It M_LN2 0.69314718055994530942 log e2
+.It M_LN10 2.30258509299404568402 log e10
+.It M_PI 3.14159265358979323846 pi
+.It M_PI_2 1.57079632679489661923 pi/2
+.It M_PI_4 0.78539816339744830962 pi/4
+.It M_1_PI 0.31830988618379067154 1/pi
+.It M_2_PI 0.63661977236758134308 2/pi
+.It M_2_SQRTPI 1.12837916709551257390 2/sqrt(pi)
+.It M_SQRT2 1.41421356237309504880 sqrt(2)
+.It M_SQRT1_2 0.70710678118654752440 1/sqrt(2)
+.El
+.Sh NOTES
In 4.3 BSD, distributed from the University of California
in late 1985, most of the foregoing functions come in two
versions, one for the double\-precision "D" format in the
@@ -136,123 +123,93 @@
similarly, as should be expected from programs more accurate
and robust than was the norm when UNIX was born.
For instance, the programs are accurate to within the numbers
-of \*(ups tabulated above; an \*(up is one \fIU\fRnit in the \fIL\fRast
-\fIP\fRlace.
+of
+.Dv ULPs
+tabulated above; an
+.Dv ULP
+is one Unit in the Last Place.
And the programs have been cured of anomalies that
-afflicted the older math library \fIlibm\fR in which incidents like
+afflicted the older math library
+in which incidents like
the following had been reported:
-.RS
+.Bd -literal -offset indent
sqrt(\-1.0) = 0.0 and log(\-1.0) = \-1.7e38.
-.br
cos(1.0e\-11) \*[Gt] cos(0.0) \*[Gt] 1.0.
-.br
-pow(x,1.0)
-.if n \
-!=
-.if t \
-\(!=
-x when x = 2.0, 3.0, 4.0, ..., 9.0.
-.br
+pow(x,1.0) \(!= x when x = 2.0, 3.0, 4.0, ..., 9.0.
pow(\-1.0,1.0e10) trapped on Integer Overflow.
-.br
sqrt(1.0e30) and sqrt(1.0e\-30) were very slow.
-.RE
+.Ed
However the two versions do differ in ways that have to be
explained, to which end the following notes are provided.
-.PP
-\fBDEC VAX\-11 D_floating\-point:\fR
-.PP
-This is the format for which the original math library \fIlibm\fR
+.Ss DEC VAX\-11 D_floating\-point
+This is the format for which the original math library
was developed, and to which this manual is still principally dedicated.
-It is \fIthe\fR double\-precision format for the PDP\-11
+It is
+.Em the
+double\-precision format for the PDP\-11
and the earlier VAX\-11 machines; VAX\-11s after 1983 were
provided with an optional "G" format closer to the IEEE
double\-precision format.
The earlier DEC MicroVAXs have no D format, only G double\-precision.
(Why?
Why not?)
-.PP
+.Pp
Properties of D_floating\-point:
-.RS
-Wordsize: 64 bits, 8 bytes.
-Radix: Binary.
-.br
-Precision: 56
-.if n \
-sig.
-.if t \
-significant
-bits, roughly like 17
-.if n \
-sig.
-.if t \
-significant
-decimals.
-.RS
+.Bl -hang -offset indent
+.It Wordsize :
+64 bits, 8 bytes.
+.It Radix :
+Binary.
+.It Precision :
+56 significant bits, roughly like 17 significant decimals.
If x and x' are consecutive positive D_floating\-point
-numbers (they differ by 1 \*(up), then
-.br
-1.3e\-17 \*[Lt] 0.5**56 \*[Lt] (x'\-x)/x \*[Le] 0.5**55 \*[Lt] 2.8e\-17.
-.RE
-.nf
-.ta \w'Range:'u+1n +\w'Underflow threshold'u+1n +\w'= 2.0**127'u+1n
-Range: Overflow threshold = 2.0**127 = 1.7e38.
- Underflow threshold = 0.5**128 = 2.9e\-39.
- NOTE: THIS RANGE IS COMPARATIVELY NARROW.
-.ta
-.fi
-.RS
+numbers (they differ by 1
+.Dv ULP ) ,
+then
+.Dl 1.3e\-17 \*[Lt] 0.5**56 \*[Lt] (x'\-x)/x \*[Le] 0.5**55 \*[Lt] 2.8e\-17.
+.It Range :
+.Bl -column "Underflow thresholdX" "2.0**127X"
+.It Overflow threshold = 2.0**127 = 1.7e38.
+.It Underflow threshold = 0.5**128 = 2.9e\-39.
+.El
+.Em NOTE: THIS RANGE IS COMPARATIVELY NARROW.
+.Pp
Overflow customarily stops computation.
-.br
Underflow is customarily flushed quietly to zero.
-.br
-CAUTION:
-.RS
+.Em CAUTION :
It is possible to have x
-.if n \
-!=
-.if t \
\(!=
-y and yet
-x\-y = 0 because of underflow.
+y and yet x\-y = 0 because of underflow.
Similarly x \*[Gt] y \*[Gt] 0 cannot prevent either x\(**y = 0
-or y/x = 0 from happening without warning.
-.RE
-.RE
-Zero is represented ambiguously.
-.RS
+or y/x = 0 from happening without warning.
+.It Zero is represented ambiguously :
Although 2**55 different representations of zero are accepted by
the hardware, only the obvious representation is ever produced.
There is no \-0 on a VAX.
-.RE
-.If
-is not part of the VAX architecture.
-.br
-Reserved operands:
-.RS
+.It \*(If is not part of the VAX architecture .
+.It Reserved operands :
of the 2**55 that the hardware
recognizes, only one of them is ever produced.
Any floating\-point operation upon a reserved
operand, even a MOVF or MOVD, customarily stops
computation, so they are not much used.
-.RE
-Exceptions:
-.RS
+.It Exceptions :
Divisions by zero and operations that
overflow are invalid operations that customarily
stop computation or, in earlier machines, produce
reserved operands that will stop computation.
-.RE
-Rounding:
-.RS
+.It Rounding :
Every rational operation (+, \-, \(**, /) on a
VAX (but not necessarily on a PDP\-11), if not an
over/underflow nor division by zero, is rounded to
-within half an \*(up, and when the rounding error is
-exactly half an \*(up then rounding is away from 0.
-.RE
-.RE
-.PP
+within half an
+.Dv ULP ,
+and when the rounding error is
+exactly half an
+.Dv ULP
+then rounding is away from 0.
+.El
+.Pp
Except for its narrow range, D_floating\-point is one of the
better computer arithmetics designed in the 1960's.
Its properties are reflected fairly faithfully in the elementary
@@ -264,48 +221,41 @@
like 1/0; and sqrt(\-3) and acos(3) behave like 0/0;
they all produce reserved operands and/or stop computation!
The situation is described in more detail in manual pages.
-.RS
-.ll -0.5i
-\fIThis response seems excessively punitive, so it is destined
-to be replaced at some time in the foreseeable future by a
-more flexible but still uniform scheme being developed to
-handle all floating\-point arithmetic exceptions neatly.\fR
-.ll +0.5i
-.RE
-.PP
-How do the functions in 4.3 BSD's new \fIlibm\fR for UNIX
+.Pp
+.Em This response seems excessively punitive, so it is destined
+.Em to be replaced at some time in the foreseeable future by a
+.Em more flexible but still uniform scheme being developed to
+.Em handle all floating\-point arithmetic exceptions neatly.
+.Pp
+How do the functions in 4.3 BSD's new math library for UNIX
compare with their counterparts in DEC's VAX/VMS library?
Some of the VMS functions are a little faster, some are
a little more accurate, some are more puritanical about
exceptions (like pow(0.0,0.0) and atan2(0.0,0.0)),
and most occupy much more memory than their counterparts in
-\fIlibm\fR.
+libm.
The VMS codes interpolate in large table to achieve
-speed and accuracy; the \fIlibm\fR codes use tricky formulas
+speed and accuracy; the libm codes use tricky formulas
compact enough that all of them may some day fit into a ROM.
-.PP
+.Pp
More important, DEC regards the VMS codes as proprietary
and guards them zealously against unauthorized use.
-But the \fIlibm\fR codes in 4.3 BSD are intended for the public domain;
+But the libm codes in 4.3 BSD are intended for the public domain;
they may be copied freely provided their provenance is always
acknowledged, and provided users assist the authors in their
researches by reporting experience with the codes.
Therefore no user of UNIX on a machine whose arithmetic resembles
-VAX D_floating\-point need use anything worse than the new \fIlibm\fR.
-.PP
-\fBIEEE STANDARD 754 Floating\-Point Arithmetic:\fR
-.PP
+VAX D_floating\-point need use anything worse than the new libm.
+.Ss IEEE STANDARD 754 Floating\-Point Arithmetic
This standard is on its way to becoming more widely adopted
than any other design for computer arithmetic.
VLSI chips that conform to some version of that standard have been
produced by a host of manufacturers, among them ...
-.nf
-.ta 0.5i +\w'Intel i8070, i80287'u+6n
- Intel i8087, i80287 National Semiconductor 32081
- Motorola 68881 Weitek WTL-1032, ... , -1165
- Zilog Z8070 Western Electric (AT\*[Am]T) WE32106.
-.ta
-.fi
+.Bl -column "Intel i8070, i80287XX"
+.It Intel i8087, i80287 National Semiconductor 32081
+.It 68881 Weitek WTL-1032, ... , -1165
+.It Zilog Z8070 Western Electric (AT\*[Am]T) WE32106.
+.El
Other implementations range from software, done thoroughly
in the Apple Macintosh, through VLSI in the Hewlett\-Packard
9000 series, to the ELXSI 6400 running ECL at 3 Megaflops.
@@ -317,71 +267,61 @@
IEEE versions of most of the elementary functions listed
above could easily be converted to run on a MicroVAX, though
nobody has volunteered to do that yet.
-.PP
-The codes in 4.3 BSD's \fIlibm\fR for machines that conform to
-IEEE 754 are intended primarily for the National Semi. 32081
+.Pp
+The codes in 4.3 BSD's libm for machines that conform to
+IEEE 754 are intended primarily for the National Semiconductor 32081
and WTL 1164/65.
To use these codes with the Intel or Zilog
chips, or with the Apple Macintosh or ELXSI 6400, is to
forego the use of better codes provided (perhaps freely) by
those companies and designed by some of the authors of the
codes above.
-Except for \fIatan\fR, \fIcbrt\fR, \fIerf\fR,
-\fIerfc\fR, \fIhypot\fR, \fIj0\-jn\fR, \fIlgamma\fR, \fIpow\fR
-and \fIy0\-yn\fR,
-the Motorola 68881 has all the functions in \fIlibm\fR on chip,
+Except for
+.Fn atan ,
+.Fn cbrt ,
+.Fn erf ,
+.Fn erfc ,
+.Fn hypot ,
+.Fn j0-jn ,
+.Fn lgamma ,
+.Fn pow ,
+and
+.Fn y0\-yn ,
+the Motorola 68881 has all the functions in libm on chip,
and faster and more accurate;
-it, Apple, the i8087, Z8070 and WE32106 all use 64
-.if n \
-sig.
-.if t \
-significant
-bits.
+it, Apple, the i8087, Z8070 and WE32106 all use 64 significant bits.
The main virtue of 4.3 BSD's
-\fIlibm\fR codes is that they are intended for the public domain;
+libm codes is that they are intended for the public domain;
they may be copied freely provided their provenance is always
acknowledged, and provided users assist the authors in their
researches by reporting experience with the codes.
Therefore no user of UNIX on a machine that conforms to
-IEEE 754 need use anything worse than the new \fIlibm\fR.
-.PP
+IEEE 754 need use anything worse than the new libm.
+.Pp
Properties of IEEE 754 Double\-Precision:
-.RS
-Wordsize: 64 bits, 8 bytes.
-Radix: Binary.
-.br
-Precision: 53
-.if n \
-sig.
-.if t \
-significant
-bits, roughly like 16
-.if n \
-sig.
-.if t \
-significant
-decimals.
-.RS
+.Bl -hang -offset indent
+.It Wordsize :
+64 bits, 8 bytes.
+.It Radix :
+Binary.
+.It Precision :
+53 significant bits, roughly like 16 significant decimals.
If x and x' are consecutive positive Double\-Precision
-numbers (they differ by 1 \*(up), then
-.br
-1.1e\-16 \*[Lt] 0.5**53 \*[Lt] (x'\-x)/x \*[Le] 0.5**52 \*[Lt] 2.3e\-16.
-.RE
-.nf
-.ta \w'Range:'u+1n +\w'Underflow threshold'u+1n +\w'= 2.0**1024'u+1n
-Range: Overflow threshold = 2.0**1024 = 1.8e308
- Underflow threshold = 0.5**1022 = 2.2e\-308
-.ta
-.fi
-.RS
-Overflow goes by default to a signed
-.If "" .
-.br
-Underflow is \fIGradual,\fR rounding to the nearest
+numbers (they differ by 1
+.Dv ULP ) ,
+then
+.Dl 1.1e\-16 \*[Lt] 0.5**53 \*[Lt] (x'\-x)/x \*[Le] 0.5**52 \*[Lt] 2.3e\-16.
+.It Range :
+.Bl -column "Underflow thresholdX" "2.0**1024X"
+.It Overflow threshold = 2.0**1024 = 1.8e308
+.It Underflow threshold = 0.5**1022 = 2.2e\-308
+.El
+Overflow goes by default to a signed \*(If.
+Underflow is
+.Sy Gradual ,
+rounding to the nearest
integer multiple of 0.5**1074 = 4.9e\-324.
-.RE
-Zero is represented ambiguously as +0 or \-0.
-.RS
+.It Zero is represented ambiguously as +0 or \-0:
Its sign transforms correctly through multiplication or
division, and is preserved by addition of zeros
with like signs; but x\-x yields +0 for every
@@ -390,69 +330,50 @@
sign are division by zero and copysign(x,\(+-0).
In particular, comparison (x \*[Gt] y, x \*[Ge] y, etc.)
cannot be affected by the sign of zero; but if
-finite x = y then
-.If
+finite x = y then \*(If
\&= 1/(x\-y)
-.if n \
-!=
-.if t \
\(!=
\-1/(y\-x) =
-.If \- .
-.RE
-.If
-is signed.
-.RS
+\- \*(If .
+.It \*(If is signed :
it persists when added to itself
or to any finite number.
Its sign transforms
correctly through multiplication and division, and
-.If (finite)/\(+- \0=\0\(+-0
+\*(If (finite)/\(+- \0=\0\(+-0
(nonzero)/0 =
-.If \(+- .
+\(+- \*(If.
But
-.if n \
-Infinity\-Infinity, Infinity\(**0 and Infinity/Infinity
-.if t \
\(if\-\(if, \(if\(**0 and \(if/\(if
are, like 0/0 and sqrt(\-3),
-invalid operations that produce \*(nn. ...
-.RE
-Reserved operands:
-.RS
+invalid operations that produce \*(Na.
+.It Reserved operands :
there are 2**53\-2 of them, all
-called \*(nn (\fIN\fRot \fIa N\fRumber).
-Some, called Signaling \*(nns, trap any floating\-point operation
+called \*(Na (Not A Number).
+Some, called Signaling \*[Na]s, trap any floating\-point operation
performed upon them; they are used to mark missing
or uninitialized values, or nonexistent elements of arrays.
-The rest are Quiet \*(nns; they are
+The rest are Quiet \*[Na]s; they are
the default results of Invalid Operations, and
propagate through subsequent arithmetic operations.
If x
-.if n \
-!=
-.if t \
\(!=
-x then x is \*(nn; every other predicate
-(x \*[Gt] y, x = y, x \*[Lt] y, ...) is FALSE if \*(nn is involved.
-.br
-NOTE: Trichotomy is violated by \*(nn.
-.RS
+x then x is \*(Na; every other predicate
+(x \*[Gt] y, x = y, x \*[Lt] y, ...) is FALSE if \*(Na is involved.
+.Pp
+.Em NOTE :
+Trichotomy is violated by \*(Na.
Besides being FALSE, predicates that entail ordered
comparison, rather than mere (in)equality,
-signal Invalid Operation when \*(nn is involved.
-.RE
-.RE
-Rounding:
-.RS
+signal Invalid Operation when \*(Na is involved.
+.It Rounding :
Every algebraic operation (+, \-, \(**, /,
-.if n \
-sqrt)
-.if t \
\(sr)
-is rounded by default to within half an \*(up, and
-when the rounding error is exactly half an \*(up then
-the rounded value's least significant bit is zero.
+is rounded by default to within half an
+.Dv ULP ,
+and when the rounding error is exactly half an
+.Dv ULP
+then the rounded value's least significant bit is zero.
This kind of rounding is usually the best kind,
sometimes provably so; for instance, for every
x = 1.0, 2.0, 3.0, 4.0, ..., 2.0**52, we find
@@ -463,38 +384,27 @@
But no single kind of rounding can be
proved best for every circumstance, so IEEE 754
provides rounding towards zero or towards
-.If +
++\*(If
or towards
-.If \-
+\-\*(If
at the programmer's option.
And the same kinds of rounding are specified for
Binary\-Decimal Conversions, at least for magnitudes
between roughly 1.0e\-10 and 1.0e37.
-.RE
-Exceptions:
-.RS
+.It Exceptions :
IEEE 754 recognizes five kinds of floating\-point exceptions,
listed below in declining order of probable importance.
-.RS
-.nf
-.ta \w'Invalid Operation'u+6n +\w'Gradual Underflow'u+2n
-Exception Default Result
-.tc \(ru
-
-.tc
-Invalid Operation \*(nn, or FALSE
-.if n \{\
-Overflow \(+-Infinity
-Divide by Zero \(+-Infinity \}
-.if t \{\
-Overflow \(+-\(if
-Divide by Zero \(+-\(if \}
-Underflow Gradual Underflow
-Inexact Rounded value
-.ta
-.fi
-.RE
-NOTE: An Exception is not an Error unless handled badly.
+.Bl -column "Invalid OperationX" "Gradual OverflowX"
+.It Sy Exception Ta Sy Default Result
+.It Invalid Operation \*(Na, or FALSE
+.It Overflow \(+-\(if
+.It Divide by Zero \(+-\(if \}
+.It Underflow Gradual Underflow
+.It Inexact Rounded value
+.El
+.Pp
+.Em NOTE :
+An Exception is not an Error unless handled badly.
What makes a class of exceptions exceptional
is that no single default response can be satisfactory
in every instance.
@@ -502,8 +412,8 @@
response will serve most instances satisfactorily,
the unsatisfactory instances cannot justify aborting
computation every time the exception occurs.
-.RE
-.PP
+.El
+.Pp
For each kind of floating\-point exception, IEEE 754
provides a Flag that is raised each time its exception
is signaled, and stays raised until the program resets it.
@@ -511,25 +421,23 @@
Thus, IEEE 754 provides three ways by which programs
may cope with exceptions for which the default result
might be unsatisfactory:
-.IP 1) \w'\0\0\0\0'u
+.Bl -enum
+.It
Test for a condition that might cause an exception
later, and branch to avoid the exception.
-.IP 2) \w'\0\0\0\0'u
+.It
Test a flag to see whether an exception has occurred
since the program last reset its flag.
-.IP 3) \w'\0\0\0\0'u
+.It
Test a result to see whether it is a value that only
an exception could have produced.
-.RS
-CAUTION: The only reliable ways to discover
+.Em CAUTION :
+The only reliable ways to discover
whether Underflow has occurred are to test whether
products or quotients lie closer to zero than the
underflow threshold, or to test the Underflow flag.
(Sums and differences cannot underflow in
IEEE 754; if x
-.if n \
-!=
-.if t \
\(!=
y then x\-y is correct to
full precision and certainly nonzero regardless of
@@ -543,13 +451,14 @@
underflow threshold, as is almost always the case,
digits lost to gradual underflow will not be missed
because they would have been rounded off anyway.
-So gradual underflows are usually \fIprovably\fR ignorable.
+So gradual underflows are usually
+.Em provably
+ignorable.
The same cannot be said of underflows flushed to 0.
-.RE
-.PP
+.Pp
At the option of an implementor conforming to IEEE 754,
other ways to cope with exceptions may be provided:
-.IP 4) \w'\0\0\0\0'u
+.It
ABORT.
This mechanism classifies an exception in
advance as an incident to be handled by means
@@ -557,19 +466,21 @@
statements like "ON ERROR GO TO ...".
Different languages offer different forms of this statement,
but most share the following characteristics:
-.IP \(em \w'\0\0\0\0'u
+.Bl -dash
+.It
No means is provided to substitute a value for
the offending operation's result and resume
computation from what may be the middle of an expression.
An exceptional result is abandoned.
-.IP \(em \w'\0\0\0\0'u
+.It
In a subprogram that lacks an error\-handling
statement, an exception causes the subprogram to
abort within whatever program called it, and so
on back up the chain of calling subprograms until
an error\-handling statement is encountered or the
whole task is aborted and memory is dumped.
-.IP 5) \w'\0\0\0\0'u
+.El
+.It
STOP.
This mechanism, requiring an interactive
debugging environment, is more for the programmer
@@ -584,73 +495,62 @@
unexceptionable, so the programmer ought ideally
to be able to resume execution after each one as if
execution had not been stopped.
-.IP 6) \w'\0\0\0\0'u
+.It
\&... Other ways lie beyond the scope of this document.
-.RE
-.PP
+.El
+.Pp
The crucial problem for exception handling is the problem of
Scope, and the problem's solution is understood, but not
enough manpower was available to implement it fully in time
-to be distributed in 4.3 BSD's \fIlibm\fR.
+to be distributed in 4.3 BSD's libm.
Ideally, each elementary function should act
as if it were indivisible, or atomic, in the sense that ...
-.IP i) \w'iii)'u+2n
+.Bl -enum
+.It
No exception should be signaled that is not deserved by
the data supplied to that function.
-.IP ii) \w'iii)'u+2n
+.It
Any exception signaled should be identified with that
function rather than with one of its subroutines.
-.IP iii) \w'iii)'u+2n
+.It
The internal behavior of an atomic function should not
be disrupted when a calling program changes from
one to another of the five or so ways of handling
exceptions listed above, although the definition
of the function may be correlated intentionally
with exception handling.
-.PP
-Ideally, every programmer should be able \fIconveniently\fR to
-turn a debugged subprogram into one that appears atomic to
+.El
+.Pp
+Ideally, every programmer should be able
+.Em conveniently
+to turn a debugged subprogram into one that appears atomic to
its users.
But simulating all three characteristics of an
atomic function is still a tedious affair, entailing hosts
of tests and saves\-restores; work is under way to ameliorate
the inconvenience.
-.PP
-Meanwhile, the functions in \fIlibm\fR are only approximately atomic.
+.Pp
+Meanwhile, the functions in libm are only approximately atomic.
They signal no inappropriate exception except possibly ...
-.RS
-Over/Underflow
-.RS
+.Bl -ohang -offset indent
+.It Over/Underflow
when a result, if properly computed, might have lain barely within range, and
-.RE
-Inexact in \fIcbrt\fR, \fIhypot\fR, \fIlog10\fR and \fIpow\fR
-.RS
+.It Inexact in Fn cbrt , Fn hypot , Fn log10 and Fn pow
when it happens to be exact, thanks to fortuitous cancellation of errors.
-.RE
-.RE
+.El
Otherwise, ...
-.RS
-Invalid Operation is signaled only when
-.RS
-any result but \*(nn would probably be misleading.
-.RE
-Overflow is signaled only when
-.RS
+.Bl -ohang -offset indent
+.It Invalid Operation is signaled only when
+any result but \*(Na would probably be misleading.
+.It Overflow is signaled only when
the exact result would be finite but beyond the overflow threshold.
-.RE
-Divide\-by\-Zero is signaled only when
-.RS
+.It Divide\-by\-Zero is signaled only when
a function takes exactly infinite values at finite operands.
-.RE
-Underflow is signaled only when
-.RS
+.It Underflow is signaled only when
the exact result would be nonzero but tinier than the underflow threshold.
-.RE
-Inexact is signaled only when
-.RS
+.It Inexact is signaled only when
greater range or precision would be needed to represent the exact result.
-.RE
-.RE
+.El
.\" .Sh FILES
.\" .Bl -tag -width /usr/lib/libm_p.a -compact
.\" .It Pa /usr/lib/libm.a
@@ -660,7 +560,7 @@
.\" .It Pa /usr/lib/libm_p.a
.\" the static math library compiled for profiling
.\" .El
-.SH SEE ALSO
+.Sh SEE ALSO
An explanation of IEEE 754 and its proposed extension p854
was published in the IEEE magazine MICRO in August 1984 under
the title "A Proposed Radix\- and Word\-length\-independent
@@ -671,7 +571,7 @@
and in the ACM SIGNUM Newsletter Special Issue of
Oct. 1979, may be helpful although they pertain to
superseded drafts of the standard.
-.SH BUGS
+.Sh BUGS
When signals are appropriate, they are emitted by certain
operations within the codes, so a subroutine\-trace may be
needed to identify the function with its signal in case
