original/man3/acosh.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 2002-07-25 by Walter Harms
  31 .\"     (walter.harms@informatik.uni-oldenburg.de)
  32 .\"
  33 .TH ACOSH 3   2010-09-20 "" "Linux Programmer's Manual"
  34 .SH NAME
  35 acosh, acoshf, acoshl \- inverse hyperbolic cosine function
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <math.h>
  39 .sp
  40 .BI "double acosh(double " x );
  41 .br
  42 .BI "float acoshf(float " x );
  43 .br
  44 .BI "long double acoshl(long double " x );
  45 .sp
  46 .fi
  47 Link with \fI\-lm\fP.
  48 .sp
  49 .in -4n
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .in
  53 .sp
  54 .ad l
  55 .BR acosh ():
  56 .RS 4
  57 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  58 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
  59 _POSIX_C_SOURCE\ >=\ 200112L;
  60 .br
  61 or
  62 .I cc\ -std=c99
  63 .RE
  64 .br
  65 .BR acoshf (),
  66 .BR acoshl ():
  67 .RS 4
  68 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  69 _POSIX_C_SOURCE\ >=\ 200112L;
  70 .br
  71 or
  72 .I cc\ -std=c99
  73 .RE
  74 .ad b
  75 .SH DESCRIPTION
  76 The
  77 .BR acosh ()
  78 function calculates the inverse hyperbolic cosine of
  79 \fIx\fP; that is the value whose hyperbolic cosine is \fIx\fP.
  80 .SH "RETURN VALUE"
  81 On success, these functions return the inverse hyperbolic cosine of
  82 .IR x .
  83
  84 If
  85 .I x
  86 is a NaN, a NaN is returned.
  87
  88 If
  89 .I x
  90 is +1, +0 is returned.
  91
  92 If
  93 .I x
  94 is positive infinity, positive infinity is returned.
  95
  96 If
  97 .I x
  98 is less than 1,
  99 a domain error occurs,
 100 and the functions return a NaN.
 101 .SH ERRORS
 102 See
 103 .BR math_error (7)
 104 for information on how to determine whether an error has occurred
 105 when calling these functions.
 106 .PP
 107 The following errors can occur:
 108 .TP
 109 Domain error: \fIx\fP is less than 1
 110 .I errno
 111 is set to
 112 .BR EDOM .
 113 An invalid floating-point exception
 114 .RB ( FE_INVALID )
 115 is raised.
 116 .SH "CONFORMING TO"
 117 C99, POSIX.1-2001.
 118 The variant returning
 119 .I double
 120 also conforms to
 121 SVr4, 4.3BSD, C89.
 122 .SH "SEE ALSO"
 123 .BR asinh (3),
 124 .BR atanh (3),
 125 .BR cacosh (3),
 126 .BR cosh (3),
 127 .BR sinh (3),
 128 .BR tanh (3)