xref: /freebsd/lib/msun/man/atanh.3 (revision 22d7dd834bc5cd189810e414701e3ad1e98102e4)
1.\" Copyright (c) 1985, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     from: @(#)atanh.3	5.2 (Berkeley) 5/6/91
29.\"
30.Dd June 9, 2013
31.Dt ATANH 3
32.Os
33.Sh NAME
34.Nm atanh ,
35.Nm atanhf ,
36.Nm atanhl
37.Nd inverse hyperbolic tangent functions
38.Sh LIBRARY
39.Lb libm
40.Sh SYNOPSIS
41.In math.h
42.Ft double
43.Fn atanh "double x"
44.Ft float
45.Fn atanhf "float x"
46.Ft long double
47.Fn atanhl "long double x"
48.Sh DESCRIPTION
49The
50.Fn atanh ,
51.Fn atanhf ,
52and
53.Fn atanhl
54functions compute the inverse hyperbolic tangent
55of the real
56argument
57.Fa x .
58For a discussion of error due to roundoff, see
59.Xr math 3 .
60.Sh RETURN VALUES
61These functions
62return the inverse hyperbolic tangent of
63.Fa x
64if successful.
65If the argument has absolute value 1, a divide-by-zero exception
66is raised and an infinity is returned.
67If
68.Fa |x|
69> 1, an invalid exception is raised and an \*(Na is returned.
70.Sh SEE ALSO
71.Xr acosh 3 ,
72.Xr asinh 3 ,
73.Xr exp 3 ,
74.Xr fenv 3 ,
75.Xr math 3
76.Sh HISTORY
77The
78.Fn atanh ,
79.Fn atanhf ,
80and
81.Fn atanhl
82functions appeared in
83.Bx 4.3 ,
84.Fx 2.0 ,
85and
86.Fx 10.0 ,
87respectively.
88