usr/src/man/man3m/cosh.3m

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