Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/lib/libm/man Convert to mdoc.
details: https://anonhg.NetBSD.org/src/rev/1e74807e6fad
branches: trunk
changeset: 769664:1e74807e6fad
user: wiz <wiz%NetBSD.org@localhost>
date: Sat Sep 17 13:28:51 2011 +0000
description:
Convert to mdoc.
diffstat:
lib/libm/man/math.3 | 648 +++++++++++++++++++++------------------------------
1 files changed, 274 insertions(+), 374 deletions(-)
diffs (truncated from 899 to 300 lines):
diff -r 1184e1ece03b -r 1e74807e6fad lib/libm/man/math.3
--- a/lib/libm/man/math.3 Sat Sep 17 12:12:19 2011 +0000
+++ b/lib/libm/man/math.3 Sat Sep 17 13:28:51 2011 +0000
@@ -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.
Home |
Main Index |
Thread Index |
Old Index