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 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" References consulted:
  28 .\"     Linux libc source code
  29 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  30 .\"     386BSD man pages
  31 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  32 .\" Modified 2002-07-27 by Walter Harms
  33 .\"     (walter.harms@informatik.uni-oldenburg.de)
  34 .\"
  35 .TH ATANH 3  2021-03-22 "" "Linux Programmer's Manual"
  36 .SH NAME
  37 atanh, atanhf, atanhl \- inverse hyperbolic tangent function
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <math.h>
  41 .PP
  42 .BI "double atanh(double " x );
  43 .BI "float atanhf(float " x );
  44 .BI "long double atanhl(long double " x );
  45 .PP
  46 .fi
  47 Link with \fI\-lm\fP.
  48 .PP
  49 .RS -4
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .RE
  53 .PP
  54 .BR atanh ():
  55 .nf
  56     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  57         || _XOPEN_SOURCE >= 500
  58 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  59         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  60         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  61 .fi
  62 .PP
  63 .BR atanhf (),
  64 .BR atanhl ():
  65 .nf
  66     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  67         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  68         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  69 .fi
  70 .SH DESCRIPTION
  71 These functions calculate the inverse hyperbolic tangent of
  72 .IR x ;
  73 that is the value whose hyperbolic tangent is
  74 .IR x .
  75 .SH RETURN VALUE
  76 On success, these functions return the inverse hyperbolic tangent of
  77 .IR x .
  78 .PP
  79 If
  80 .I x
  81 is a NaN, a NaN is returned.
  82 .PP
  83 If
  84 .I x
  85 is +0 (\-0), +0 (\-0) is returned.
  86 .PP
  87 If
  88 .I x
  89 is +1 or \-1,
  90 a pole error occurs,
  91 and the functions return
  92 .BR HUGE_VAL ,
  93 .BR HUGE_VALF ,
  94 or
  95 .BR HUGE_VALL ,
  96 respectively, with the mathematically correct sign.
  97 .PP
  98 If the absolute value of
  99 .I x
 100 is greater than 1,
 101 a domain error occurs,
 102 and a NaN is returned.
 103 .\"
 104 .\" POSIX.1-2001 documents an optional range error for subnormal x;
 105 .\" glibc 2.8 does not do this.
 106 .SH ERRORS
 107 See
 108 .BR math_error (7)
 109 for information on how to determine whether an error has occurred
 110 when calling these functions.
 111 .PP
 112 The following errors can occur:
 113 .TP
 114 Domain error: \fIx\fP less than \-1 or greater than +1
 115 .I errno
 116 is set to
 117 .BR EDOM .
 118 An invalid floating-point exception
 119 .RB ( FE_INVALID )
 120 is raised.
 121 .TP
 122 Pole error: \fIx\fP is +1 or \-1
 123 .I errno
 124 is set to
 125 .BR ERANGE
 126 (but see BUGS).
 127 A divide-by-zero floating-point exception
 128 .RB ( FE_DIVBYZERO )
 129 is raised.
 130 .SH ATTRIBUTES
 131 For an explanation of the terms used in this section, see
 132 .BR attributes (7).
 133 .ad l
 134 .nh
 135 .TS
 136 allbox;
 137 lbx lb lb
 138 l l l.
 139 Interface       Attribute       Value
 140 T{
 141 .BR atanh (),
 142 .BR atanhf (),
 143 .BR atanhl ()
 144 T}      Thread safety   MT-Safe
 145 .TE
 146 .hy
 147 .ad
 148 .sp 1
 149 .SH CONFORMING TO
 150 C99, POSIX.1-2001, POSIX.1-2008.
 151 .PP
 152 The variant returning
 153 .I double
 154 also conforms to
 155 SVr4, 4.3BSD.
 156 .SH BUGS
 157 In glibc 2.9 and earlier,
 158 .\" Bug: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6759
 159 .\" This can be seen in sysdeps/ieee754/k_standard.c
 160 when a pole error occurs,
 161 .I errno
 162 is set to
 163 .BR EDOM
 164 instead of the POSIX-mandated
 165 .BR ERANGE .
 166 Since version 2.10, glibc does the right thing.
 167 .SH SEE ALSO
 168 .BR acosh (3),
 169 .BR asinh (3),
 170 .BR catanh (3),
 171 .BR cosh (3),
 172 .BR sinh (3),
 173 .BR tanh (3)