SYNOPSIS: Added feature test macro requirements.

Added RETURN VALUE section.
Added ERRORS section.
Updated CONFORMING TO.
This commit is contained in:
Michael Kerrisk 2008-08-01 05:26:45 +00:00
parent 48dabc9060
commit 4a3c2783c1
1 changed files with 64 additions and 6 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
@ -29,7 +31,7 @@
.\" Modified 2002-07-27 by Walter Harms
.\" (walter.harms@informatik.uni-oldenburg.de)
.\"
.TH SINH 3 2007-12-26 "" "Linux Programmer's Manual"
.TH SINH 3 2008-07-29 "" "Linux Programmer's Manual"
.SH NAME
sinh, sinhf, sinhl \- hyperbolic sine function
.SH SYNOPSIS
@ -44,6 +46,18 @@ sinh, sinhf, sinhl \- hyperbolic 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 sinhf (),
.BR sinhl ():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
.I cc\ -std=c99
.ad b
.SH DESCRIPTION
The
.BR sinh ()
@ -53,13 +67,57 @@ is defined mathematically as:
sinh(x) = (exp(x) \- exp(\-x)) / 2
.fi
.SH "RETURN VALUE"
On success, these functions return the hyperbolic sine of
.IR x .
If
.I x
is a NaN, a NaN is returned.
If
.I x
is +0 (\-0), +0 (\-0) is returned.
If
.I x
is positive infinity (negative infinity),
positive infinity (negative infinity) is returned.
If the result overflows,
a "range error" occurs,
and the functions return
.BR HUGE_VAL ,
.BR HUGE_VALF ,
or
.BR HUGE_VALL ,
respectively, with the same sign as
.IR x .
.\"
.\" POSIX.1-2001 documents an optional range error (underflow)
.\" 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
Range error: result overflow
.I errno
is set to
.BR ERANGE .
An overflow floating-point exception
.RB ( FE_OVERFLOW )
is raised.
.SH "CONFORMING TO"
C99, POSIX.1-2001.
The variant returning
.I double
also conforms to
SVr4, 4.3BSD, C89.
The
.I float
and
.I "long double"
variants are C99 requirements.
.SH "SEE ALSO"
.BR acosh (3),
.BR asinh (3),