1 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
2 .\" <mtk.manpages@gmail.com>
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein. The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
24 .\"*******************************************************************
26 .\" This file was generated with po4a. Translate the source file.
28 .\"*******************************************************************
29 .TH MATH_ERROR 7 2008\-08\-11 Linux "Linux Programmer's Manual"
31 math_error \- 数学関数からのエラーの検出
34 \fB#include <math.h>\fP
35 \fB#include <errno.h>\fP
36 \fB#include <fenv.h>\fP
39 エラーが発生すると、ほとんどのライブラリ関数は (\-1 や NULL などの) 特別な値を返すことでエラーを通知する。
40 \fI<math.h>\fP で宣言されている数学関数は、通常は浮動小数点値を返すので、 他の機構を使ってエラーを通知する。 エラー通知機構は
41 2 種類あり、 古いものが \fIerrno\fP を設定するやり方であり、新しいものが \fBfenv\fP(3) で説明されている浮動小数点例外機構である。
42 (\fBfeclearexcept\fP(3) と \fBfetestexcept\fP(3) を使用する。これらについては以下で概要を説明している。)
44 移植性が必要なプログラムで、数学関数からのエラーを確認する必要がある場合には、 数学関数を呼び出す前に \fIerrno\fP を 0 に設定し、
48 feclearexcept(FE_ALL_EXCEPT);
54 数学関数から返ってきた際に、 \fIerrno\fP が 0 以外か、
58 fetestexcept(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW |
65 .\" FE_INVALID = 0x01,
66 .\" __FE_DENORM = 0x02,
67 .\" FE_DIVBYZERO = 0x04,
68 .\" FE_OVERFLOW = 0x08,
69 .\" FE_UNDERFLOW = 0x10,
72 の呼び出しが 0 以外を返した場合 (\fBfenv\fP(3) 参照)、数学関数でエラーが発生している。
74 数学関数で発生するエラー条件については以下で説明する。
75 .SS "領域エラー (domain error)"
76 \fI領域エラー\fP が発生するのは、数学関数に渡された引き数の値がその関数が定義されている 領域に入っていない場合である (例えば \fBlog\fP(3)
77 に負の引き数を渡した場合)。 領域エラーが発生すると、 数学関数は普通は NaN を返し (同じ状況で違う値を返す関数もある)、 \fIerrno\fP に
78 \fBEDOM\fP を設定し、「無効 (invalid)」 浮動小数点例外 (\fBFE_INVALID\fP) を上げる。
79 .SS "極エラー (pole error)"
80 \fI極エラー\fP が発生するのは、関数の数学的な結果が無限大そのものとなる場合である (例えば 0 の対数は負の無限大である)。
81 極エラーが発生すると、その関数の返り値は (符号付きの) \fBHUGE_VAL\fP, \fBHUGE_VALF\fP, \fBHUGE_VALL\fP
82 のいずれかとなる (前記の値のうちどれが返るかは関数の返り値の型により決まり、 それぞれ \fIdouble\fP, \fIfloat\fP, \fIlong
83 double\fP に対応する)。 結果の符号は、その関数の数学的な定義から決定される。 \fIerrno\fP は \fBERANGE\fP に設定され、「0
84 による除算 (divide\-by\-zero)」 浮動小数点例外 (\fBFE_DIVBYZERO\fP) が上がる。
85 .SS "範囲エラー (range エラー)"
86 \fI範囲エラー\fP が発生するのは、関数の結果の値がその関数の返り値の型では表現できない場合
87 である。関数の返り値は、範囲エラーがオーバーフローであったかアンダーフロー であったかによって異なる。
89 浮動小数点のオーバーフローは、結果が有限だが、大き過ぎて 結果を返す型では表現できない場合に発生する。 オーバーフローが発生すると、 その関数は
90 \fBHUGE_VAL\fP, \fBHUGE_VALF\fP, \fBHUGE_VALL\fP のいずれかを返す
91 (前記の値のうちどれが返るかは関数の返り値の型により決まり、 それぞれ \fIdouble\fP, \fIfloat\fP, \fIlong double\fP
92 に対応する)。 \fIerrno\fP は \fBERANGE\fP に設定され、「オーバーフロー (overflow)」 浮動小数点例外
93 (\fBFE_OVERFLOW\fP) が上がる。
95 浮動小数点のアンダーフローは、 結果が小さ過ぎて、結果を返す型では表現できない場合に発生する。 アンダーフローが発生すると、数学関数は通常は 0.0
96 を返す (C99 では、指定された型において最小の正規化された正の値より大きくない 値を持つ実装定義 (implementation\-defined)
97 の値を返す、となっている)。 \fIerrno\fP は \fBERANGE\fP に設定され、「アンダーフロー」浮動小数点例外 (\fBFE_UNDERFLOW\fP)
100 いくつかの関数では、渡された引き数の値や、正しい関数の結果が \fIsubnormal (非正規化数)\fP になる場合に範囲エラーを上げる。
101 subnormal な値とは、0 ではないが、その値が小さすぎて (仮数部の最上位ビットが 1 となる) 標準形では表現できないような値である。
102 subnormal な値の表現では、仮数部の上位側のビットに 1 個以上の 0 が 含まれることになる。
104 .\" See CONFORMANCE in the glibc 2.8 (and earlier) source.
105 C99 と POSIX.1\-2001 で規定されている \fImath_errhandling\fP 識別子は glibc ではサポートされていない。
106 この識別子は、2 つのエラー通知機構 (\fIerrno\fP と \fBfetestexcept\fP(3) 経由で取得できる例外)
107 のうちどちらが使用されているかを通知 することになっている。 標準では、少なくとも一つは使用されることが要求されているが、
108 両方とも利用可能であってもよいとされている。 glibc での現在の (バージョン 2.8 での) 状況はかなり混乱している。 ほとんどの関数
109 (ただし全部ではない) はエラー時に例外を上げる。 いくつかの関数は \fIerrno\fP も設定する。 \fIerrno\fP
110 を設定するが、例外を上げない関数も少しだけ存在する。 どちらも行わない関数もごく少数だが存在する。 詳細については個々のマニュアルページを参照のこと。
112 .\" http://www.securecoding.cert.org/confluence/display/seccode/FLP32-C.+Prevent+or+detect+domain+and+range+errors+in+math+functions
113 \fIerrno\fP と \fBfetestexcept\fP(3) の両方を使ってエラーチェックを行うことで複雑になるのを避けるため、
114 多くの場合、関数呼び出しを行う前に不正な引き数かのチェックを行う 方法が推奨されている。 例えば、以下のコードは、 \fBlog\fP(3) の引き数が
115 NaN でも (極エラーとなる) 0 でも (領域エラーとなる) 0 未満 でもないことを保証するものである。
121 if (isnan(x) || islessequal(x, 0)) {
122 /* Deal with NaN / pole error / domain error */
129 このページに書かれていることは、 (\fI<complex.h>\fP で宣言されている) 複素数関数にはあてはまらない。 一般に、C99 や
130 POSIX.1\-2001 ではこれらの関数がエラーを返すことを 要求してない。
132 \fBgcc\fP(1) の \fI\-fno\-math\-errno\fP オプションを使うと、実行ファイルで、標準の実装よりも高速な数学関数の
133 実装が使用されるようになるが、 エラー時に \fIerrno\fP が設定されない (\fBgcc\fP(1) の \fI\-ffast\-math\fP
134 オプションを指定した場合にも \fI\-fno\-math\-errno\fP は有効になる)。 このオプションを指定した場合でも、
135 \fBfetestexcept\fP(3) を使ったエラーの検査は可能である。
137 \fBgcc\fP(1), \fBerrno\fP(3), \fBfenv\fP(3), \fBfpclassify\fP(3), \fBINFINITY\fP(3),
138 \fBisgreater\fP(3), \fBmatherr\fP(3), \fBnan\fP(3)
142 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.40 の一部
143 である。プロジェクトの説明とバグ報告に関する情報は
144 http://www.kernel.org/doc/man\-pages/ に書かれている。