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 sinh 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  13 .SH NAME
  14 sinh, sinhf, sinhl \- hyperbolic sine 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 \fBsinh\fR(\fBdouble\fR \fIx\fR);
  22 .fi
  23 
  24 .LP
  25 .nf
  26 \fBfloat\fR \fBsinhf\fR(\fBfloat\fR \fIx\fR);
  27 .fi
  28 
  29 .LP
  30 .nf
  31 \fBlong double\fR \fBsinhl\fR(\fBlong double\fR \fIx\fR);
  32 .fi
  33 
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 These functions compute the hyperbolic sine of \fIx\fR.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 Upon successful completion, these functions return the hyperbolic sine of
  42 \fIx\fR.
  43 .sp
  44 .LP
  45 If the result would cause an overflow, a range error occurs and
  46 \(+-\fBHUGE_VAL\fR, \(+-\fBHUGE_VALF\fR, and \(+-\fBHUGE_VALL\fR (with the same
  47 sign as \fIx\fR) is returned as appropriate for the type of the function.
  48 .sp
  49 .LP
  50 If \fIx\fR is NaN, a NaN is returned.
  51 .sp
  52 .LP
  53 If \fIx\fR is \(+-0 or \(+-Inf, \fIx\fR is returned.
  54 .sp
  55 .LP
  56 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
  57 \fBacos()\fR as specified by SVID3 and XPG3.
  58 .SH ERRORS
  59 .sp
  60 .LP
  61 These functions will fail if:
  62 .sp
  63 .ne 2
  64 .mk
  65 .na
  66 \fBRange Error\fR
  67 .ad
  68 .RS 15n
  69 .rt  
  70 The result would cause an overflow.
  71 .sp
  72 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  73 non-zero, the overflow floating-point exception is raised.
  74 .sp
  75 The \fBasinh()\fR function sets \fBerrno\fR to \fBERANGE\fR if the result would
  76 cause an overflow.
  77 .RE
  78 
  79 .SH USAGE
  80 .sp
  81 .LP
  82 An application wanting to check for exceptions should call
  83 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  84 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  85 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  86 raised. An application should either examine the return value or check the
  87 floating point exception flags to detect exceptions.
  88 .sp
  89 .LP
  90 An application can also set \fBerrno\fR to 0 before calling \fBasinh()\fR. On
  91 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBasinhf()\fR
  92 and \fBasinhl()\fR functions do not set \fBerrno\fR.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98 
  99 .sp
 100 .TS
 101 tab() box;
 102 cw(2.75i) |cw(2.75i) 
 103 lw(2.75i) |lw(2.75i) 
 104 .
 105 ATTRIBUTE TYPEATTRIBUTE VALUE
 106 _
 107 Interface StabilityStandard
 108 _
 109 MT-LevelMT-Safe
 110 .TE
 111 
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBasinh\fR(3M), \fBcosh\fR(3M), \fBfeclearexcept\fR(3M),
 116 \fBfetestexcept\fR(3M), \fBisnan\fR(3M), \fBmath.h\fR(3HEAD),
 117 \fBmatherr\fR(3M), \fBtanh\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)