Annotation of src/lib/libm/man/atanh.3, Revision 1.16
1.1 cgd 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.
1.15 agc 12: .\" 3. Neither the name of the University nor the names of its contributors
1.1 cgd 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: .\"
1.2 mycroft 28: .\" from: @(#)atanh.3 5.2 (Berkeley) 5/6/91
1.16 ! matt 29: .\" $NetBSD: atanh.3,v 1.15 2003/08/07 16:44:46 agc Exp $
1.1 cgd 30: .\"
1.16 ! matt 31: .Dd January 29, 2013
1.1 cgd 32: .Dt ATANH 3
1.8 christos 33: .Os
1.1 cgd 34: .Sh NAME
1.12 kleink 35: .Nm atanh ,
1.16 ! matt 36: .Nm atanhf ,
! 37: .Nm atanhl
1.1 cgd 38: .Nd inverse hyperbolic tangent function
1.10 perry 39: .Sh LIBRARY
40: .Lb libm
1.1 cgd 41: .Sh SYNOPSIS
1.14 wiz 42: .In math.h
1.1 cgd 43: .Ft double
44: .Fn atanh "double x"
1.5 jtc 45: .Ft float
46: .Fn atanhf "float x"
1.16 ! matt 47: .Ft long double
! 48: .Fn atanhl "long double x"
1.1 cgd 49: .Sh DESCRIPTION
50: The
1.16 ! matt 51: .Fn atanh ,
! 52: .Fn atanhf ,
1.5 jtc 53: and
1.16 ! matt 54: .Fn atanhl
1.5 jtc 55: functions compute the inverse hyperbolic tangent
1.1 cgd 56: of the real
57: argument
58: .Ar x .
59: .Sh RETURN VALUES
1.13 ross 60: If |x|\*[Ge]1,
1.16 ! matt 61: .Fn atanh "x" ,
! 62: .Fn atanhf "x" ,
1.8 christos 63: and
1.16 ! matt 64: .Fn atanhl "x"
1.8 christos 65: .\" POSIX_MODE
66: return +inf, -inf or NaN, and sets the global variable
67: .Va errno
1.11 kristerw 68: to EDOM.
1.8 christos 69: .\" SYSV_MODE
70: .\" call
71: .\" .Xr matherr 3 .
1.1 cgd 72: .Sh SEE ALSO
73: .Xr acosh 3 ,
74: .Xr asinh 3 ,
75: .Xr exp 3 ,
1.8 christos 76: .Xr math 3
77: .\" .Xr matherr 3
1.1 cgd 78: .Sh HISTORY
79: The
80: .Fn atanh
81: function appeared in
82: .Bx 4.3 .
1.16 ! matt 83: .Sh STANDARDS
! 84: The
! 85: .Fn atanh
! 86: function conforms to
! 87: .St -isoC-99 .
CVSweb <webmaster@jp.NetBSD.org>