remainder(3)

—

Options · 7

Domain error: x is an infinity and y is not a NaN	errno is set to EDOM (but see BUGS). An invalid floating-point exception (FE_INVALID) is raised.
Domain error: y is zero	errno is set to EDOM. An invalid floating-point exception (FE_INVALID) is raised.
remainderl()	C11, POSIX.1-2008.
dreml()	None.
remainderl()	C99, POSIX.1-2001.
drem()	4.3BSD.
dreml()	Tru64, glibc2.

NAME

drem, dremf, dreml, remainder, remainderf, remainderl - floating-point remainder function

SYNOPSIS

bash

#include <math.h>

bash

double remainder(double \nx\n, double \ny\n);\n
\nfloat remainderf(float \nx\n, float \ny\n);\n
\nlong double remainderl(long double \nx\n, long double \ny\n);

bash

/* Obsolete synonyms */
\n[[deprecated]] double drem(double \nx\n, double \ny\n);\n
\n[[deprecated]] float dremf(float \nx\n, float \ny\n);\n
\n[[deprecated]] long double dreml(long double \nx\n, long double \ny\n);

remainder():

bash


\n
    _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
\n
        || _XOPEN_SOURCE >= 500
\n
        || /* Since glibc 2.19: */ _DEFAULT_SOURCE
\n
        || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE

remainderf(), remainderl():

bash


\n
    _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
\n
        || /* Since glibc 2.19: */ _DEFAULT_SOURCE
\n
        || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE

drem(), dremf(), dreml():

bash


\n
    /* Since glibc 2.19: */ _DEFAULT_SOURCE
\n
        || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE

These functions compute 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: errno is set to EDOM (but see BUGS). An invalid floating-point exception (FE_INVALID) is raised.