diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2008-08-01 05:25:56 +0000 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2008-08-01 05:25:56 +0000 |
| commit | 1e2209ddde4a27d56e3ff31487dba4c8e07c33b6 (patch) | |
| tree | d6678d39d3a897c43e6955c4b98a937762cf1160 /man3 | |
| parent | e279ffc37081cbb676d35b444e1b8638cf10530e (diff) | |
| download | man-pages-1e2209ddde4a27d56e3ff31487dba4c8e07c33b6.tar.gz | |
SYNOPSIS: Fixed feature test macro requirements.
Added RETURN VALUE section.
Rewrote ERRORS section.
Updated CONFORMING TO.
Diffstat (limited to 'man3')
| -rw-r--r-- | man3/acosh.3 | 62 |
1 files changed, 47 insertions, 15 deletions
diff --git a/man3/acosh.3 b/man3/acosh.3 index afa554e0d7..f9362e1748 100644 --- a/man3/acosh.3 +++ b/man3/acosh.3 @@ -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 ACOSH 3 2007-07-26 "" "Linux Programmer's Manual" +.TH ACOSH 3 2008-07-29 "" "Linux Programmer's Manual" .SH NAME acosh, acoshf, acoshl \- inverse hyperbolic cosine function .SH SYNOPSIS @@ -50,10 +52,13 @@ Feature Test Macro Requirements for glibc (see .in .sp .ad l -.BR acosh (), +.BR acosh (): +_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE; or +.I cc\ -std=c99 +.br .BR acoshf (), .BR acoshl (): -_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE; or +_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or .I cc\ -std=c99 .ad b .SH DESCRIPTION @@ -61,21 +66,48 @@ The .BR acosh () function calculates the inverse hyperbolic cosine of \fIx\fP; that is the value whose hyperbolic cosine is \fIx\fP. -If \fIx\fP is less than 1.0, -.BR acosh () -returns -not-a-number (NaN) and \fIerrno\fP is set. +.SH "RETURN VALUE" +On success, these functions return the inverse hyperbolic cosine of +.IR x . + +If +.I x +is a NaN, a NaN is returned. + +If +.I x +is +1, +0 is returned. + +If +.I x +is positive infinity, positive infinity is returned. + +If +.I x +is less than 1, +a "domain error" occurs, +and the functions return a NaN. .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 less than 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. -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 asinh (3), .BR atanh (3), |