2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
|
2008-08-01 05:26:01 +00:00
|
|
|
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
.\" 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.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
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.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
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)
|
|
|
|
.\"
|
2010-09-11 06:48:02 +00:00
|
|
|
.TH ATANH 3 2010-09-11 "" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
atanh, atanhf, atanhl \- inverse hyperbolic tangent function
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <math.h>
|
|
|
|
.sp
|
|
|
|
.BI "double atanh(double " x );
|
2004-11-11 17:28:42 +00:00
|
|
|
.br
|
2004-11-03 13:51:07 +00:00
|
|
|
.BI "float atanhf(float " x );
|
2004-11-11 17:28:42 +00:00
|
|
|
.br
|
2004-11-03 13:51:07 +00:00
|
|
|
.BI "long double atanhl(long double " x );
|
2007-04-12 22:42:49 +00:00
|
|
|
.sp
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-07-21 05:25:03 +00:00
|
|
|
Link with \fI\-lm\fP.
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.ad l
|
2008-08-01 05:26:01 +00:00
|
|
|
.BR atanh ():
|
2010-09-18 09:57:31 +00:00
|
|
|
.RS 4
|
|
|
|
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
|
|
|
|
_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
|
brk.2, chroot.2, faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, getdtablesize.2, getpagesize.2, getsid.2, linkat.2, mkdirat.2, mknodat.2, openat.2, pread.2, readlinkat.2, renameat.2, setpgid.2, sigaltstack.2, symlinkat.2, sync.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, unlinkat.2, utimensat.2, vfork.2, acosh.3, asinh.3, atanh.3, dirfd.3, dprintf.3, ecvt.3, expm1.3, fexecve.3, fmemopen.3, gcvt.3, getcwd.3, gethostid.3, getpass.3, getsubopt.3, getw.3, mbsnrtowcs.3, mkfifoat.3, mkstemp.3, mktemp.3, opendir.3, posix_memalign.3, rint.3, siginterrupt.3, stpcpy.3, stpncpy.3, strdup.3, strerror.3, strnlen.3, strsignal.3, strtol.3, strtoul.3, ualarm.3, usleep.3, wcpcpy.3, wcpncpy.3, wcscasecmp.3, wcsdup.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 06:02:38 +00:00
|
|
|
_POSIX_C_SOURCE\ >=\ 200112L;
|
2010-09-18 09:57:31 +00:00
|
|
|
.br
|
|
|
|
or
|
2008-08-01 05:26:01 +00:00
|
|
|
.I cc\ -std=c99
|
2010-09-18 09:57:31 +00:00
|
|
|
.RE
|
2008-08-01 05:26:01 +00:00
|
|
|
.br
|
2007-07-08 12:11:40 +00:00
|
|
|
.BR atanhf (),
|
|
|
|
.BR atanhl ():
|
2010-09-18 09:57:31 +00:00
|
|
|
.RS 4
|
|
|
|
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
|
|
|
|
_POSIX_C_SOURCE >= 200112L;
|
|
|
|
.br
|
|
|
|
or
|
2007-07-08 12:11:40 +00:00
|
|
|
.I cc\ -std=c99
|
2010-09-18 09:57:31 +00:00
|
|
|
.RE
|
2007-07-08 12:11:40 +00:00
|
|
|
.ad b
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR atanh ()
|
|
|
|
function calculates the inverse hyperbolic tangent of
|
2007-04-24 16:44:51 +00:00
|
|
|
\fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP.
|
2008-08-01 05:26:01 +00:00
|
|
|
.SH "RETURN VALUE"
|
|
|
|
On success, these functions return the inverse hyperbolic tangent of
|
|
|
|
.IR x .
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is a NaN, a NaN is returned.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is +0 (\-0), +0 (\-0) is returned.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I x
|
|
|
|
is +1 or \-1,
|
2008-08-04 16:00:58 +00:00
|
|
|
a pole error occurs,
|
2008-08-01 05:26:01 +00:00
|
|
|
and the functions return
|
|
|
|
.BR HUGE_VAL ,
|
|
|
|
.BR HUGE_VALF ,
|
|
|
|
or
|
|
|
|
.BR HUGE_VALL ,
|
|
|
|
respectively, with the mathematically correct sign.
|
|
|
|
|
|
|
|
If the absolute value of
|
|
|
|
.I x
|
|
|
|
is greater than 1,
|
2008-08-04 16:00:58 +00:00
|
|
|
a domain error occurs,
|
2008-08-01 05:26:01 +00:00
|
|
|
and a NaN is returned.
|
|
|
|
.\"
|
|
|
|
.\" POSIX.1-2001 documents an optional range error for subnormal x;
|
|
|
|
.\" glibc 2.8 does not do this.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH ERRORS
|
2008-08-01 05:26:01 +00:00
|
|
|
See
|
|
|
|
.BR math_error (7)
|
|
|
|
for information on how to determine whether an error has occurred
|
|
|
|
when calling these functions.
|
|
|
|
.PP
|
|
|
|
The following errors can occur:
|
2004-11-03 13:51:07 +00:00
|
|
|
.TP
|
2008-08-01 05:26:01 +00:00
|
|
|
Domain error: \fIx\fP less than \-1 or greater than +1
|
|
|
|
.I errno
|
|
|
|
is set to
|
|
|
|
.BR EDOM .
|
|
|
|
An invalid floating-point exception
|
|
|
|
.RB ( FE_INVALID )
|
|
|
|
is raised.
|
|
|
|
.TP
|
|
|
|
Pole error: \fIx\fP is +1 or \-1
|
|
|
|
.I errno
|
|
|
|
is set to
|
2008-08-05 10:33:06 +00:00
|
|
|
.BR ERANGE
|
2008-08-01 05:26:01 +00:00
|
|
|
(but see BUGS).
|
|
|
|
A divide-by-zero floating-point exception
|
|
|
|
.RB ( FE_DIVBYZERO )
|
|
|
|
is raised.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2008-08-01 05:26:01 +00:00
|
|
|
C99, POSIX.1-2001.
|
|
|
|
The variant returning
|
|
|
|
.I double
|
|
|
|
also conforms to
|
|
|
|
SVr4, 4.3BSD, C89.
|
|
|
|
.SH BUGS
|
2010-09-11 06:48:02 +00:00
|
|
|
In glibc 2.9 and earlier,
|
|
|
|
.\" Bug: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6759
|
2008-08-01 05:26:01 +00:00
|
|
|
.\" This can be seen in sysdeps/ieee754/k_standard.c
|
2010-09-11 06:48:02 +00:00
|
|
|
when a pole error occurs,
|
2008-08-01 05:26:01 +00:00
|
|
|
.I errno
|
2010-09-11 06:48:02 +00:00
|
|
|
as set to
|
|
|
|
.BR EDOM
|
|
|
|
instead of the POSIX-mandated
|
2008-08-01 05:26:01 +00:00
|
|
|
.BR ERANGE .
|
2010-09-11 06:48:02 +00:00
|
|
|
Since version 2.10, glibc does the right thing.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR acosh (3),
|
|
|
|
.BR asinh (3),
|
2004-11-15 11:59:59 +00:00
|
|
|
.BR catanh (3),
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR cosh (3),
|
|
|
|
.BR sinh (3),
|
|
|
|
.BR tanh (3)
|