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:57 +00:00
parent 1e2209ddde
commit a6d7b49b06
1 changed files with 56 additions and 20 deletions

View File

@ -1,4 +1,6 @@
.\" 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
.\" manual provided the copyright notice and this permission notice are
@ -28,7 +30,7 @@
.\" Modified 2002-07-25 by Walter Harms
.\" (walter.harms@informatik.uni-oldenburg.de)
.\"
.TH ASIN 3 2002-07-25 "" "Linux Programmer's Manual"
.TH ASIN 3 2008-07-29 "" "Linux Programmer's Manual"
.SH NAME
asin, asinf, asinl \- arc sine function
.SH SYNOPSIS
@ -43,32 +45,66 @@ asin, asinf, asinl \- arc sine function
.fi
.sp
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 asinf (),
.BR asinl ():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
.I cc\ -std=c99
.ad b
.SH DESCRIPTION
The
.BR asin ()
function calculates the arc sine of \fIx\fP; that is
the value whose sine is \fIx\fP.
If \fIx\fP falls outside the range
\-1 to 1,
.BR asin ()
fails and \fIerrno\fP is set.
function calculates the principal value of the arc sine of \fIx\fP;
that is the value whose sine is \fIx\fP.
.SH "RETURN VALUE"
The
.BR asin ()
function returns the arc sine in radians and the
value is mathematically defined to be between \-PI/2 and PI/2
(inclusive).
On success, these functions return the principal value of the arc sine of
.IR x
in radians; the return value is in the range [\-pi/2,\ pi/2].
If
.I x
is a NaN, a NaN is returned.
If
.I x
is +0 (\-0),
+0 (\-0) is returned.
If
.I x
outside the range [\-1,\ 1],
a "domain error" occurs,
and a NaN is returned.
.\"
.\" POSIX.1-2001 documents an optional range error for subnormal x;
.\" glibc 2.8 does not do this.
.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
.B EDOM
\fIx\fP is out of range.
Domain error: \fIx\fP is outside the range [\-1,\ 1]
.I errno
is set to
.BR EDOM .
An invalid floating-point exception
.RB ( FE_INVALID )
is raised.
.SH "CONFORMING TO"
SVr4, POSIX.1-2001, 4.3BSD, C89, C99.
The
.I float
and
.I "long double"
variants are C99 requirements.
C99, POSIX.1-2001.
The variant returning
.I double
also conforms to
SVr4, 4.3BSD, C89.
.SH "SEE ALSO"
.BR acos (3),
.BR atan (3),