xref: /freebsd/lib/msun/man/atanh.3 (revision 97759ccc715c4b365432c16d763c50eecfcb1100)
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.Dd June 9, 2013
29.Dt ATANH 3
30.Os
31.Sh NAME
32.Nm atanh ,
33.Nm atanhf ,
34.Nm atanhl
35.Nd inverse hyperbolic tangent functions
36.Sh LIBRARY
37.Lb libm
38.Sh SYNOPSIS
39.In math.h
40.Ft double
41.Fn atanh "double x"
42.Ft float
43.Fn atanhf "float x"
44.Ft long double
45.Fn atanhl "long double x"
46.Sh DESCRIPTION
47The
48.Fn atanh ,
49.Fn atanhf ,
50and
51.Fn atanhl
52functions compute the inverse hyperbolic tangent
53of the real
54argument
55.Fa x .
56For a discussion of error due to roundoff, see
57.Xr math 3 .
58.Sh RETURN VALUES
59These functions
60return the inverse hyperbolic tangent of
61.Fa x
62if successful.
63If the argument has absolute value 1, a divide-by-zero exception
64is raised and an infinity is returned.
65If
66.Fa |x|
67> 1, an invalid exception is raised and an \*(Na is returned.
68.Sh SEE ALSO
69.Xr acosh 3 ,
70.Xr asinh 3 ,
71.Xr exp 3 ,
72.Xr fenv 3 ,
73.Xr math 3
74.Sh HISTORY
75The
76.Fn atanh ,
77.Fn atanhf ,
78and
79.Fn atanhl
80functions appeared in
81.Bx 4.3 ,
82.Fx 2.0 ,
83and
84.Fx 10.0 ,
85respectively.
86