Blame man3/cosh.3

Packit 7cfc04
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
Packit 7cfc04
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
Packit 7cfc04
.\"     <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" References consulted:
Packit 7cfc04
.\"     Linux libc source code
Packit 7cfc04
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
Packit 7cfc04
.\"     386BSD man pages
Packit 7cfc04
.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
Packit 7cfc04
.\" Modified 1996-06-08 by aeb
Packit 7cfc04
.\" Modified 2002-07-27 by Walter Harms
Packit 7cfc04
.\" (walter.harms@informatik.uni-oldenburg.de)
Packit 7cfc04
.\"
Packit 7cfc04
.TH COSH 3 2017-09-15 ""  "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
cosh, coshf, coshl \- hyperbolic cosine function
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <math.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "double cosh(double " x );
Packit 7cfc04
.BI "float coshf(float " x );
Packit 7cfc04
.BI "long double coshl(long double " x );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
Link with \fI\-lm\fP.
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.ad l
Packit 7cfc04
.BR coshf (),
Packit 7cfc04
.BR coshl ():
Packit 7cfc04
.RS 4
Packit 7cfc04
_ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L
Packit 7cfc04
    || /* Since glibc 2.19: */ _DEFAULT_SOURCE
Packit 7cfc04
    || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
Packit 7cfc04
.RE
Packit 7cfc04
.ad
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
These functions return the hyperbolic cosine of
Packit 7cfc04
.IR x ,
Packit 7cfc04
which is defined mathematically as:
Packit 7cfc04
.PP
Packit 7cfc04
.nf
Packit 7cfc04
    cosh(x) = (exp(x) + exp(\-x)) / 2
Packit 7cfc04
.fi
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
On success, these functions return the hyperbolic cosine of
Packit 7cfc04
.IR x .
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is a NaN, a NaN is returned.
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is +0 or \-0, 1 is returned.
Packit 7cfc04
.PP
Packit 7cfc04
If
Packit 7cfc04
.I x
Packit 7cfc04
is positive infinity or negative infinity,
Packit 7cfc04
positive infinity is returned.
Packit 7cfc04
.PP
Packit 7cfc04
If the result overflows,
Packit 7cfc04
a range error occurs,
Packit 7cfc04
and the functions return
Packit 7cfc04
.RB + HUGE_VAL ,
Packit 7cfc04
.RB + HUGE_VALF ,
Packit 7cfc04
or
Packit 7cfc04
.RB + HUGE_VALL ,
Packit 7cfc04
respectively.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
See
Packit 7cfc04
.BR math_error (7)
Packit 7cfc04
for information on how to determine whether an error has occurred
Packit 7cfc04
when calling these functions.
Packit 7cfc04
.PP
Packit 7cfc04
The following errors can occur:
Packit 7cfc04
.TP
Packit 7cfc04
Range error: result overflow
Packit 7cfc04
.I errno
Packit 7cfc04
is set to
Packit 7cfc04
.BR ERANGE .
Packit 7cfc04
An overflow floating-point exception
Packit 7cfc04
.RB ( FE_OVERFLOW )
Packit 7cfc04
is raised.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw24 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR cosh (),
Packit 7cfc04
.BR coshf (),
Packit 7cfc04
.BR coshl ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
C99, POSIX.1-2001, POSIX.1-2008.
Packit 7cfc04
.PP
Packit 7cfc04
The variant returning
Packit 7cfc04
.I double
Packit 7cfc04
also conforms to
Packit 7cfc04
SVr4, 4.3BSD.
Packit 7cfc04
.SH BUGS
Packit 7cfc04
In glibc version 2.3.4 and earlier,
Packit 7cfc04
an overflow floating-point
Packit 7cfc04
.RB ( FE_OVERFLOW  )
Packit 7cfc04
exception is not raised when an overflow occurs.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR acosh (3),
Packit 7cfc04
.BR asinh (3),
Packit 7cfc04
.BR atanh (3),
Packit 7cfc04
.BR ccos (3),
Packit 7cfc04
.BR sinh (3),
Packit 7cfc04
.BR tanh (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.