Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / LDP_man-pages / draft / man3 / atanh.3

.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
.\"     <mtk.manpages@gmail.com>
.\"
.\" 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.
.\"
.\" 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.
.\"
.\" 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)
.\"
.\" Japanese Version Copyright (c) 1996 Kenji Kajiwara and Kentaro Ogawa
.\"         all rights reserved.
.\" Translated Sat, 13 Jul 1996 17:58:16 JST
.\"         by Kenji Kajiwara and Kentaro Ogawa
.\" Proof Reading: Takashi Yoshino
.\" Updated Tue Aug  5 23:16:48 JST 2003
.\"         by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2008-09-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\"
.TH ATANH 3  2008-08-05 "" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O atanh, atanhf, atanhl \- inverse hyperbolic tangent function
atanh, atanhf, atanhl \- µÕÁжÊÀþÀµÀÜ¡Êinverse hyperbolic tangent¡Ë´Ø¿ô
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.B #include <math.h>
.sp
.BI "double atanh(double " x );
.br
.BI "float atanhf(float " x );
.br
.BI "long double atanhl(long double " x );
.sp
.fi
.\"O Link with \fI\-lm\fP.
\fI\-lm\fP ¤Ç¥ê¥ó¥¯¤¹¤ë¡£
.sp
.in -4n
.\"O Feature Test Macro Requirements for glibc (see
.\"O .BR feature_test_macros (7)):
glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
.RB ( feature_test_macros (7)
»²¾È):
.in
.sp
.ad l
.BR atanh ():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE; or
.I cc\ -std=c99
.br
.BR atanhf (),
.BR atanhl ():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
.I cc\ -std=c99
.ad b
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The
.\"O .BR atanh ()
.\"O function calculates the inverse hyperbolic tangent of
.\"O \fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP.
.BR atanh ()
´Ø¿ô¤Ï \fIx\fP ¤ÎµÕÁжÊÀþÀµÀÜ (inverse hyperbolic tangent) ¤ò·×»»¤¹¤ë¡£
¤¹¤Ê¤ï¤Á¡¢¤½¤ÎÁжÊÀþÀµÀÜ (hyperbolic tangent) ¤¬ \fIx\fP ¤Ë¤Ê¤ë
¤è¤¦¤ÊÃͤǤ¢¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success, these functions return the inverse hyperbolic tangent of
.\"O .IR x .
À®¸ù¤¹¤ë¤È¡¢¤³¤ì¤é¤Î´Ø¿ô¤Ï
.I x
¤ÎµÕÁжÊÀþÀµÀܤòÊÖ¤¹¡£

.\"O If
.\"O .I x
.\"O is a NaN, a NaN is returned.
.I x
¤¬ NaN ¤Î¾ì¹ç¡¢NaN ¤¬ÊÖ¤µ¤ì¤ë¡£

.\"O If
.\"O .I x
.\"O is +0 (\-0), +0 (\-0) is returned.
.I x
¤¬ +0 (\-0) ¤Î¾ì¹ç¡¢+0 (\-0) ¤¬ÊÖ¤µ¤ì¤ë¡£

.\"O If
.\"O .I x
.\"O is +1 or \-1,
.\"O a pole error occurs,
.\"O and the functions return
.\"O .BR HUGE_VAL ,
.\"O .BR HUGE_VALF ,
.\"O or
.\"O .BR HUGE_VALL ,
.\"O respectively, with the mathematically correct sign.
.I x
¤¬ +1 ¤« \-1 ¤Î¾ì¹ç¡¢
¶Ë¥¨¥é¡¼ (pole error) ¤¬È¯À¸¤·¡¢
´Ø¿ô¤Î¼ïÎà¤Ë±þ¤¸¤Æ¡¢¿ô³ØŪ¤ËÀµ¤·¤¤Éä¹æ¤Î
.BR HUGE_VAL ,
.BR HUGE_VALF ,
.BR HUGE_VALL
¤¬¤½¤ì¤¾¤ìÊÖ¤µ¤ì¤ë¡£

.\"O If the absolute value of
.\"O .I x
.\"O is greater than 1,
.\"O a domain error occurs,
.\"O and a NaN is returned.
.I x
¤ÎÀäÂÐÃͤ¬ 1 ¤è¤êÂ礭¤¤¾ì¹ç¡¢
Îΰ襨¥é¡¼ (domain error) ¤¬È¯À¸¤·¡¢
NaN ¤¬ÊÖ¤µ¤ì¤ë¡£
.\"
.\" POSIX.1-2001 documents an optional range error for subnormal x;
.\" glibc 2.8 does not do this.
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.\"O See
.\"O .BR math_error (7)
.\"O for information on how to determine whether an error has occurred
.\"O when calling these functions.
¤³¤ì¤é¤Î´Ø¿ô¤ò¸Æ¤Ó½Ð¤·¤¿ºÝ¤Ë¥¨¥é¡¼¤¬È¯À¸¤·¤¿¤«¤ÎȽÄêÊýË¡¤Ë¤Ä¤¤¤Æ¤Î¾ðÊó¤Ï
.BR math_error (7)
¤ò»²¾È¤Î¤³¤È¡£
.PP
.\"O The following errors can occur:
°Ê²¼¤Î¥¨¥é¡¼¤¬È¯À¸¤¹¤ë²ÄǽÀ­¤¬¤¢¤ë¡£
.TP
.\"O Domain error: \fIx\fP less than \-1 or greater than +1
Îΰ襨¥é¡¼ (domain error): \fIx\fP ¤¬ \-1 ¤è¤ê¾®¤µ¤¤¤« +1 ¤è¤êÂ礭¤¤
.\"O .I errno
.\"O is set to
.\"O .BR EDOM .
.\"O An invalid floating-point exception
.\"O .RB ( FE_INVALID )
.\"O is raised.
.I errno
¤Ë
.B EDOM
¤¬ÀßÄꤵ¤ì¤ë¡£
̵¸ú (invalid) ÉâÆ°¾®¿ôÅÀÎã³°
.RB ( FE_INVALID )
¤¬¾å¤¬¤ë¡£
.TP
.\"O Pole error: \fIx\fP is +1 or \-1
¶Ë¥¨¥é¡¼ (pole error): \fIx\fP ¤¬ +1 ¤« \-1
.\"O .I errno
.\"O is set to
.\"O .BR ERANGE
.\"O (but see BUGS).
.I errno
¤Ë
.B ERANGE
¤¬ÀßÄꤵ¤ì¤ë (⤷¡Ö¥Ð¥°¡×¤ÎÀá¤â»²¾È)¡£
.\" FIXME . glibc actually gives EDOM for this case
.\"O A divide-by-zero floating-point exception
.\"O .RB ( FE_DIVBYZERO )
.\"O is raised.
0 ¤Ë¤è¤ë½ü»» (divide-by-zero) ÉâÆ°¾®¿ôÅÀÎã³°
.RB ( FE_DIVBYZERO )
¤¬¾å¤¬¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
C99, POSIX.1-2001.
.\"O The variant returning
.\"O .I double
.\"O also conforms to
.\"O SVr4, 4.3BSD, C89.
.I double
ÈǤδؿô¤Ï SVr4, 4.3BSD, C89 ¤Ë¤â½àµò¤·¤Æ¤¤¤ë¡£
.\"O .SH BUGS
.SH ¥Ð¥°
.\"O For a pole error,
¶Ë¥¨¥é¡¼¤Î¾ì¹ç¤Ë¡¢
.\"
.\" FIXME . this is as at glibc 2.8; check later if this bug is fixed
.\" This can be seen in sysdeps/ieee754/k_standard.c
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6759
.\"O .I errno
.\"O is set to
.\"O .BR EDOM ;
.I errno
¤Ë
.B EDOM
¤¬ÀßÄꤵ¤ì¤ë¡£
.\"O POSIX.1 says it should be set to
.\"O .BR ERANGE .
POSIX.1 ¤Ç¤Ï¡¢
.B ERANGE
¤òÀßÄꤹ¤Ù¤­¤È¤Ê¤Ã¤Æ¤¤¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR acosh (3),
.BR asinh (3),
.BR catanh (3),
.BR cosh (3),
.BR sinh (3),
.BR tanh (3)