release/man3/atanh.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 2002-07-27 by Walter Harms
  31 .\"     (walter.harms@informatik.uni-oldenburg.de)
  32 .\"
  33 .\" Japanese Version Copyright (c) 1996 Kenji Kajiwara and Kentaro Ogawa
  34 .\"         all rights reserved.
  35 .\" Translated Sat, 13 Jul 1996 17:58:16 JST
  36 .\"         by Kenji Kajiwara and Kentaro Ogawa
  37 .\" Proof Reading: Takashi Yoshino
  38 .\" Updated Tue Aug  5 23:16:48 JST 2003
  39 .\"         by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  40 .\" Updated 2008-09-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  41 .\"
  42 .TH ATANH 3  2010-09-11 "" "Linux Programmer's Manual"
  43 .SH 名前
  44 atanh, atanhf, atanhl \- 逆双曲線正接（inverse hyperbolic tangent）関数
  45 .SH 書式
  46 .nf
  47 .B #include <math.h>
  48 .sp
  49 .BI "double atanh(double " x );
  50 .br
  51 .BI "float atanhf(float " x );
  52 .br
  53 .BI "long double atanhl(long double " x );
  54 .sp
  55 .fi
  56 \fI\-lm\fP でリンクする。
  57 .sp
  58 .in -4n
  59 glibc 向けの機能検査マクロの要件
  60 .RB ( feature_test_macros (7)
  61 参照):
  62 .in
  63 .sp
  64 .ad l
  65 .BR atanh ():
  66 .RS 4
  67 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  68 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
  69 _POSIX_C_SOURCE\ >=\ 200112L;
  70 .br
  71 or
  72 .I cc\ -std=c99
  73 .RE
  74 .br
  75 .BR atanhf (),
  76 .BR atanhl ():
  77 .RS 4
  78 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  79 _POSIX_C_SOURCE\ >=\ 200112L;
  80 .br
  81 or
  82 .I cc\ -std=c99
  83 .RE
  84 .ad b
  85 .SH 説明
  86 .BR atanh ()
  87 関数は \fIx\fP の逆双曲線正接 (inverse hyperbolic tangent) を計算する。
  88 すなわち、その双曲線正接 (hyperbolic tangent) が \fIx\fP になる
  89 ような値である。
  90 .SH 返り値
  91 成功すると、これらの関数は
  92 .I x
  93 の逆双曲線正接を返す。
  94
  95 .I x
  96 が NaN の場合、NaN が返される。
  97
  98 .I x
  99 が +0 (\-0) の場合、+0 (\-0) が返される。
 100
 101 .I x
 102 が +1 か \-1 の場合、
 103 極エラー (pole error) が発生し、
 104 関数の種類に応じて、数学的に正しい符号の
 105 .BR HUGE_VAL ,
 106 .BR HUGE_VALF ,
 107 .BR HUGE_VALL
 108 がそれぞれ返される。
 109
 110 .I x
 111 の絶対値が 1 より大きい場合、
 112 領域エラー (domain error) が発生し、
 113 NaN が返される。
 114 .\"
 115 .\" POSIX.1-2001 documents an optional range error for subnormal x;
 116 .\" glibc 2.8 does not do this.
 117 .SH エラー
 118 これらの関数を呼び出した際にエラーが発生したかの判定方法についての情報は
 119 .BR math_error (7)
 120 を参照のこと。
 121 .PP
 122 以下のエラーが発生する可能性がある。
 123 .TP
 124 領域エラー (domain error): \fIx\fP が \-1 より小さいか +1 より大きい
 125 .I errno
 126 に
 127 .B EDOM
 128 が設定される。
 129 無効 (invalid) 浮動小数点例外
 130 .RB ( FE_INVALID )
 131 が上がる。
 132 .TP
 133 極エラー (pole error): \fIx\fP が +1 か \-1
 134 .I errno
 135 に
 136 .B ERANGE
 137 が設定される (但し「バグ」の節も参照)。
 138 0 による除算 (divide-by-zero) 浮動小数点例外
 139 .RB ( FE_DIVBYZERO )
 140 が上がる。
 141 .SH 準拠
 142 C99, POSIX.1-2001.
 143 .I double
 144 版の関数は SVr4, 4.3BSD, C89 にも準拠している。
 145 .SH バグ
 146 .\" Bug: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6759
 147 .\" This can be seen in sysdeps/ieee754/k_standard.c
 148 glibc 2.9 とそれ以前のバージョンでは、
 149 極エラーが発生した場合、POSIX で要求されている
 150 .B ERANGE
 151 ではなく
 152 .B EDOM
 153 が
 154 .I errno
 155 に設定される。
 156 バージョン 2.10 以降の glibc では、正しい動作をする。
 157 .SH 関連項目
 158 .BR acosh (3),
 159 .BR asinh (3),
 160 .BR catanh (3),
 161 .BR cosh (3),
 162 .BR sinh (3),
 163 .BR tanh (3)