2 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
3 .\" <mtk.manpages@gmail.com>
5 .\" %%%LICENSE_START(VERBATIM)
6 .\" Permission is granted to make and distribute verbatim copies of this
7 .\" manual provided the copyright notice and this permission notice are
8 .\" preserved on all copies.
10 .\" Permission is granted to copy and distribute modified versions of this
11 .\" manual under the conditions for verbatim copying, provided that the
12 .\" entire resulting derived work is distributed under the terms of a
13 .\" permission notice identical to this one.
15 .\" Since the Linux kernel and libraries are constantly changing, this
16 .\" manual page may be incorrect or out-of-date. The author(s) assume no
17 .\" responsibility for errors or omissions, or for damages resulting from
18 .\" the use of the information contained herein. The author(s) may not
19 .\" have taken the same level of care in the production of this manual,
20 .\" which is licensed free of charge, as they might when working
23 .\" Formatted or processed versions of this manual, if unaccompanied by
24 .\" the source, must acknowledge the copyright and authors of this work.
27 .\"*******************************************************************
29 .\" This file was generated with po4a. Translate the source file.
31 .\"*******************************************************************
32 .TH MATHERR 3 2010\-09\-10 Linux "Linux Programmer's Manual"
34 matherr \- SVID 数学ライブラリの例外処理
37 \fB#define _SVID_SOURCE\fP /* feature_test_macros(7) 参照 */
38 \fB#include <math.h>\fP
40 \fBint matherr(struct exception *\fP\fIexc\fP\fB);\fP
42 \fBextern _LIB_VERSION_TYPE _LIB_VERSION;\fP
47 System V Interface Definition (SVID) では、各種の数学関数は数学的な
48 例外を検出した場合に \fBmatherr\fP() を呼ばれる関数を起動すべきである、
49 と規定されている。この関数は数学関数が返る前に呼び出される。
50 \fBmatherr\fP() が返った後に、システムは数学関数に戻り、
53 \fBmatherr\fP() の仕組みは glibc によりサポートされているが、
56 \fBmath_error\fP(7) と \fBfenv\fP(3) で説明されている手法を使用すべきである。
57 このマニュアルページでは、古いアプリケーションを保守したり移植する際の
58 助けとなるよう、 glibc の \fBmatherr\fP() の仕組みについて説明する。
60 \fBmatherr\fP() を使用するためには、
61 プログラマは (\fIどの\fPヘッダファイルをインクルードするよりも前に)
62 \fB_SVID_SOURCE\fP 機能検査マクロを定義し、値 \fB_SVID_\fP をグローバル変数
63 \fB_LIB_VERSION\fP に代入しなければならない。
65 デフォルト版の \fBmatherr\fP() がシステムによって提供されている。
66 デフォルト版は何も行わず、0 を返す (このことの重要性については
67 下記を参照)。プログラマが \fBmatherr\fP() を定義することで、
69 プログラマが定義した関数は例外が発生した際に起動される。
70 この関数は引き数 1 個で起動され、その引き数は以下に示す
71 \fIexception\fP 構造体へのポインタである。
76 int type; /* Exception type */
77 char *name; /* Name of function causing exception */
78 double arg1; /* 1st argument to function */
79 double arg2; /* 2nd argument to function */
80 double retval; /* Function return value */
85 \fItype\fP フィールドは以下の値のいずれかである。
88 領域エラー (domain error) が発生した
89 (関数の引き数が関数が定義された範囲外であった)。
90 返り値は関数によって異なり、 \fIerror\fP には \fBEDOM\fP が設定される。
93 極エラー (pole error) が発生した (関数の結果が無限大である)。
94 返り値はほとんどの場合 \fBHUGE\fP (最大の単精度浮動小数点数) となり、
96 ほとんどの場合、\fIerrno\fP には \fBEDOM\fP が設定される。
100 ほとんどの場合、値 \fBHUGE\fP が返され、
101 \fIerrno\fP には \fBERANGE\fP が設定される。
105 0.0 が返され、 \fIerrno\fP に \fBERANGE\fP が設定される。
108 Total loss of significance が発生した。
109 0.0 が返され、 \fIerrno\fP に \fBERANGE\fP が設定される。
112 Partial loss of significance が発生した。
113 この値は glibc (や他の多くのシステム) で使用されていない。
115 フィールド \fIarg1\fP と \fIarg2\fP は関数に渡された引き数である
116 (引き数を一つしか取らない関数の場合は \fIarg2\fP は不定となる)。
118 \fIretval\fP フィールドはその数学関数が呼び出し元に返そうとしている返り値
119 を示す。プログラマが定義した \fBmatherr\fP() でこのフィールドを変更する
120 ことで、その数学関数の返り値を変更することができる。
122 \fBmatherr\fP() 関数が 0 を返した場合、
123 システムは \fIerrno\fP を上記の通り設定し、標準エラー出力に
124 エラーメッセージを表示することがある (下記参照)。
126 \fBmatherr\fP() 関数が 0 以外の値を返した場合、
127 システムは \fIerrno\fP を設定せず、エラーメッセージの表示も行わない。
128 .SS "matherr() を利用している数学関数"
129 下記の表は、関数と \fBmatherr\fP() が呼び出される状況の一覧である。
130 "Type" 列 は \fBmatherr\fP() が呼び出される際に \fIexc\->type\fP に
131 設定される値を示す。 "Result" 列は \fIexc\->retval\fP に
134 "Msg?" 列と "errno" 列は \fBmatherr\fP() が 0 を返した場合のデフォルトの
135 動作を示す。 "Msg?" 列に "y" が入っている場合、システムは標準エラー
138 以下の表では、下記の記法と省略形を使用している。
150 X_TLOSS \fI<math.h>\fP で定義される定数
153 .\" Details below from glibc 2.8's sysdeps/ieee754/k_standard.c
154 .\" A subset of cases were test by experimental programs.
158 Function Type Result Msg? errno
159 acos(|x|>1) DOMAIN HUGE y EDOM
160 asin(|x|>1) DOMAIN HUGE y EDOM
161 atan2(0,0) DOMAIN HUGE y EDOM
162 .\" retval is 0.0/0.0
163 acosh(x<1) DOMAIN NAN y EDOM
164 .\" retval is 0.0/0.0
165 atanh(|x|>1) DOMAIN NAN y EDOM
167 atanh(|x|==1) SING (x>0.0)? y EDOM
170 cosh(fin) o/f OVERFLOW HUGE n ERANGE
171 sinh(fin) o/f OVERFLOW (x>0.0) ? n ERANGE
173 sqrt(x<0) DOMAIN 0.0 y EDOM
174 hypot(fin,fin) o/f OVERFLOW HUGE n ERANGE
175 exp(fin) o/f OVERFLOW HUGE n ERANGE
176 exp(fin) u/f UNDERFLOW 0.0 n ERANGE
177 exp2(fin) o/f OVERFLOW HUGE n ERANGE
178 exp2(fin) u/f UNDERFLOW 0.0 n ERANGE
179 exp10(fin) o/f OVERFLOW HUGE n ERANGE
180 exp10(fin) u/f UNDERFLOW 0.0 n ERANGE
181 j0(|x|>X_TLOSS) TLOSS 0.0 y ERANGE
182 j1(|x|>X_TLOSS) TLOSS 0.0 y ERANGE
183 jn(|x|>X_TLOSS) TLOSS 0.0 y ERANGE
184 y0(x>X_TLOSS) TLOSS 0.0 y ERANGE
185 y1(x>X_TLOSS) TLOSS 0.0 y ERANGE
186 yn(x>X_TLOSS) TLOSS 0.0 y ERANGE
187 y0(0) DOMAIN \-HUGE y EDOM
188 y0(x<0) DOMAIN \-HUGE y EDOM
189 y1(0) DOMAIN \-HUGE y EDOM
190 y1(x<0) DOMAIN \-HUGE y EDOM
191 yn(n,0) DOMAIN \-HUGE y EDOM
192 yn(x<0) DOMAIN \-HUGE y EDOM
193 lgamma(fin) o/f OVERFLOW HUGE n ERANGE
194 lgamma(\-int) or SING HUGE y EDOM
196 tgamma(fin) o/f OVERFLOW HUGE_VAL n ERANGE
197 tgamma(\-int) SING NAN y EDOM
198 tgamma(0) SING copysign( y ERANGE
200 log(0) SING \-HUGE y EDOM
201 log(x<0) DOMAIN \-HUGE y EDOM
202 .\" different from log()
203 log2(0) SING \-HUGE n EDOM
204 .\" different from log()
205 log2(x<0) DOMAIN \-HUGE n EDOM
206 log10(0) SING \-HUGE y EDOM
207 log10(x<0) DOMAIN \-HUGE y EDOM
208 pow(0.0,0.0) DOMAIN 0.0 y EDOM
209 pow(x,y) o/f OVERFLOW HUGE n ERANGE
210 pow(x,y) u/f UNDERFLOW 0.0 n ERANGE
211 pow(NaN,0.0) DOMAIN x n EDOM
213 0**neg DOMAIN 0.0 y EDOM
214 neg**non\-int DOMAIN 0.0 y EDOM
215 scalb() o/f OVERFLOW (x>0.0) ? n ERANGE
218 scalb() u/f UNDERFLOW copysign( n ERANGE
220 fmod(x,0) DOMAIN x y EDOM
221 .\" retval is 0.0/0.0
222 remainder(x,0) DOMAIN NAN y EDOM
225 以下のサンプルプログラムは \fBlog\fP(3) を呼び出した際の
226 \fBmatherr\fP() の使用法を示したものである。
227 最初の引き数は \fBlog\fP(3) に渡す浮動小数点数である。
229 \fB_LIB_VERSION\fP に \fB_SVID_\fP が設定され、
230 \fBmatherr\fP() が呼ばれるようになる。
231 このコマンドライン引き数で指定した整数は、
232 \fBmatherr\fP() からの返り値として使用される。
233 省略可能な第三引き数を指定した場合、 \fBmatherr\fP() は
234 数学関数の返り値として代わりに引き数で指定した値を割り当てる。
237 \fBlog\fP(3) に引き数 0.0 が渡しているが、
238 \fBmatherr\fP() は使用しない。
243 errno: Numerical result out of range
249 \fBmatherr\fP() が呼び出され、返り値 0 が返される。
253 $\fB ./a.out 0.0 0\fP
254 matherr SING exception in log() function
255 args: 0.000000, 0.000000
256 retval: \-340282346638528859811704183484516925440.000000
258 errno: Numerical argument out of domain
259 x=\-340282346638528859811704183484516925440.000000
263 メッセージ "log: SING error" は C ライブラリによって出力されている。
265 次の実行例では、 \fBmatherr\fP() が呼び出され、0 以外の返り値が返される。
269 $\fB ./a.out 0.0 1\fP
270 matherr SING exception in log() function
271 args: 0.000000, 0.000000
272 retval: \-340282346638528859811704183484516925440.000000
273 x=\-340282346638528859811704183484516925440.000000
277 この場合は、C ライブラリはメッセージを出力しておらず、
278 \fIerrno\fP は設定されていない。
280 次の実行例では、 \fBmatherr\fP() が呼び出され、
281 数学関数の返り値が変更され、0 以外の返り値が返されている。
285 $\fB ./a.out 0.0 1 12345.0\fP
286 matherr SING exception in log() function
287 args: 0.000000, 0.000000
288 retval: \-340282346638528859811704183484516925440.000000
301 static int matherr_ret = 0; /* Value that matherr()
303 static int change_retval = 0; /* Should matherr() change
304 function\(aqs return value? */
305 static double new_retval; /* New function return value */
308 matherr(struct exception *exc)
310 fprintf(stderr, "matherr %s exception in %s() function\en",
311 (exc\->type == DOMAIN) ? "DOMAIN" :
312 (exc\->type == OVERFLOW) ? "OVERFLOW" :
313 (exc\->type == UNDERFLOW) ? "UNDERFLOW" :
314 (exc\->type == SING) ? "SING" :
315 (exc\->type == TLOSS) ? "TLOSS" :
316 (exc\->type == PLOSS) ? "PLOSS" : "???",
318 fprintf(stderr, " args: %f, %f\en",
319 exc\->arg1, exc\->arg2);
320 fprintf(stderr, " retval: %f\en", exc\->retval);
323 exc\->retval = new_retval;
329 main(int argc, char *argv[])
334 fprintf(stderr, "Usage: %s <argval>"
335 " [<matherr\-ret> [<new\-func\-retval>]]\en", argv[0]);
340 _LIB_VERSION = _SVID_;
341 matherr_ret = atoi(argv[2]);
346 new_retval = atof(argv[3]);
349 x = log(atof(argv[1]));
353 printf("x=%f\en", x);
358 \fBfenv\fP(3), \fBmath_error\fP(7), \fBstandards\fP(7)
360 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
361 である。プロジェクトの説明とバグ報告に関する情報は
362 http://www.kernel.org/doc/man\-pages/ に書かれている。