usr/src/man/man3m/sinh.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 SINH 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 sinh, sinhf, sinhl \- hyperbolic sine 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 \fBsinh\fR(\fBdouble\fR \fIx\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBsinhf\fR(\fBfloat\fR \fIx\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBsinhl\fR(\fBlong double\fR \fIx\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions compute the hyperbolic sine of \fIx\fR.
  73 .SH RETURN VALUES
  74 .sp
  75 .LP
  76 Upon successful completion, these functions return the hyperbolic sine of
  77 \fIx\fR.
  78 .sp
  79 .LP
  80 If the result would cause an overflow, a range error occurs and
  81 \(+-\fBHUGE_VAL\fR, \(+-\fBHUGE_VALF\fR, and \(+-\fBHUGE_VALL\fR (with the same
  82 sign as \fIx\fR) is returned as appropriate for the type of the function.
  83 .sp
  84 .LP
  85 If \fIx\fR is NaN, a NaN is returned.
  86 .sp
  87 .LP
  88 If \fIx\fR is \(+-0 or \(+-Inf, \fIx\fR is returned.
  89 .sp
  90 .LP
  91 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
  92 \fBacos()\fR as specified by SVID3 and XPG3.
  93 .SH ERRORS
  94 .sp
  95 .LP
  96 These functions will fail if:
  97 .sp
  98 .ne 2
  99 .mk
 100 .na
 101 \fBRange Error\fR
 102 .ad
 103 .RS 15n
 104 .rt
 105 The result would cause an overflow.
 106 .sp
 107 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 108 non-zero, the overflow floating-point exception is raised.
 109 .sp
 110 The \fBasinh()\fR function sets \fBerrno\fR to \fBERANGE\fR if the result would
 111 cause an overflow.
 112 .RE
 113
 114 .SH USAGE
 115 .sp
 116 .LP
 117 An application wanting to check for exceptions should call
 118 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 119 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 120 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 121 raised. An application should either examine the return value or check the
 122 floating point exception flags to detect exceptions.
 123 .sp
 124 .LP
 125 An application can also set \fBerrno\fR to 0 before calling \fBasinh()\fR. On
 126 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBasinhf()\fR
 127 and \fBasinhl()\fR functions do not set \fBerrno\fR.
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 tab(    ) box;
 137 cw(2.75i) |cw(2.75i)
 138 lw(2.75i) |lw(2.75i)
 139 .
 140 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 141 _
 142 Interface Stability     Standard
 143 _
 144 MT-Level        MT-Safe
 145 .TE
 146
 147 .SH SEE ALSO
 148 .sp
 149 .LP
 150 \fBasinh\fR(3M), \fBcosh\fR(3M), \fBfeclearexcept\fR(3M),
 151 \fBfetestexcept\fR(3M), \fBisnan\fR(3M), \fBmath.h\fR(3HEAD),
 152 \fBmatherr\fR(3M), \fBtanh\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)