share/man/man3m/acosh.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 Berkeley software License Agreement specifies the terms and conditions
  28 .\" for redistribution.
  29 .\"
  30 .\"
  31 .\" Copyright (c) 1983 Regents of the University of California.
  32 .\" All rights reserved.
  33 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
  34 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  35 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  36 .\"
  37 .TH ACOSH 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  38 .SH NAME
  39 acosh, acoshf, acoshl \- inverse hyperbolic cosine functions
  40 .SH SYNOPSIS
  41 .LP
  42 .nf
  43 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  44 #include <math.h>
  45
  46 \fBdouble\fR \fBacosh\fR(\fBdouble\fR \fIx\fR);
  47 .fi
  48
  49 .LP
  50 .nf
  51 \fBfloat\fR \fBacoshf\fR(\fBfloat\fR \fIx\fR);
  52 .fi
  53
  54 .LP
  55 .nf
  56 \fBlong double\fR \fBacoshl\fR(\fBlong double\fR \fIx\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 These functions compute the inverse hyperbolic cosine of their argument
  63 \fIx\fR.
  64 .SH RETURN VALUES
  65 .sp
  66 .LP
  67 Upon successful completion, these functions return the inverse hyperbolic
  68 cosine of their argument.
  69 .sp
  70 .LP
  71 For finite values of  \fIx\fR < 1, a domain error occurs and NaN is returned.
  72 .sp
  73 .LP
  74 If \fIx\fR is NaN, NaN is returned.
  75 .sp
  76 .LP
  77 If \fIx\fR is +1, +0 is returned.
  78 .sp
  79 .LP
  80 If \fIx\fR is +Inf, +Inf is returned.
  81 .sp
  82 .LP
  83 If \fIx\fR is \(miInf, a domain error occurs and NaN is returned.
  84 .sp
  85 .LP
  86 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
  87 \fBacosh()\fR as specified by SVID3 and XPG3.
  88 .SH ERRORS
  89 .sp
  90 .LP
  91 These functions will fail if:
  92 .sp
  93 .ne 2
  94 .mk
  95 .na
  96 \fBDomain Error\fR
  97 .ad
  98 .RS 16n
  99 .rt
 100 The \fIx\fR argument is finite and less than 1.0, or is \(miInf.
 101 .sp
 102 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 103 non-zero, the invalid floating-point exception is raised.
 104 .sp
 105 The \fBacosh()\fR function sets \fBerrno\fR to \fBEDOM\fR if \fIx\fR is less
 106 than 1.0.
 107 .RE
 108
 109 .SH USAGE
 110 .sp
 111 .LP
 112 An application wanting to check for exceptions should call
 113 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 114 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 115 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 116 raised. An application should either examine the return value or check the
 117 floating point exception flags to detect exceptions.
 118 .sp
 119 .LP
 120 An application can also set \fBerrno\fR to 0 before calling \fBacosh()\fR. On
 121 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBacoshf()\fR
 122 and \fBacoshl()\fR functions do not set \fBerrno\fR.
 123 .SH ATTRIBUTES
 124 .sp
 125 .LP
 126 See \fBattributes\fR(5) for descriptions of the following attributes:
 127 .sp
 128
 129 .sp
 130 .TS
 131 tab(    ) box;
 132 cw(2.75i) |cw(2.75i)
 133 lw(2.75i) |lw(2.75i)
 134 .
 135 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 136 _
 137 Interface Stability     Standard
 138 _
 139 MT-Level        MT-Safe
 140 .TE
 141
 142 .SH SEE ALSO
 143 .sp
 144 .LP
 145 \fBcosh\fR(3M), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 146 \fBmath.h\fR(3HEAD), \fBmatherr\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)