man-pages/man3/atanh.3

73 lines
2.2 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
2004-11-03 13:51:07 +00:00
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
2004-11-03 13:51:07 +00:00
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" References consulted:
.\" Linux libc source code
.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\" 386BSD man pages
.\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
.\" Modified 2002-07-27 by Walter Harms
.\" (walter.harms@informatik.uni-oldenburg.de)
.\"
.TH ATANH 3 2002-07-27 "" "Linux Programmer's Manual"
.SH NAME
atanh, atanhf, atanhl \- inverse hyperbolic tangent function
.SH SYNOPSIS
.nf
.B #include <math.h>
.sp
.BI "double atanh(double " x );
.br
2004-11-03 13:51:07 +00:00
.BI "float atanhf(float " x );
.br
2004-11-03 13:51:07 +00:00
.BI "long double atanhl(long double " x );
.sp
2004-11-03 13:51:07 +00:00
.fi
Link with \fI-lm\fP.
2004-11-03 13:51:07 +00:00
.SH DESCRIPTION
The
.BR atanh ()
function calculates the inverse hyperbolic tangent of
\fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP.
If the absolute value of \fIx\fP is greater than 1.0,
.BR atanh ()
returns
2004-11-03 13:51:07 +00:00
not-a-number (NaN) and \fIerrno\fP is set.
.SH ERRORS
.TP
.B EDOM
\fIx\fP is out of range.
.SH "CONFORMING TO"
2006-08-03 13:57:30 +00:00
SVr4, POSIX.1-2001, 4.3BSD, C89.
The
.I float
and
.I "long double"
variants are C99 requirements.
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR acosh (3),
.BR asinh (3),
.BR catanh (3),
2004-11-03 13:51:07 +00:00
.BR cosh (3),
.BR sinh (3),
.BR tanh (3)