1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   4 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at 
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH cosh 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  13 .SH NAME
  14 cosh, coshf, coshl \- hyperbolic cosine function
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  19 #include <math.h>
  20 
  21 \fBdouble\fR \fBcosh\fR(\fBdouble\fR \fIx\fR);
  22 .fi
  23 
  24 .LP
  25 .nf
  26 \fBfloat\fR \fBcoshf\fR(\fBfloat\fR \fIx\fR);
  27 .fi
  28 
  29 .LP
  30 .nf
  31 \fBlong double\fR \fBcoshl\fR(\fBlong double\fR \fIx\fR);
  32 .fi
  33 
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 These functions compute the hyperbolic cosine of their argument \fIx\fR.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 Upon successful completion, these functions return the hyperbolic cosine of
  42 \fIx\fR.
  43 .sp
  44 .LP
  45 If the correct value would cause overflow, a range error occurs and
  46 \fBcosh()\fR, \fBcoshf()\fR, and \fBcoshl()\fR return the value of the macro
  47 \fBHUGE_VAL\fR, \fBHUGE_VALF\fR, and \fBHUGE_VALL\fR, respectively.
  48 .sp
  49 .LP
  50 If \fIx\fR is NaN, a NaN is returned.
  51 .sp
  52 .LP
  53 If \fIx\fR is \(+-0, 1.0 is returned.
  54 .sp
  55 .LP
  56 If \fIx\fR is \(+-Inf, \(+-Inf is returned.
  57 .sp
  58 .LP
  59 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
  60 \fBcosh()\fR as specified by SVID3 and XPG3.
  61 .SH ERRORS
  62 .sp
  63 .LP
  64 These functions will fail if:
  65 .sp
  66 .ne 2
  67 .mk
  68 .na
  69 \fBRange Error\fR
  70 .ad
  71 .RS 15n
  72 .rt  
  73 The result would cause an overflow.
  74 .sp
  75 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  76 non-zero, the overflow floating-point exception is raised.
  77 .sp
  78 The \fBcosh()\fR function sets \fBerrno\fR to \fBERANGE\fR if the result would
  79 cause an overflow.
  80 .RE
  81 
  82 .SH USAGE
  83 .sp
  84 .LP
  85 An application wanting to check for exceptions should call
  86 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  87 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  88 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  89 raised. An application should either examine the return value or check the
  90 floating point exception flags to detect exceptions.
  91 .sp
  92 .LP
  93 An application can also set \fBerrno\fR to 0 before calling \fBcosh()\fR. On
  94 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBcoshf()\fR
  95 and \fBcoshl()\fR functions do not set \fBerrno\fR.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101 
 102 .sp
 103 .TS
 104 tab() box;
 105 cw(2.75i) |cw(2.75i) 
 106 lw(2.75i) |lw(2.75i) 
 107 .
 108 ATTRIBUTE TYPEATTRIBUTE VALUE
 109 _
 110 Interface StabilityStandard
 111 _
 112 MT-LevelMT-Safe
 113 .TE
 114 
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBacosh\fR(3M), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 119 \fBisnan\fR(3M), \fBmath.h\fR(3HEAD), \fBmatherr\fR(3M), \fBsinh\fR(3M),
 120 \fBtanh\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)