REMAINDER(3)

名前
drem, dremf, dreml, remainder, remainderf, remainderl - 浮動小数点剰余関数

書式
#include <math.h>

/* C99 版 */
double remainder(double x, double y);
float remainderf(float x, float y);
long double remainderl(long double x, long double y);

/* 廃止された別名 */
double drem(double x, double y);
float dremf(float x, float y);
long double dreml(long double x, long double y);

-lm でリンクする。

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

remainder():
    _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE >= 500 || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L;
    or cc -std=c99
remainderf(), remainderl():
    _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE >= 600 || _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L;
    or cc -std=c99
drem(), dremf(), dreml():
    _SVID_SOURCE || _BSD_SOURCE

説明
remainder() 関数は x を y で割った余りを計算する。 返り値は x-n*y である。 ここで n は x / y の値を最も近い整数に丸めたものである。 x-n*y の絶対値が 0.5 の場合、偶数になるように n が選ばれる。 これらの関数は、現在の丸めモードの影響を受けない (丸めモードについては fenv(3) を参照)。

drem() 関数はこれと全く同じ動作をする。

返り値
成功すると、これらの関数は浮動小数点の剰余 x-n*y を返す。 返り値が 0 の場合、その符号は x と同じになる。 x か y が NaN の場合、NaN が返される。 x が無限大で y が NaN でない場合、 領域エラー (domain error) が発生し、NaN が返される。 y がゼロで x が NaN でない場合、 領域エラー (domain error) が発生し、NaN が返される。

エラー
これらの関数を呼び出した際にエラーが発生したかの判定方法についての情報は math_error(7) を参照のこと。

以下のエラーが発生する可能性がある。

領域エラー (domain error): x が無限大で y が NaN ではない
    不正 (invalid) 浮動小数点例外 (FE_INVALID) が上がる。

    これらの関数は、この場合に errno を設定しない。

領域エラー: y がゼロ
    errno に EDOM が設定される。 不正 (invalid) 浮動小数点例外 (FE_INVALID) が上がる。

準拠
関数 remainder(), remainderf(), remainderl() は C99 と POSIX.1-2001 で規定されている。 関数 drem() は 4.3BSD に由来する。 float と long double 版の dremf() と dreml() は、Tru64 や glibc2 のようないくつかのシステムに存在する。 これらの関数の使用は避けて、 remainder() などを使用すること。

バグ
呼び出し
    remainder(nan(""), 0); を行うと、期待通り Nan が返るが、誤って領域エラーが発生する。 正しくはエラーなしの Nan となるべきである。

例
"remainder(29.0, 3.0)" を呼び出すと -1 を返す。

関連項目
div(3), fmod(3), remquo(3)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。