acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atanh.3, cabs.3, cacos.3, cacosh.3, casin.3, casinh.3, catan.3, catanh.3, cbrt.3, cexp.3, cimag.3, conj.3, copysign.3, cos.3, cosh.3, cpow.3, creal.3, erf.3, erfc.3, exp.3, exp10.2, exp2.3, expm1.3, fma.3, fmod.3, frexp.3, hypot.3, ldexp.3, lgamma.3, log.3, log10.3, log1p.3, log2.3, modf.3, pow.3, pow10.3, remainder.3, significand.3, sin.3, sinh.3, sqrt.3, tan.3, tanh.3, tgamma.3: wfix: use consistent wording to describe functions

exp10.3, lgamma.3, modf.3, pow10.3, remainder.3, significand.3:dd
Where a page describes multiple math functions with float, double,
and long double variants, just describe them as "These functions"
rather than describing in terms of just the double variant.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2015-04-12 15:23:50 +02:00
parent 4f337c124b
commit 5600f73afd
50 changed files with 66 additions and 162 deletions

View File

@ -63,9 +63,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the arc cosine of
.BR acos ()
function calculates the arc cosine of
.IR x ; .IR x ;
that is that is
the value whose cosine is the value whose cosine is

View File

@ -75,9 +75,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the inverse hyperbolic cosine of
.BR acosh ()
function calculates the inverse hyperbolic cosine of
.IR x ; .IR x ;
that is the value whose hyperbolic cosine is that is the value whose hyperbolic cosine is
.IR x . .IR x .

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the principal value of the arc sine of
.BR asin ()
function calculates the principal value of the arc sine of
.IR x ; .IR x ;
that is the value whose sine is that is the value whose sine is
.IR x . .IR x .

View File

@ -75,9 +75,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the inverse hyperbolic sine of
.BR asinh ()
function calculates the inverse hyperbolic sine of
.IR x ; .IR x ;
that is the value whose hyperbolic sine is that is the value whose hyperbolic sine is
.IR x . .IR x .

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the principal value of the arc tangent of
.BR atan ()
function calculates the principal value of the arc tangent of
.IR x ; .IR x ;
that is the value whose tangent is that is the value whose tangent is
.IR x . .IR x .

View File

@ -63,9 +63,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the principal value of the arc tangent of
.BR atan2 ()
function calculates the principal value of the arc tangent of
.IR y/x , .IR y/x ,
using the signs of the two arguments to determine using the signs of the two arguments to determine
the quadrant of the result. the quadrant of the result.

View File

@ -75,9 +75,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the inverse hyperbolic tangent of
.BR atanh ()
function calculates the inverse hyperbolic tangent of
.IR x ; .IR x ;
that is the value whose hyperbolic tangent is that is the value whose hyperbolic tangent is
.IR x . .IR x .

View File

@ -18,9 +18,7 @@ cabs, cabsf, cabsl \- absolute value of a complex number
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the absolute value of the complex number
.BR cabs ()
function returns the absolute value of the complex number
.IR z . .IR z .
The result is a real number. The result is a real number.
.SH VERSIONS .SH VERSIONS

View File

@ -19,9 +19,7 @@ cacos, cacosf, cacosl \- complex arc cosine
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the complex arc cosine of
.BR cacos ()
function calculates the complex arc cosine of
.IR z . .IR z .
If \fIy\ =\ cacos(z)\fP, then \fIz\ =\ ccos(y)\fP. If \fIy\ =\ cacos(z)\fP, then \fIz\ =\ ccos(y)\fP.
The real part of The real part of

View File

@ -19,9 +19,7 @@ cacosh, cacoshf, cacoshl \- complex arc hyperbolic cosine
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the complex arc hyperbolic cosine of
.BR cacosh ()
function calculates the complex arc hyperbolic cosine of
.IR z . .IR z .
If \fIy\ =\ cacosh(z)\fP, then \fIz\ =\ ccosh(y)\fP. If \fIy\ =\ cacosh(z)\fP, then \fIz\ =\ ccosh(y)\fP.
The imaginary part of The imaginary part of

View File

@ -18,9 +18,7 @@ casin, casinf, casinl \- complex arc sine
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the complex arc sine of
.BR casin ()
function calculates the complex arc sine of
.IR z . .IR z .
If \fIy\ =\ casin(z)\fP, then \fIz\ =\ csin(y)\fP. If \fIy\ =\ casin(z)\fP, then \fIz\ =\ csin(y)\fP.
The real part of The real part of

View File

@ -18,9 +18,7 @@ casinh, casinhf, casinhl \- complex arc sine hyperbolic
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the complex arc hyperbolic sine of
.BR casinh ()
function calculates the complex arc hyperbolic sine of
.IR z . .IR z .
If \fIy\ =\ casinh(z)\fP, then \fIz\ =\ csinh(y)\fP. If \fIy\ =\ casinh(z)\fP, then \fIz\ =\ csinh(y)\fP.
The imaginary part of The imaginary part of

View File

@ -19,9 +19,7 @@ catan, catanf, catanl \- complex arc tangents
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the complex arc tangent of
.BR catan ()
function calculates the complex arc tangent of
.IR z . .IR z .
If \fIy\ =\ catan(z)\fP, then \fIz\ =\ ctan(y)\fP. If \fIy\ =\ catan(z)\fP, then \fIz\ =\ ctan(y)\fP.
The real part of y is chosen in the interval [\-pi/2,pi/2]. The real part of y is chosen in the interval [\-pi/2,pi/2].

View File

@ -19,9 +19,7 @@ catanh, catanhf, catanhl \- complex arc tangents hyperbolic
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions calculate the complex arc hyperbolic tangent of
.BR catanh ()
function calculates the complex arc hyperbolic tangent of
.IR z . .IR z .
If \fIy\ =\ catanh(z)\fP, then \fIz\ =\ ctanh(y)\fP. If \fIy\ =\ catanh(z)\fP, then \fIz\ =\ ctanh(y)\fP.
The imaginary part of The imaginary part of

View File

@ -70,9 +70,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the (real) cube root of
.BR cbrt ()
function returns the (real) cube root of
.IR x . .IR x .
This function cannot fail; every representable real value has a This function cannot fail; every representable real value has a
representable real cube root. representable real cube root.

View File

@ -18,7 +18,7 @@ cexp, cexpf, cexpl \- complex exponential function
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The function calculates e (2.71828..., the base of natural logarithms) These functions calculate e (2.71828..., the base of natural logarithms)
raised to the power of raised to the power of
.IR z . .IR z .
.LP .LP

View File

@ -18,9 +18,7 @@ cimag, cimagf, cimagl \- get imaginary part of a complex number
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the imaginary part of the complex number
.BR cimag ()
function returns the imaginary part of the complex number
.IR z . .IR z .
.LP .LP
One has: One has:

View File

@ -18,9 +18,7 @@ conj, conjf, conjl \- calculate the complex conjugate
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the complex conjugate value of
.BR conj ()
function returns the complex conjugate value of
.IR z . .IR z .
That is the value obtained by changing the sign of the imaginary part. That is the value obtained by changing the sign of the imaginary part.
.LP .LP

View File

@ -62,13 +62,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return a value whose absolute value matches that of
.BR copysign (),
.BR copysignf (),
and
.BR copysignl ()
functions return a value whose absolute value matches
that of
.IR x , .IR x ,
but whose sign bit matches that of but whose sign bit matches that of
.IR y . .IR y .

View File

@ -64,9 +64,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the cosine of
.BR cos ()
function returns the cosine of
.IR x , .IR x ,
where where
.I x .I x

View File

@ -66,12 +66,9 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the hyperbolic cosine of
.BR cosh ()
function returns the hyperbolic cosine of
.IR x , .IR x ,
which which is defined mathematically as:
is defined mathematically as:
.nf .nf
cosh(x) = (exp(x) + exp(\-x)) / 2 cosh(x) = (exp(x) + exp(\-x)) / 2

View File

@ -21,11 +21,11 @@ cpow, cpowf, cpowl \- complex power function
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The function calculates These functions calculate
.I x .I x
raised to the power raised to the power
.IR z . .IR z
(With a branch cut for (with a branch cut for
.I x .I x
along the negative real axis.) along the negative real axis.)
.SH VERSIONS .SH VERSIONS

View File

@ -18,9 +18,7 @@ creal, crealf, creall \- get real part of a complex number
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the real part of the complex number
.BR creal ()
function returns the real part of the complex number
.IR z . .IR z .
.LP .LP
One has: One has:

View File

@ -72,12 +72,9 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the error function of
.BR erf ()
function returns the error function of
.IR x , .IR x ,
defined defined as
as
.TP .TP
erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(\-t*t) dt erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(\-t*t) dt
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -63,9 +63,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the complementary error function of
.BR erfc ()
function returns the complementary error function of
.IR x , .IR x ,
that is, 1.0 \- erf(x). that is, 1.0 \- erf(x).
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -66,9 +66,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the value of e (the base of natural
.BR exp ()
function returns the value of e (the base of natural
logarithms) raised to the power of logarithms) raised to the power of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -50,9 +50,7 @@ exp10, exp10f, exp10l \- base-10 exponential function
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the value of 10
.BR exp10 ()
function returns the value of 10
raised to the power of raised to the power of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -66,10 +66,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the value of 2 raised to the power of
.BR exp2 ()
function returns the value of 2
raised to the power of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE
On success, these functions return the base-2 exponential value of On success, these functions return the base-2 exponential value of

View File

@ -70,15 +70,13 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
.I expm1(x) These functions return a value equivalent to
returns a value equivalent to
.nf .nf
exp(x) \- 1 exp(x) \- 1
.fi .fi
It is The result is computed in a way that is accurate even if the value of
computed in a way that is accurate even if the value of
.I x .I x
is near is near
zero\(ema case where zero\(ema case where

View File

@ -43,9 +43,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions compute
.BR fma ()
function computes
.IR x " * " y " + " z . .IR x " * " y " + " z .
The result is rounded as one ternary operation according to the The result is rounded as one ternary operation according to the
current rounding mode (see current rounding mode (see

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions compute the floating-point remainder of dividing
.BR fmod ()
function computes the floating-point remainder of dividing
.I x .I x
by by
.IR y . .IR y .

View File

@ -64,17 +64,13 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions are used to split the number
.BR frexp ()
function is used to split the number
.I x .I x
into a into a
normalized fraction and an exponent which is stored in normalized fraction and an exponent which is stored in
.IR exp . .IR exp .
.SH RETURN VALUE .SH RETURN VALUE
The These functions return the normalized fraction.
.BR frexp ()
function returns the normalized fraction.
If the argument If the argument
.I x .I x
is not zero, is not zero,

View File

@ -72,9 +72,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return
.BR hypot ()
function returns
.RI sqrt( x * x + y * y ). .RI sqrt( x * x + y * y ).
This is the length of the hypotenuse of a right-angled triangle This is the length of the hypotenuse of a right-angled triangle
with sides of length with sides of length

View File

@ -64,9 +64,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the result of multiplying the floating-point number
.BR ldexp ()
function returns the result of multiplying the floating-point number
.I x .I x
by 2 raised to the power by 2 raised to the power
.IR exp . .IR exp .

View File

@ -73,8 +73,11 @@ For the definition of the Gamma function, see
.BR tgamma (3). .BR tgamma (3).
.PP .PP
The The
.BR lgamma () .BR lgamma (),
function returns the natural logarithm of .BR lgammaf (),
and
.BR lgammal ()
functions return the natural logarithm of
the absolute value of the Gamma function. the absolute value of the Gamma function.
The sign of the Gamma function is returned in the The sign of the Gamma function is returned in the
external integer external integer

View File

@ -66,9 +66,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the natural logarithm of
.BR log ()
function returns the natural logarithm of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE
On success, these functions return the natural logarithm of On success, these functions return the natural logarithm of

View File

@ -66,9 +66,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the base 10 logarithm of
.BR log10 ()
function returns the base 10 logarithm of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE
On success, these functions return the base 10 logarithm of On success, these functions return the base 10 logarithm of

View File

@ -69,14 +69,13 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
.I log1p(x) These functions return a value equivalent to
returns a value equivalent to
.nf .nf
log (1 + \fIx\fP) log (1 + \fIx\fP)
.fi .fi
It is computed in a way The result is computed in a way
that is accurate even if the value of that is accurate even if the value of
.I x .I x
is near zero. is near zero.

View File

@ -66,9 +66,7 @@ or
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the base 2 logarithm of
.BR log2 ()
function returns the base 2 logarithm of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE
On success, these functions return the base 2 logarithm of On success, these functions return the base 2 logarithm of

View File

@ -64,9 +64,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions break the argument
.BR modf ()
function breaks the argument
.I x .I x
into an integral into an integral
part and a fractional part, each of which has the same sign as part and a fractional part, each of which has the same sign as
@ -74,9 +72,7 @@ part and a fractional part, each of which has the same sign as
The integral part is stored in the location pointed to by The integral part is stored in the location pointed to by
.IR iptr . .IR iptr .
.SH RETURN VALUE .SH RETURN VALUE
The These functions return the fractional part of
.BR modf ()
function returns the fractional part of
.IR x . .IR x .
If If

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the value of
.BR pow ()
function returns the value of
.I x .I x
raised to the raised to the
power of power of

View File

@ -39,10 +39,7 @@ pow10, pow10f, pow10l \- base-10 power functions
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the value of 10 raised to the power
.BR pow10 ()
function returns the value of 10 raised to the
power
.IR x . .IR x .
.SH VERSIONS .SH VERSIONS
These functions first appeared in glibc in version 2.1. These functions first appeared in glibc in version 2.1.

View File

@ -90,9 +90,8 @@ _SVID_SOURCE || _BSD_SOURCE
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These
.BR remainder () functions compute the remainder of dividing
function computes the remainder of dividing
.I x .I x
by by
.IR y . .IR y .

View File

@ -35,12 +35,10 @@ _SVID_SOURCE || _BSD_SOURCE
.RE .RE
.ad b .ad b
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the mantissa of
.BR significand ()
function returns the mantissa of
.I x .I x
scaled to the range [1,2). scaled to the range [1,2).
It is equivalent to They are equivalent to
.sp .sp
.in +4n .in +4n
scalb(x, (double) \-ilogb(x)) scalb(x, (double) \-ilogb(x))

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the sine of
.BR sin ()
function returns the sine of
.IR x , .IR x ,
where where
.I x .I x

View File

@ -66,9 +66,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the hyperbolic sine of
.BR sinh ()
function returns the hyperbolic sine of
.IR x , .IR x ,
which which
is defined mathematically as: is defined mathematically as:

View File

@ -64,9 +64,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the nonnegative square root of
.BR sqrt ()
function returns the nonnegative square root of
.IR x . .IR x .
.SH RETURN VALUE .SH RETURN VALUE
On success, these functions return the square root of On success, these functions return the square root of

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the tangent of
.BR tan ()
function returns the tangent of
.IR x , .IR x ,
where where
.I x .I x

View File

@ -65,9 +65,7 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
The These functions return the hyperbolic tangent of
.BR tanh ()
function returns the hyperbolic tangent of
.IR x , .IR x ,
which which
is defined mathematically as: is defined mathematically as:

View File

@ -42,6 +42,9 @@ or
.RE .RE
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
These functions calculate the Gamma function of
.IR x .
The Gamma function is defined by The Gamma function is defined by
.sp .sp
Gamma(x) = integral from 0 to infinity of t^(x\-1) e^\-t dt Gamma(x) = integral from 0 to infinity of t^(x\-1) e^\-t dt