xref: /netbsd-src/lib/libm/man/atanh.3 (revision 49e10846a684d8faa456046705ad6d3d7bce8f4c)
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.\"	$NetBSD: atanh.3,v 1.18 2022/12/04 11:25:09 uwe Exp $
30.\"
31.Dd January 29, 2013
32.Dt ATANH 3
33.Os
34.Sh NAME
35.Nm atanh ,
36.Nm atanhf ,
37.Nm atanhl
38.Nd inverse hyperbolic tangent function
39.Sh LIBRARY
40.Lb libm
41.Sh SYNOPSIS
42.In math.h
43.Ft double
44.Fn atanh "double x"
45.Ft float
46.Fn atanhf "float x"
47.Ft long double
48.Fn atanhl "long double x"
49.Sh DESCRIPTION
50The
51.Fn atanh ,
52.Fn atanhf ,
53and
54.Fn atanhl
55functions compute the inverse hyperbolic tangent
56of the real
57argument
58.Ar x .
59.Sh RETURN VALUES
60If |x|\*[Ge]1,
61.Fn atanh "x" ,
62.Fn atanhf "x" ,
63and
64.Fn atanhl "x"
65.\" POSIX_MODE
66return +inf, -inf or NaN, and sets the global variable
67.Va errno
68to
69.Er EDOM .
70.\" SYSV_MODE
71.\" call
72.\" .Xr matherr 3 .
73.Sh SEE ALSO
74.Xr acosh 3 ,
75.Xr asinh 3 ,
76.Xr exp 3 ,
77.Xr math 3
78.\" .Xr matherr 3
79.Sh STANDARDS
80The
81.Fn atanh
82function conforms to
83.St -isoC-99 .
84.Sh HISTORY
85The
86.Fn atanh
87function appeared in
88.Bx 4.3 .
89