[thirdparty/man-pages.git] / man3 / sinh.3

.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
.\"     <mtk.manpages@gmail.com>
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
.\" Modified 1996-06-08 by aeb
.\" Modified 2002-07-27 by Walter Harms
.\" 	(walter.harms@informatik.uni-oldenburg.de)
.\"
.TH SINH 3  2016-03-15 "" "Linux Programmer's Manual"
.SH NAME
sinh, sinhf, sinhl \- hyperbolic sine function
.SH SYNOPSIS
.nf
.B #include <math.h>
.sp
.BI "double sinh(double " x );
.br
.BI "float sinhf(float " x );
.br
.BI "long double sinhl(long double " x );
.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 ():
.RS 4
_ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L
    || /* Since glibc 2.19: */ _DEFAULT_SOURCE
    || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
.RE
.ad
.SH DESCRIPTION
These functions return the hyperbolic sine of
.IR x ,
which
is defined mathematically as:
.nf

    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 ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lbw24 lb lb
l l l.
Interface	Attribute	Value
T{
.BR sinh (),
.BR sinhf (),
.BR sinhl ()
T}	Thread safety	MT-Safe
.TE
.SH CONFORMING TO
C99, POSIX.1-2001, POSIX.1-2008.

The variant returning
.I double
also conforms to
SVr4, 4.3BSD, C89.
.SH SEE ALSO
.BR acosh (3),
.BR asinh (3),
.BR atanh (3),
.BR cosh (3),
.BR csinh (3),
.BR tanh (3)
Commit	Line	Data
	1	.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
	2	.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
	3	.\" <mtk.manpages@gmail.com>
	4	.\"
	5	.\" %%%LICENSE_START(VERBATIM)
	6	.\" Permission is granted to make and distribute verbatim copies of this
	7	.\" manual provided the copyright notice and this permission notice are
	8	.\" preserved on all copies.
	9	.\"
	10	.\" Permission is granted to copy and distribute modified versions of this
	11	.\" manual under the conditions for verbatim copying, provided that the
	12	.\" entire resulting derived work is distributed under the terms of a
	13	.\" permission notice identical to this one.
	14	.\"
	15	.\" Since the Linux kernel and libraries are constantly changing, this
	16	.\" manual page may be incorrect or out-of-date. The author(s) assume no
	17	.\" responsibility for errors or omissions, or for damages resulting from
	18	.\" the use of the information contained herein. The author(s) may not
	19	.\" have taken the same level of care in the production of this manual,
	20	.\" which is licensed free of charge, as they might when working
	21	.\" professionally.
	22	.\"
	23	.\" Formatted or processed versions of this manual, if unaccompanied by
	24	.\" the source, must acknowledge the copyright and authors of this work.
	25	.\" %%%LICENSE_END
	26	.\"
	27	.\" References consulted:
	28	.\" Linux libc source code
	29	.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
	30	.\" 386BSD man pages
	31	.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
	32	.\" Modified 1996-06-08 by aeb
	33	.\" Modified 2002-07-27 by Walter Harms
	34	.\" (walter.harms@informatik.uni-oldenburg.de)
	35	.\"
	36	.TH SINH 3 2016-03-15 "" "Linux Programmer's Manual"
	37	.SH NAME
	38	sinh, sinhf, sinhl \- hyperbolic sine function
	39	.SH SYNOPSIS
	40	.nf
	41	.B #include <math.h>
	42	.sp
	43	.BI "double sinh(double " x );
	44	.br
	45	.BI "float sinhf(float " x );
	46	.br
	47	.BI "long double sinhl(long double " x );
	48	.fi
	49	.sp
	50	Link with \fI\-lm\fP.
	51	.sp
	52	.in -4n
	53	Feature Test Macro Requirements for glibc (see
	54	.BR feature_test_macros (7)):
	55	.in
	56	.sp
	57	.ad l
	58	.BR sinhf (),
	59	.BR sinhl ():
	60	.RS 4
	61	_ISOC99_SOURCE \|\| _POSIX_C_SOURCE\ >=\ 200112L
	62	\|\| /* Since glibc 2.19: */ _DEFAULT_SOURCE
	63	\|\| /* Glibc versions <= 2.19: */ _BSD_SOURCE \|\| _SVID_SOURCE
	64	.RE
	65	.ad
	66	.SH DESCRIPTION
	67	These functions return the hyperbolic sine of
	68	.IR x ,
	69	which
	70	is defined mathematically as:
	71	.nf
	72
	73	sinh(x) = (exp(x) \- exp(\-x)) / 2
	74	.fi
	75	.SH RETURN VALUE
	76	On success, these functions return the hyperbolic sine of
	77	.IR x .
	78
	79	If
	80	.I x
	81	is a NaN, a NaN is returned.
	82
	83	If
	84	.I x
	85	is +0 (\-0), +0 (\-0) is returned.
	86
	87	If
	88	.I x
	89	is positive infinity (negative infinity),
	90	positive infinity (negative infinity) is returned.
	91
	92	If the result overflows,
	93	a range error occurs,
	94	and the functions return
	95	.BR HUGE_VAL ,
	96	.BR HUGE_VALF ,
	97	or
	98	.BR HUGE_VALL ,
	99	respectively, with the same sign as
	100	.IR x .
	101	.\"
	102	.\" POSIX.1-2001 documents an optional range error (underflow)
	103	.\" for subnormal x;
	104	.\" glibc 2.8 does not do this.
	105	.SH ERRORS
	106	See
	107	.BR math_error (7)
	108	for information on how to determine whether an error has occurred
	109	when calling these functions.
	110	.PP
	111	The following errors can occur:
	112	.TP
	113	Range error: result overflow
	114	.I errno
	115	is set to
	116	.BR ERANGE .
	117	An overflow floating-point exception
	118	.RB ( FE_OVERFLOW )
	119	is raised.
	120	.SH ATTRIBUTES
	121	For an explanation of the terms used in this section, see
	122	.BR attributes (7).
	123	.TS
	124	allbox;
	125	lbw24 lb lb
	126	l l l.
	127	Interface Attribute Value
	128	T{
	129	.BR sinh (),
	130	.BR sinhf (),
	131	.BR sinhl ()
	132	T} Thread safety MT-Safe
	133	.TE
	134	.SH CONFORMING TO
	135	C99, POSIX.1-2001, POSIX.1-2008.
	136
	137	The variant returning
	138	.I double
	139	also conforms to
	140	SVr4, 4.3BSD, C89.
	141	.SH SEE ALSO
	142	.BR acosh (3),
	143	.BR asinh (3),
	144	.BR atanh (3),
	145	.BR cosh (3),
	146	.BR csinh (3),
	147	.BR tanh (3)