acos.3, acosh.3, asin.3, asinh.3, atan.3, atanh.3, cbrt.3, ceil.3, copysign.3, cos.3, cosh.3, cproj.3, erf.3, exp.3, exp2.3, expm1.3, fabs.3, floor.3, fmod.3, frexp.3, isgreater.3, j0.3, lgamma.3, log.3, log10.3, log1p.3, log2.3, modf.3, nextafter.3, pow.3, rint.3, round.3, scalb.3, scalbln.3, sin.3, sinh.3, sqrt.3, tan.3, tanh.3, tgamma.3, trunc.3: Convert inline formatting (\fX...\fP) to dot-directive formatting

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2013-06-07 18:56:37 +02:00
parent c994238936
commit 022671eb41
41 changed files with 239 additions and 76 deletions

View File

@ -65,8 +65,11 @@ or
.SH DESCRIPTION
The
.BR acos ()
function calculates the arc cosine of \fIx\fP; that is
the value whose cosine is \fIx\fP.
function calculates the arc cosine of
.IR x ;
that is
the value whose cosine is
.IR x .
.SH RETURN VALUE
On success, these functions return the arc cosine of
.IR x

View File

@ -78,7 +78,9 @@ or
The
.BR acosh ()
function calculates the inverse hyperbolic cosine of
\fIx\fP; that is the value whose hyperbolic cosine is \fIx\fP.
.IR x ;
that is the value whose hyperbolic cosine is
.IR x .
.SH RETURN VALUE
On success, these functions return the inverse hyperbolic cosine of
.IR x .

View File

@ -67,8 +67,10 @@ or
.SH DESCRIPTION
The
.BR asin ()
function calculates the principal value of the arc sine of \fIx\fP;
that is the value whose sine is \fIx\fP.
function calculates the principal value of the arc sine of
.IR x ;
that is the value whose sine is
.IR x .
.SH RETURN VALUE
On success, these functions return the principal value of the arc sine of
.IR x

View File

@ -78,7 +78,9 @@ or
The
.BR asinh ()
function calculates the inverse hyperbolic sine of
\fIx\fP; that is the value whose hyperbolic sine is \fIx\fP.
.IR x ;
that is the value whose hyperbolic sine is
.IR x .
.SH RETURN VALUE
On success, these functions return the inverse hyperbolic sine of
.IR x .

View File

@ -67,8 +67,10 @@ or
.SH DESCRIPTION
The
.BR atan ()
function calculates the principal value of the arc tangent of \fIx\fP;
that is the value whose tangent is \fIx\fP.
function calculates the principal value of the arc tangent of
.IR x ;
that is the value whose tangent is
.IR x .
.SH RETURN VALUE
On success, these functions return the principal value of the arc tangent of
.IR x

View File

@ -78,7 +78,9 @@ or
The
.BR atanh ()
function calculates the inverse hyperbolic tangent of
\fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP.
.IR x ;
that is the value whose hyperbolic tangent is
.IR x .
.SH RETURN VALUE
On success, these functions return the inverse hyperbolic tangent of
.IR x .

View File

@ -72,7 +72,8 @@ or
.SH DESCRIPTION
The
.BR cbrt ()
function returns the (real) cube root of \fIx\fP.
function returns the (real) cube root of
.IR x .
This function cannot fail; every representable real value has a
representable real cube root.
.SH RETURN VALUE

View File

@ -70,8 +70,11 @@ is 0.0.
These functions return the ceiling of
.IR x .
If \fIx\fP is integral, +0, \-0, NaN, or infinite,
\fIx\fP itself is returned.
If
.I x
is integral, +0, \-0, NaN, or infinite,
.I x
itself is returned.
.SH ERRORS
No errors occur.
POSIX.1-2001 documents a range error for overflows, but see NOTES.

View File

@ -65,7 +65,10 @@ or
The
.BR copysign ()
functions return a value whose absolute value matches
that of \fIx\fP, but whose sign bit matches that of \fIy\fP.
that of
.IR x ,
but whose sign bit matches that of
.IR y .
For example,
.I "copysign(42.0,\ \-1.0)"
@ -78,8 +81,12 @@ On success, these functions return a value whose magnitude is taken from
and whose sign is taken from
.IR y .
If \fIx\fP is a NaN,
a NaN with the sign bit of \fIy\fP is returned.
If
.I x
is a NaN,
a NaN with the sign bit of
.I y
is returned.
.SH ERRORS
No errors occur.
.SH CONFORMING TO

View File

@ -66,7 +66,11 @@ or
.SH DESCRIPTION
The
.BR cos ()
function returns the cosine of \fIx\fP, where \fIx\fP is
function returns the cosine of
.IR x ,
where
.I x
is
given in radians.
.SH RETURN VALUE
On success, these functions return the cosine of

View File

@ -68,7 +68,9 @@ or
.SH DESCRIPTION
The
.BR cosh ()
function returns the hyperbolic cosine of \fIx\fP, which
function returns the hyperbolic cosine of
.IR x ,
which
is defined mathematically as:
.nf

View File

@ -33,7 +33,9 @@ These functions first appeared in glibc in version 2.1.
C99.
.SH NOTES
In glibc 2.11 and earlier, the implementation does something different
(a \fIstereographic\fP projection onto a Riemann Sphere).
(a
.I stereographic
projection onto a Riemann Sphere).
.\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=10401
.SH SEE ALSO
.BR cabs (3),

View File

@ -74,7 +74,9 @@ or
.SH DESCRIPTION
The
.BR erf ()
function returns the error function of \fIx\fP, defined
function returns the error function of
.IR x ,
defined
as
.TP
erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(\-t*t) dt

View File

@ -69,7 +69,8 @@ or
The
.BR exp ()
function returns the value of e (the base of natural
logarithms) raised to the power of \fIx\fP.
logarithms) raised to the power of
.IR x .
.SH RETURN VALUE
On success, these functions return the exponential value of
.IR x .

View File

@ -69,7 +69,8 @@ or
The
.BR exp2 ()
function returns the value of 2
raised to the power of \fIx\fP.
raised to the power of
.IR x .
.SH RETURN VALUE
On success, these functions return the base-2 exponential value of
.IR x .

View File

@ -78,7 +78,9 @@ returns a value equivalent to
.fi
It is
computed in a way that is accurate even if the value of \fIx\fP is near
computed in a way that is accurate even if the value of
.I x
is near
zero\(ema case where
.I "exp(x) \- 1"
would be inaccurate due to

View File

@ -65,7 +65,8 @@ or
The
.BR fabs ()
functions return the absolute value of the floating-point
number \fIx\fP.
number
.IR x .
.SH RETURN VALUE
These functions return the absolute value of
.IR x .

View File

@ -69,8 +69,11 @@ is \-1.0.
These functions return the floor of
.IR x .
If \fIx\fP is integral, +0, \-0, NaN, or an infinity,
\fIx\fP itself is returned.
If
.I x
is integral, +0, \-0, NaN, or an infinity,
.I x
itself is returned.
.SH ERRORS
No errors occur.
POSIX.1-2001 documents a range error for overflows, but see NOTES.

View File

@ -67,14 +67,28 @@ or
.SH DESCRIPTION
The
.BR fmod ()
function computes the floating-point remainder of dividing \fIx\fP by
\fIy\fP.
The return value is \fIx\fP \- \fIn\fP * \fIy\fP, where \fIn\fP
is the quotient of \fIx\fP / \fIy\fP, rounded toward zero to an integer.
function computes the floating-point remainder of dividing
.I x
by
.IR y .
The return value is
.IR x
\-
.I n
*
.IR y ,
where
.I n
is the quotient of
.I x
/
.IR y ,
rounded toward zero to an integer.
.SH RETURN VALUE
On success, these
functions return the value \fIx\fP\ \-\ \fIn\fP*\fIy\fP,
for some integer \fIn\fP,
for some integer
.IR n ,
such that the returned value has the same sign as
.I x
and a magnitude less than the magnitude of

View File

@ -66,19 +66,29 @@ or
.SH DESCRIPTION
The
.BR frexp ()
function is used to split the number \fIx\fP into a
normalized fraction and an exponent which is stored in \fIexp\fP.
function is used to split the number
.I x
into a
normalized fraction and an exponent which is stored in
.IR exp .
.SH RETURN VALUE
The
.BR frexp ()
function returns the normalized fraction.
If the argument \fIx\fP is not zero,
the normalized fraction is \fIx\fP times a power of two,
If the argument
.I x
is not zero,
the normalized fraction is
.I x
times a power of two,
and its absolute value is always in the range 1/2 (inclusive) to
1 (exclusive), that is, [0.5,1).
If \fIx\fP is zero, then the normalized fraction is
zero and zero is stored in \fIexp\fP.
If
.I x
is zero, then the normalized fraction is
zero and zero is stored in
.IR exp .
If
.I x

View File

@ -46,7 +46,9 @@ or
.RE
.ad b
.SH DESCRIPTION
The normal relation operations (like \fB<\fP, "less than")
The normal relation operations (like
.BR < ,
"less than")
will fail if one of the operands is NaN.
This will cause an exception.
To avoid this, C99 defines the macros listed below.
@ -59,25 +61,49 @@ be promoted to real-floating types).
.TP
.BR isgreater ()
determines \fI(x)\ >\ (y)\fP without an exception
if \fIx\fP or \fIy\fP is NaN.
if
.IR x
or
.I y
is NaN.
.TP
.BR isgreaterequal ()
determines \fI(x)\ >=\ (y)\fP without an exception
if \fIx\fP or \fIy\fP is NaN.
if
.IR x
or
.I y
is NaN.
.TP
.BR isless ()
determines \fI(x)\ <\ (y)\fP without an exception
if \fIx\fP or \fIy\fP is NaN.
if
.IR x
or
.I y
is NaN.
.TP
.BR islessequal ()
determines \fI(x)\ <=\ (y)\fP without an exception
if \fIx\fP or \fIy\fP is NaN.
if
.IR x
or
.I y
is NaN.
.TP
.BR islessgreater ()
determines \fI(x)\ < (y) || (x) >\ (y)\fP
without an exception if \fIx\fP or \fIy\fP is NaN.
without an exception if
.IR x
or
.I y
is NaN.
This macro is not equivalent to \fIx\ !=\ y\fP because that expression is
true if \fIx\fP or \fIy\fP is NaN.
true if
.IR x
or
.I y
is NaN.
.TP
.BR isunordered ()
determines whether its arguments are unordered, that is, whether
@ -89,7 +115,11 @@ return the result of the relational comparison;
these macros return 0 if either argument is a NaN.
.BR isunordered ()
returns 1 if \fIx\fP or \fIy\fP is NaN and 0 otherwise.
returns 1 if
.IR x
or
.I y
is NaN and 0 otherwise.
.SH ERRORS
No errors occur.
.SH CONFORMING TO

View File

@ -91,12 +91,16 @@ The
.BR j0 ()
and
.BR j1 ()
functions return Bessel functions of \fIx\fP
functions return Bessel functions of
.I x
of the first kind of orders 0 and 1, respectively.
The
.BR jn ()
function
returns the Bessel function of \fIx\fP of the first kind of order \fIn\fP.
returns the Bessel function of
.I x
of the first kind of order
.IR n .
.PP
The
.BR j0f ()
@ -155,6 +159,8 @@ There are errors of up to 2e\-16 in the values returned by
.BR j1 ()
and
.BR jn ()
for values of \fIx\fP between \-8 and 8.
for values of
.I x
between \-8 and 8.
.SH SEE ALSO
.BR y0 (3)

View File

@ -77,7 +77,9 @@ The
function returns the natural logarithm of
the absolute value of the Gamma function.
The sign of the Gamma function is returned in the
external integer \fIsigngam\fP declared in
external integer
.I signgam
declared in
.IR <math.h> .
It is 1 when the Gamma function is positive or zero, \-1
when it is negative.

View File

@ -68,7 +68,8 @@ or
.SH DESCRIPTION
The
.BR log ()
function returns the natural logarithm of \fIx\fP.
function returns the natural logarithm of
.IR x .
.SH RETURN VALUE
On success, these functions return the natural logarithm of
.IR x .

View File

@ -68,7 +68,8 @@ or
.SH DESCRIPTION
The
.BR log10 ()
function returns the base 10 logarithm of \fIx\fP.
function returns the base 10 logarithm of
.IR x .
.SH RETURN VALUE
On success, these functions return the base 10 logarithm of
.IR x .

View File

@ -77,7 +77,9 @@ returns a value equivalent to
.fi
It is computed in a way
that is accurate even if the value of \fIx\fP is near zero.
that is accurate even if the value of
.I x
is near zero.
.SH RETURN VALUE
On success, these functions return the natural logarithm of
.IR "(1\ +\ x)" .

View File

@ -68,7 +68,8 @@ or
.SH DESCRIPTION
The
.BR log2 ()
function returns the base 2 logarithm of \fIx\fP.
function returns the base 2 logarithm of
.IR x .
.SH RETURN VALUE
On success, these functions return the base 2 logarithm of
.IR x .

View File

@ -66,13 +66,18 @@ or
.SH DESCRIPTION
The
.BR modf ()
function breaks the argument \fIx\fP into an integral
part and a fractional part, each of which has the same sign as \fIx\fP.
The integral part is stored in the location pointed to by \fIiptr\fP.
function breaks the argument
.I x
into an integral
part and a fractional part, each of which has the same sign as
.IR x .
The integral part is stored in the location pointed to by
.IR iptr .
.SH RETURN VALUE
The
.BR modf ()
function returns the fractional part of \fIx\fP.
function returns the fractional part of
.IR x .
If
.I x

View File

@ -81,7 +81,12 @@ is less than
these functions will return the largest representable number less than
.IR x .
If \fIx\fP equals \fIy\fP, the functions return \fIy\fP.
If
.I x
equals
.IR y ,
the functions return
.IR y .
The
.BR nexttoward ()

View File

@ -67,8 +67,11 @@ or
.SH DESCRIPTION
The
.BR pow ()
function returns the value of \fIx\fP raised to the
power of \fIy\fP.
function returns the value of
.I x
raised to the
power of
.IR y .
.SH RETURN VALUE
On success, these functions return the value of
.I x

View File

@ -105,8 +105,11 @@ when the result differs in value from the argument.
.SH RETURN VALUE
These functions return the rounded integer value.
If \fIx\fP is integral, +0, \-0, NaN, or infinite,
\fIx\fP itself is returned.
If
.I x
is integral, +0, \-0, NaN, or infinite,
.I x
itself is returned.
.SH ERRORS
No errors occur.
POSIX.1-2001 documents a range error for overflows, but see NOTES.

View File

@ -58,7 +58,9 @@ or
.RE
.ad
.SH DESCRIPTION
These functions round \fIx\fP to the nearest integer, but
These functions round
.I x
to the nearest integer, but
round halfway cases away from zero (regardless of the current rounding
direction, see
.BR fenv (3)),
@ -73,8 +75,11 @@ is \-1.0.
.SH RETURN VALUE
These functions return the rounded integer value.
If \fIx\fP is integral, +0, \-0, NaN, or infinite,
\fIx\fP itself is returned.
If
.I x
is integral, +0, \-0, NaN, or infinite,
.I x
itself is returned.
.SH ERRORS
No errors occur.
POSIX.1-2001 documents a range error for overflows, but see NOTES.

View File

@ -77,7 +77,12 @@ can be obtained by including
.IR <float.h> .
.\" not in /usr/include but in a gcc lib
.SH RETURN VALUE
On success, these functions return \fIx\fP * \fBFLT_RADIX\fP ** \fIexp\fP.
On success, these functions return
.IR x
*
.B FLT_RADIX
**
.IR exp .
If
.I x

View File

@ -93,7 +93,12 @@ can be obtained by including
.IR <float.h> .
.\" not in /usr/include but in a gcc lib
.SH RETURN VALUE
On success, these functions return \fIx\fP * \fBFLT_RADIX\fP ** \fIexp\fP.
On success, these functions return
.IR x
*
.B FLT_RADIX
**
.IR exp .
If
.I x

View File

@ -67,7 +67,11 @@ or
.SH DESCRIPTION
The
.BR sin ()
function returns the sine of \fIx\fP, where \fIx\fP is
function returns the sine of
.IR x ,
where
.I x
is
given in radians.
.SH RETURN VALUE
On success, these functions return the sine of

View File

@ -68,7 +68,9 @@ or
.SH DESCRIPTION
The
.BR sinh ()
function returns the hyperbolic sine of \fIx\fP, which
function returns the hyperbolic sine of
.IR x ,
which
is defined mathematically as:
.nf

View File

@ -66,7 +66,8 @@ or
.SH DESCRIPTION
The
.BR sqrt ()
function returns the nonnegative square root of \fIx\fP.
function returns the nonnegative square root of
.IR x .
.SH RETURN VALUE
On success, these functions return the square root of
.IR x .

View File

@ -67,7 +67,11 @@ or
.SH DESCRIPTION
The
.BR tan ()
function returns the tangent of \fIx\fP, where \fIx\fP is
function returns the tangent of
.IR x ,
where
.I x
is
given in radians.
.SH RETURN VALUE
On success, these functions return the tangent of

View File

@ -67,7 +67,9 @@ or
.SH DESCRIPTION
The
.BR tanh ()
function returns the hyperbolic tangent of \fIx\fP, which
function returns the hyperbolic tangent of
.IR x ,
which
is defined mathematically as:
.nf

View File

@ -47,15 +47,19 @@ The Gamma function is defined by
Gamma(x) = integral from 0 to infinity of t^(x\-1) e^\-t dt
.sp
It is defined for every real number except for nonpositive integers.
For nonnegative integral \fIm\fP one has
For nonnegative integral
.I m
one has
.sp
Gamma(m+1) = m!
.sp
and, more generally, for all \fIx\fP:
and, more generally, for all
.IR x :
.sp
Gamma(x+1) = x * Gamma(x)
.sp
Furthermore, the following is valid for all values of \fIx\fP
Furthermore, the following is valid for all values of
.I x
outside the poles:
.sp
Gamma(x) * Gamma(1 \- x) = PI / sin(PI * x)

View File

@ -56,12 +56,18 @@ or
.RE
.ad
.SH DESCRIPTION
These functions round \fIx\fP to the nearest integer
These functions round
.I x
to the nearest integer
not larger in absolute value.
.SH RETURN VALUE
These functions return the rounded integer value.
If \fIx\fP is integral, infinite, or NaN, \fIx\fP itself is returned.
If
.IR x
is integral, infinite, or NaN,
.I x
itself is returned.
.SH ERRORS
No errors occur.
.SH VERSIONS