remainderのヘルプ・マニュアル
日本語 英語
remainder --help
man remainder
REMAINDER(3) Linux Programmer’s Manual REMAINDER(3)
名前
drem, dremf, dreml, remainder, remainderf, remainderl - 浮動小数点剰余
関数
書式
#include
/* 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 ||
_ISOC99_SOURCE; or cc -std=c99
remainderf(), remainderl(): _SVID_SOURCE || _BSD_SOURCE ||
_XOPEN_SOURCE >= 600 || _ISOC99_SOURCE; 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 でない場合、領域エラーが発生し、NaN が返される。
エラー
こ れらの関数を呼び出した際にエラーが発生したかの判定方法についての情報
は math_error(7) を参照のこと。
以下のエラーが発生する可能性がある。
領域エラー (domain error): x が無限大で y が NaN ではない
不正 (invalid) 浮動小数点例外 (FE_INVALID) が上がる。
これらの関数は、この場合に errno を設定しない。
領域エラー: y がゼロで x が NaN ではない (下記の「バグ」参照)
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)
2009-02-04 REMAINDER(3)
REMAINDER(3) Linux Programmer’s Manual REMAINDER(3)
NAME
drem, dremf, dreml, remainder, remainderf, remainderl - floating-point
remainder function
SYNOPSIS
#include
/* The C99 versions */
double remainder(double x, double y);
float remainderf(float x, float y);
long double remainderl(long double x, long double y);
/* Obsolete synonyms */
double drem(double x, double y);
float dremf(float x, float y);
long double dreml(long double x, long double y);
Link with -lm.
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
remainder(): _SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE >= 500 ||
_ISOC99_SOURCE; or cc -std=c99
remainderf(), remainderl(): _SVID_SOURCE || _BSD_SOURCE ||
_XOPEN_SOURCE >= 600 || _ISOC99_SOURCE; or cc -std=c99
drem(), dremf(), dreml(): _SVID_SOURCE || _BSD_SOURCE
DESCRIPTION
The remainder() function computes the remainder of dividing x by y.
The return value is x-n*y, where n is the value x / y, rounded to the
nearest integer. If the absolute value of x-n*y is 0.5, n is chosen to
be even.
These functions are unaffected by the current rounding mode (see
fenv(3)).
The drem() function does precisely the same thing.
RETURN VALUE
On success, these functions return the floating-point remainder, x-n*y.
If the return value is 0, it has the sign of x.
If x or y is a NaN, a NaN is returned.
If x is an infinity, and y is not a NaN, a domain error occurs, and a
NaN is returned.
If y is zero, and x is not a NaN, a domain error occurs, and a NaN is
returned.
ERRORS
See math_error(7) for information on how to determine whether an error
has occurred when calling these functions.
The following errors can occur:
Domain error: x is an infinity and y is not a NaN
An invalid floating-point exception (FE_INVALID) is raised.
These functions do not set errno for this case.
Domain error: y is zero
errno is set to EDOM. An invalid floating-point exception
(FE_INVALID) is raised.
CONFORMING TO
The functions remainder(), remainderf(), and remainderl() are specified
in C99 and POSIX.1-2001.
The function drem() is from 4.3BSD. The float and long double variants
dremf() and dreml() exist on some systems, such as Tru64 and glibc2.
Avoid the use of these functions in favor of remainder() etc.
BUGS
The call
remainder(nan(""), 0);
returns a NaN, as expected, but wrongly causes a domain error; it
should yield a silent NaN.
EXAMPLE
The call "remainder(29.0, 3.0)" returns -1.
SEE ALSO
div(3), fmod(3), remquo(3)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
2009-02-04 REMAINDER(3)