man3/cosh.3

   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 COSH 3 2021-03-22 ""  "Linux Programmer's Manual"
  37 .SH NAME
  38 cosh, coshf, coshl \- hyperbolic cosine function
  39 .SH SYNOPSIS
  40 .nf
  41 .B #include <math.h>
  42 .PP
  43 .BI "double cosh(double " x );
  44 .BI "float coshf(float " x );
  45 .BI "long double coshl(long double " x );
  46 .fi
  47 .PP
  48 Link with \fI\-lm\fP.
  49 .PP
  50 .RS -4
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .RE
  54 .PP
  55 .BR coshf (),
  56 .BR coshl ():
  57 .nf
  58     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  59         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  60         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  61 .fi
  62 .SH DESCRIPTION
  63 These functions return the hyperbolic cosine of
  64 .IR x ,
  65 which is defined mathematically as:
  66 .PP
  67 .nf
  68     cosh(x) = (exp(x) + exp(\-x)) / 2
  69 .fi
  70 .SH RETURN VALUE
  71 On success, these functions return the hyperbolic cosine of
  72 .IR x .
  73 .PP
  74 If
  75 .I x
  76 is a NaN, a NaN is returned.
  77 .PP
  78 If
  79 .I x
  80 is +0 or \-0, 1 is returned.
  81 .PP
  82 If
  83 .I x
  84 is positive infinity or negative infinity,
  85 positive infinity is returned.
  86 .PP
  87 If the result overflows,
  88 a range error occurs,
  89 and the functions return
  90 .RB + HUGE_VAL ,
  91 .RB + HUGE_VALF ,
  92 or
  93 .RB + HUGE_VALL ,
  94 respectively.
  95 .SH ERRORS
  96 See
  97 .BR math_error (7)
  98 for information on how to determine whether an error has occurred
  99 when calling these functions.
 100 .PP
 101 The following errors can occur:
 102 .TP
 103 Range error: result overflow
 104 .I errno
 105 is set to
 106 .BR ERANGE .
 107 An overflow floating-point exception
 108 .RB ( FE_OVERFLOW )
 109 is raised.
 110 .SH ATTRIBUTES
 111 For an explanation of the terms used in this section, see
 112 .BR attributes (7).
 113 .ad l
 114 .nh
 115 .TS
 116 allbox;
 117 lbx lb lb
 118 l l l.
 119 Interface       Attribute       Value
 120 T{
 121 .BR cosh (),
 122 .BR coshf (),
 123 .BR coshl ()
 124 T}      Thread safety   MT-Safe
 125 .TE
 126 .hy
 127 .ad
 128 .sp 1
 129 .SH CONFORMING TO
 130 C99, POSIX.1-2001, POSIX.1-2008.
 131 .PP
 132 The variant returning
 133 .I double
 134 also conforms to
 135 SVr4, 4.3BSD.
 136 .SH BUGS
 137 In glibc version 2.3.4 and earlier,
 138 an overflow floating-point
 139 .RB ( FE_OVERFLOW  )
 140 exception is not raised when an overflow occurs.
 141 .SH SEE ALSO
 142 .BR acosh (3),
 143 .BR asinh (3),
 144 .BR atanh (3),
 145 .BR ccos (3),
 146 .BR sinh (3),
 147 .BR tanh (3)