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 .\" %%%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  2010-09-11 "" "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 .sp
  42 .BI "double atanh(double " x );
  43 .br
  44 .BI "float atanhf(float " x );
  45 .br
  46 .BI "long double atanhl(long double " x );
  47 .sp
  48 .fi
  49 Link with \fI\-lm\fP.
  50 .sp
  51 .in -4n
  52 Feature Test Macro Requirements for glibc (see
  53 .BR feature_test_macros (7)):
  54 .in
  55 .sp
  56 .ad l
  57 .BR atanh ():
  58 .RS 4
  59 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  60 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
  61 _POSIX_C_SOURCE\ >=\ 200112L;
  62 .br
  63 or
  64 .I cc\ -std=c99
  65 .RE
  66 .br
  67 .BR atanhf (),
  68 .BR atanhl ():
  69 .RS 4
  70 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  71 _POSIX_C_SOURCE\ >=\ 200112L;
  72 .br
  73 or
  74 .I cc\ -std=c99
  75 .RE
  76 .ad b
  77 .SH DESCRIPTION
  78 The
  79 .BR atanh ()
  80 function calculates the inverse hyperbolic tangent of
  81 .IR x ;
  82 that is the value whose hyperbolic tangent is
  83 .IR x .
  84 .SH RETURN VALUE
  85 On success, these functions return the inverse hyperbolic tangent of
  86 .IR x .
  87
  88 If
  89 .I x
  90 is a NaN, a NaN is returned.
  91
  92 If
  93 .I x
  94 is +0 (\-0), +0 (\-0) is returned.
  95
  96 If
  97 .I x
  98 is +1 or \-1,
  99 a pole error occurs,
 100 and the functions return
 101 .BR HUGE_VAL ,
 102 .BR HUGE_VALF ,
 103 or
 104 .BR HUGE_VALL ,
 105 respectively, with the mathematically correct sign.
 106
 107 If the absolute value of
 108 .I x
 109 is greater than 1,
 110 a domain error occurs,
 111 and a NaN is returned.
 112 .\"
 113 .\" POSIX.1-2001 documents an optional range error for subnormal x;
 114 .\" glibc 2.8 does not do this.
 115 .SH ERRORS
 116 See
 117 .BR math_error (7)
 118 for information on how to determine whether an error has occurred
 119 when calling these functions.
 120 .PP
 121 The following errors can occur:
 122 .TP
 123 Domain error: \fIx\fP less than \-1 or greater than +1
 124 .I errno
 125 is set to
 126 .BR EDOM .
 127 An invalid floating-point exception
 128 .RB ( FE_INVALID )
 129 is raised.
 130 .TP
 131 Pole error: \fIx\fP is +1 or \-1
 132 .I errno
 133 is set to
 134 .BR ERANGE
 135 (but see BUGS).
 136 A divide-by-zero floating-point exception
 137 .RB ( FE_DIVBYZERO )
 138 is raised.
 139 .SH CONFORMING TO
 140 C99, POSIX.1-2001.
 141 The variant returning
 142 .I double
 143 also conforms to
 144 SVr4, 4.3BSD, C89.
 145 .SH BUGS
 146 In glibc 2.9 and earlier,
 147 .\" Bug: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6759
 148 .\" This can be seen in sysdeps/ieee754/k_standard.c
 149 when a pole error occurs,
 150 .I errno
 151 as set to
 152 .BR EDOM
 153 instead of the POSIX-mandated
 154 .BR ERANGE .
 155 Since version 2.10, glibc does the right thing.
 156 .SH SEE ALSO
 157 .BR acosh (3),
 158 .BR asinh (3),
 159 .BR catanh (3),
 160 .BR cosh (3),
 161 .BR sinh (3),
 162 .BR tanh (3)
 163 .SH COLOPHON
 164 This page is part of release 3.68 of the Linux
 165 .I man-pages
 166 project.
 167 A description of the project,
 168 information about reporting bugs,
 169 and the latest version of this page,
 170 can be found at
 171 \%http://www.kernel.org/doc/man\-pages/.