SYNOPSIS: Added feature test macro requirements.

RETURN VALUE: Added details for special argument cases.
Rewrote ERRORS section.
Updated CONFORMING TO.
This commit is contained in:
Michael Kerrisk 2008-08-01 05:25:55 +00:00
parent d27e22f5b0
commit e279ffc370
1 changed files with 57 additions and 17 deletions

View File

@ -1,4 +1,6 @@
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
.\" <mtk.manpages@gmail.com>
.\" .\"
.\" Permission is granted to make and distribute verbatim copies of this .\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are .\" manual provided the copyright notice and this permission notice are
@ -28,7 +30,7 @@
.\" Modified 2002-07-25 by Walter Harms .\" Modified 2002-07-25 by Walter Harms
.\" (walter.harms@informatik.uni-oldenburg.de) .\" (walter.harms@informatik.uni-oldenburg.de)
.\" .\"
.TH ACOS 3 2004-10-06 "" "Linux Programmer's Manual" .TH ACOS 3 2008-07-29 "" "Linux Programmer's Manual"
.SH NAME .SH NAME
acos, acosf, acosl \- arc cosine function acos, acosf, acosl \- arc cosine function
.SH SYNOPSIS .SH SYNOPSIS
@ -41,31 +43,69 @@ acos, acosf, acosl \- arc cosine function
.fi .fi
.sp .sp
Link with \fI\-lm\fP. Link with \fI\-lm\fP.
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.ad l
.BR acosf (),
.BR acosl ():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
.I cc\ -std=c99
.ad b
.SH DESCRIPTION .SH DESCRIPTION
The The
.BR acos () .BR acos ()
function calculates the arc cosine of \fIx\fP; that is function calculates the arc cosine of \fIx\fP; that is
the value whose cosine is \fIx\fP. the value whose cosine is \fIx\fP.
If \fIx\fP falls outside the range
\-1 to 1,
.BR acos ()
fails and \fIerrno\fP is set.
.SH "RETURN VALUE" .SH "RETURN VALUE"
The On success, these functions return the arc cosine of
.BR acos () .IR x
function returns the arc cosine in radians and the in radians; the return value is in the range [0,\ pi].
value is mathematically defined to be between 0 and PI (inclusive).
If
.I x
is a NaN, a NaN is returned.
If
.I x
is +1,
+0 is returned.
If
.I x
is positive infinity or negative infinity,
a "domain error" occurs,
and a NaN is returned.
If
.I x
is outside the range [\-1,\ 1],
a "domain error" occurs,
and a NaN is returned.
.SH ERRORS .SH ERRORS
See
.BR math_error (7)
for information on how to determine whether an error has occurred
when calling these functions.
.PP
The following errors can occur:
.TP .TP
.B EDOM Domain error: \fIx\fP is outside the range [\-1,\ 1]
\fIx\fP is out of range. .I errno
is set to
.BR EDOM .
An invalid floating-point exception
.RB ( FE_INVALID )
is raised.
.SH "CONFORMING TO" .SH "CONFORMING TO"
SVr4, POSIX.1-2001, 4.3BSD, C89, C99. C99, POSIX.1-2001.
The The variant returning
.I float .I double
and also conforms to
.I "long double" SVr4, 4.3BSD, C89.
variants are C99 requirements.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR asin (3), .BR asin (3),
.BR atan (3), .BR atan (3),