math(3): Use the .Fa macro for function arguments
.Fa is the suitable macro for functions in comparsion to the .Ar macro, which should be used for commandline arguments. While here, fix some mandoc warnings. Reviewed by: imp (earlier version) Obtained from: OpenBSD (in partial) MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D31090
This commit is contained in:
parent
9e3761d126
commit
c5cbef2f85
@ -60,7 +60,7 @@ These functions return the arc cosine in the range
|
|||||||
radians.
|
radians.
|
||||||
If:
|
If:
|
||||||
.Bd -unfilled -offset indent
|
.Bd -unfilled -offset indent
|
||||||
.Pf \&| Ns Ar x Ns \&| > 1 ,
|
.Pf \&| Ns Fa x Ns \&| > 1 ,
|
||||||
.Ed
|
.Ed
|
||||||
.Pp
|
.Pp
|
||||||
.Fn acos x
|
.Fn acos x
|
||||||
|
@ -55,13 +55,13 @@ and
|
|||||||
functions compute the inverse hyperbolic cosine
|
functions compute the inverse hyperbolic cosine
|
||||||
of the real
|
of the real
|
||||||
argument
|
argument
|
||||||
.Ar x .
|
.Fa x .
|
||||||
For a discussion of error due to roundoff, see
|
For a discussion of error due to roundoff, see
|
||||||
.Xr math 3 .
|
.Xr math 3 .
|
||||||
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
||||||
These functions
|
These functions
|
||||||
return the inverse hyperbolic cosine of
|
return the inverse hyperbolic cosine of
|
||||||
.Ar x .
|
.Fa x .
|
||||||
If the argument is less than 1,
|
If the argument is less than 1,
|
||||||
.Fn acosh
|
.Fn acosh
|
||||||
raises an invalid exception and returns an \*(Na.
|
raises an invalid exception and returns an \*(Na.
|
||||||
|
@ -62,7 +62,7 @@ These functions return the arc sine in the range
|
|||||||
radians.
|
radians.
|
||||||
If:
|
If:
|
||||||
.Bd -unfilled -offset indent
|
.Bd -unfilled -offset indent
|
||||||
.Pf \&| Ns Ar x Ns \&| > 1
|
.Pf \&| Ns Fa x Ns \&| > 1
|
||||||
.Ed
|
.Ed
|
||||||
.Pp
|
.Pp
|
||||||
.Fn asin x
|
.Fn asin x
|
||||||
|
@ -55,13 +55,13 @@ and
|
|||||||
functions compute the inverse hyperbolic sine
|
functions compute the inverse hyperbolic sine
|
||||||
of the real
|
of the real
|
||||||
argument
|
argument
|
||||||
.Ar x .
|
.Fa x .
|
||||||
For a discussion of error due to roundoff, see
|
For a discussion of error due to roundoff, see
|
||||||
.Xr math 3 .
|
.Xr math 3 .
|
||||||
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
||||||
These functions
|
These functions
|
||||||
return the inverse hyperbolic sine of
|
return the inverse hyperbolic sine of
|
||||||
.Ar x .
|
.Fa x .
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr acosh 3 ,
|
.Xr acosh 3 ,
|
||||||
.Xr atanh 3 ,
|
.Xr atanh 3 ,
|
||||||
|
@ -63,7 +63,7 @@ The
|
|||||||
and
|
and
|
||||||
.Fn atan2l
|
.Fn atan2l
|
||||||
functions compute the principal value of the arc tangent of
|
functions compute the principal value of the arc tangent of
|
||||||
.Fa y/ Ns Ar x ,
|
.Fa y/ Ns Fa x ,
|
||||||
using the signs of both arguments to determine the quadrant of
|
using the signs of both arguments to determine the quadrant of
|
||||||
the return value.
|
the return value.
|
||||||
.Pp
|
.Pp
|
||||||
@ -94,7 +94,7 @@ and
|
|||||||
.Fn atan2l
|
.Fn atan2l
|
||||||
functions, if successful,
|
functions, if successful,
|
||||||
return the arc tangent of
|
return the arc tangent of
|
||||||
.Fa y/ Ns Ar x
|
.Fa y/ Ns Fa x
|
||||||
in the range
|
in the range
|
||||||
.Bk -words
|
.Bk -words
|
||||||
.Bq \&- Ns \*(Pi , \&+ Ns \*(Pi
|
.Bq \&- Ns \*(Pi , \&+ Ns \*(Pi
|
||||||
@ -105,22 +105,22 @@ Here are some of the special cases:
|
|||||||
.It Fn atan2 y x No := Ta
|
.It Fn atan2 y x No := Ta
|
||||||
.Fn atan y/x Ta
|
.Fn atan y/x Ta
|
||||||
if
|
if
|
||||||
.Ar x
|
.Fa x
|
||||||
> 0,
|
> 0,
|
||||||
.It Ta sign( Ns Ar y Ns )*(\*(Pi -
|
.It Ta sign( Ns Fa y Ns )*(\*(Pi -
|
||||||
.Fn atan "\*(Bay/x\*(Ba" ) Ta
|
.Fn atan "\*(Bay/x\*(Ba" ) Ta
|
||||||
if
|
if
|
||||||
.Ar x
|
.Fa x
|
||||||
< 0,
|
< 0,
|
||||||
.It Ta
|
.It Ta
|
||||||
.No 0 Ta
|
.No 0 Ta
|
||||||
if x = y = 0, or
|
if x = y = 0, or
|
||||||
.It Ta
|
.It Ta
|
||||||
.Pf sign( Ar y Ns )*\*(Pi/2 Ta
|
.Pf sign( Fa y Ns )*\*(Pi/2 Ta
|
||||||
if
|
if
|
||||||
.Ar x
|
.Fa x
|
||||||
= 0 \(!=
|
= 0 \(!=
|
||||||
.Ar y .
|
.Fa y .
|
||||||
.El
|
.El
|
||||||
.Sh NOTES
|
.Sh NOTES
|
||||||
The function
|
The function
|
||||||
|
@ -55,18 +55,18 @@ and
|
|||||||
functions compute the inverse hyperbolic tangent
|
functions compute the inverse hyperbolic tangent
|
||||||
of the real
|
of the real
|
||||||
argument
|
argument
|
||||||
.Ar x .
|
.Fa x .
|
||||||
For a discussion of error due to roundoff, see
|
For a discussion of error due to roundoff, see
|
||||||
.Xr math 3 .
|
.Xr math 3 .
|
||||||
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
||||||
These functions
|
These functions
|
||||||
return the inverse hyperbolic tangent of
|
return the inverse hyperbolic tangent of
|
||||||
.Ar x
|
.Fa x
|
||||||
if successful.
|
if successful.
|
||||||
If the argument has absolute value 1, a divide-by-zero exception
|
If the argument has absolute value 1, a divide-by-zero exception
|
||||||
is raised and an infinity is returned.
|
is raised and an infinity is returned.
|
||||||
If
|
If
|
||||||
.Ar |x|
|
.Fa |x|
|
||||||
> 1, an invalid exception is raised and an \*(Na is returned.
|
> 1, an invalid exception is raised and an \*(Na is returned.
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr acosh 3 ,
|
.Xr acosh 3 ,
|
||||||
|
@ -31,7 +31,7 @@
|
|||||||
.Nm ccos ,
|
.Nm ccos ,
|
||||||
.Nm ccosf ,
|
.Nm ccosf ,
|
||||||
.Nm csin ,
|
.Nm csin ,
|
||||||
.Nm csinf
|
.Nm csinf ,
|
||||||
.Nm ctan ,
|
.Nm ctan ,
|
||||||
.Nm ctanf
|
.Nm ctanf
|
||||||
.Nd complex trigonometric functions
|
.Nd complex trigonometric functions
|
||||||
|
@ -31,7 +31,7 @@
|
|||||||
.Nm ccosh ,
|
.Nm ccosh ,
|
||||||
.Nm ccoshf ,
|
.Nm ccoshf ,
|
||||||
.Nm csinh ,
|
.Nm csinh ,
|
||||||
.Nm csinhf
|
.Nm csinhf ,
|
||||||
.Nm ctanh ,
|
.Nm ctanh ,
|
||||||
.Nm ctanhf
|
.Nm ctanhf
|
||||||
.Nd complex hyperbolic functions
|
.Nd complex hyperbolic functions
|
||||||
|
@ -108,9 +108,9 @@ and the
|
|||||||
.Fn powl
|
.Fn powl
|
||||||
functions compute the value
|
functions compute the value
|
||||||
of
|
of
|
||||||
.Ar x
|
.Fa x
|
||||||
to the exponent
|
to the exponent
|
||||||
.Ar y .
|
.Fa y .
|
||||||
.Sh ERROR (due to Roundoff etc.)
|
.Sh ERROR (due to Roundoff etc.)
|
||||||
The values of
|
The values of
|
||||||
.Fn exp 0 ,
|
.Fn exp 0 ,
|
||||||
@ -181,8 +181,8 @@ then \*(Na**0 = 1 too because x**0 = 1 for all finite
|
|||||||
and infinite x, i.e., independently of x.
|
and infinite x, i.e., independently of x.
|
||||||
.El
|
.El
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr clog 3
|
.Xr clog 3 ,
|
||||||
.Xr cpow 3
|
.Xr cpow 3 ,
|
||||||
.Xr fenv 3 ,
|
.Xr fenv 3 ,
|
||||||
.Xr ldexp 3 ,
|
.Xr ldexp 3 ,
|
||||||
.Xr log 3 ,
|
.Xr log 3 ,
|
||||||
|
@ -67,13 +67,13 @@ Upon returning from
|
|||||||
and
|
and
|
||||||
.Fn sincosl ,
|
.Fn sincosl ,
|
||||||
the memory pointed to by
|
the memory pointed to by
|
||||||
.Ar "*s"
|
.Fa "*s"
|
||||||
and
|
and
|
||||||
.Ar "*c"
|
.Fa "*c"
|
||||||
are assigned the values of sine and cosine, respectively.
|
are assigned the values of sine and cosine, respectively.
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr cos 3 ,
|
.Xr cos 3 ,
|
||||||
.Xr sin 3 ,
|
.Xr sin 3
|
||||||
.Sh HISTORY
|
.Sh HISTORY
|
||||||
These functions were added to
|
These functions were added to
|
||||||
.Fx 9.0
|
.Fx 9.0
|
||||||
|
@ -63,7 +63,7 @@ and
|
|||||||
.Fn cbrtl
|
.Fn cbrtl
|
||||||
functions compute
|
functions compute
|
||||||
the cube root of
|
the cube root of
|
||||||
.Ar x .
|
.Fa x .
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The
|
||||||
.Fn sqrt ,
|
.Fn sqrt ,
|
||||||
@ -72,7 +72,7 @@ and
|
|||||||
.Fn sqrtl
|
.Fn sqrtl
|
||||||
functions compute the
|
functions compute the
|
||||||
non-negative square root of
|
non-negative square root of
|
||||||
.Ar x .
|
.Fa x .
|
||||||
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
||||||
The
|
The
|
||||||
.Fn cbrt ,
|
.Fn cbrt ,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user