manual/LDP_man-pages/original/man3/atanh.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-27 by Walter Harms
  31 .\"     (walter.harms@informatik.uni-oldenburg.de)
  32 .\"
  33 .TH ATANH 3  2008-08-05 "" "Linux Programmer's Manual"
  34 .SH NAME
  35 atanh, atanhf, atanhl \- inverse hyperbolic tangent function
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <math.h>
  39 .sp
  40 .BI "double atanh(double " x );
  41 .br
  42 .BI "float atanhf(float " x );
  43 .br
  44 .BI "long double atanhl(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 atanh ():
  56 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE; or
  57 .I cc\ -std=c99
  58 .br
  59 .BR atanhf (),
  60 .BR atanhl ():
  61 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
  62 .I cc\ -std=c99
  63 .ad b
  64 .SH DESCRIPTION
  65 The
  66 .BR atanh ()
  67 function calculates the inverse hyperbolic tangent of
  68 \fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP.
  69 .SH "RETURN VALUE"
  70 On success, these functions return the inverse hyperbolic tangent of
  71 .IR x .
  72
  73 If
  74 .I x
  75 is a NaN, a NaN is returned.
  76
  77 If
  78 .I x
  79 is +0 (\-0), +0 (\-0) is returned.
  80
  81 If
  82 .I x
  83 is +1 or \-1,
  84 a pole error occurs,
  85 and the functions return
  86 .BR HUGE_VAL ,
  87 .BR HUGE_VALF ,
  88 or
  89 .BR HUGE_VALL ,
  90 respectively, with the mathematically correct sign.
  91
  92 If the absolute value of
  93 .I x
  94 is greater than 1,
  95 a domain error occurs,
  96 and a NaN is returned.
  97 .\"
  98 .\" POSIX.1-2001 documents an optional range error for subnormal x;
  99 .\" glibc 2.8 does not do this.
 100 .SH ERRORS
 101 See
 102 .BR math_error (7)
 103 for information on how to determine whether an error has occurred
 104 when calling these functions.
 105 .PP
 106 The following errors can occur:
 107 .TP
 108 Domain error: \fIx\fP less than \-1 or greater than +1
 109 .I errno
 110 is set to
 111 .BR EDOM .
 112 An invalid floating-point exception
 113 .RB ( FE_INVALID )
 114 is raised.
 115 .TP
 116 Pole error: \fIx\fP is +1 or \-1
 117 .I errno
 118 is set to
 119 .BR ERANGE
 120 (but see BUGS).
 121 .\" FIXME . glibc actually gives EDOM for this case
 122 A divide-by-zero floating-point exception
 123 .RB ( FE_DIVBYZERO )
 124 is raised.
 125 .SH "CONFORMING TO"
 126 C99, POSIX.1-2001.
 127 The variant returning
 128 .I double
 129 also conforms to
 130 SVr4, 4.3BSD, C89.
 131 .SH BUGS
 132 For a pole error,
 133 .\"
 134 .\" FIXME . this is as at glibc 2.8; check later if this bug is fixed
 135 .\" This can be seen in sysdeps/ieee754/k_standard.c
 136 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6759
 137 .I errno
 138 is set to
 139 .BR EDOM ;
 140 POSIX.1 says it should be set to
 141 .BR ERANGE .
 142 .SH "SEE ALSO"
 143 .BR acosh (3),
 144 .BR asinh (3),
 145 .BR catanh (3),
 146 .BR cosh (3),
 147 .BR sinh (3),
 148 .BR tanh (3)