fmod, fmodf, fmodl

 

C

Language

Standard Library

Type support

Dynamic memory management

Error handling

Program utilities

Date and time utilities

Strings library

Algorithms

Numerics

Input/output support

Localization support

Thread support (C11)

Atomic operations (C11)

 

Numerics

Common mathematical functions

Floating-point environment

Complex number arithmetics

Random number generation

Type-generic math

 

Common mathematical functions

Functions
Basic operations
abslabsllabsimaxabs (C99) fabs divldivlldivimaxdiv (C99) fmod	remainder (C99) remquo (C99) fma (C99) fmax (C99) fmin (C99) fdim (C99) nannanfnanl (C99)(C99)(C99)
Exponential functions
exp exp2 (C99) expm1 (C99)	log log10 log1p (C99) log2 (C99)
Power functions
sqrt cbrt (C99)	hypot (C99) pow
Trigonometric and hyperbolic functions
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C99) acosh (C99) atanh (C99)
Error and gamma functions
erf (C99) erfc (C99)	lgamma (C99) tgamma (C99)
Nearest integer floating point operations
ceil floor roundlroundllround (C99)(C99)(C99)	trunc (C99) nearbyint (C99) rintlrintllrint (C99)(C99)(C99)
Floating point manipulation functions
ldexp scalbnscalbln (C99)(C99) ilogb (C99) logb (C99)	frexp modf nextafternexttoward (C99)(C99) copysign (C99)
Classification
fpclassify (C99) isfinite (C99) isinf (C99) isnan (C99) isnormal (C99) signbit (C99)	isgreater (C99) isgreaterequal (C99) isless (C99) islessequal (C99) islessgreater (C99) isunordered (C99)
Macro constants
HUGE_VALFHUGE_VALHUGE_VALL (C99)(C99)	FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C99)(C99)(C99)(C99)(C99)

 

Defined in header <math.h>
float       fmodf( float x, float y );	(1)	(since C99)
double      fmod( double x, double y );	(2)
long double fmodl( long double x, long double y );	(3)	(since C99)
Defined in header <tgmath.h>
#define fmod( x, y )	(4)	(since C99)

1-3) Computes the floating-point remainder of the division operation x/y.

4) Type-generic macro: If any argument has type long double, fmodl is called. Otherwise, if any argument has integer type or has type double, fmod is called. Otherwise, fmodf is called.

The floating-point remainder of the division operation x/y calculated by this function is exactly the value x - n*y, where n is x/y with its fractional part truncated.

The returned value has the same sign as x and is less or equal to y in magnitude.

Parameters

x, y

-

floating point values

Return value

If successful, returns the floating-point remainder of the division x/y as defined above.

If a domain error occurs, an implementation-defined value is returned (NaN where supported).

If a range error occurs due to underflow, the correct result (after rounding) is returned.

Error handling

Errors are reported as specified in math_errhandling.

Domain error may occur if y is zero.

If the implementation supports IEEE floating-point arithmetic (IEC 60559),

• If x is ±0 and y is not zero, ±0 is returned
• If x is ±∞ and y is not NaN, NaN is returned and FE_INVALID is raised
• If y is ±0 and x is not NaN, NaN is returned and FE_INVALID is raised
• If y is ±∞ and x is finite, x is returned.
• If either argument is NaN, NaN is returned

Notes

POSIX requires that a domain error occurs if x is infinite or y is zero.

std::fmod, but not std::remainder is useful for doing silent wrapping of floating-point types to unsigned integer types: (0.0 <= (y = fmod(rint(x), 65536.0 )) ? y : 65536.0 + y) is in the range [-0.0 .. 65535.0], which corresponds to unsigned short, but remainder(rint(x), 65536.0 is in the range [-32767.0, +32768.0], which is outside of the range of signed short.

The double version of fmod behaves as if implemented as follows:

double fmod(double x, double y)
{
#pragma STDC FENV_ACCESS ON
    double result = remainder(fabs(x), (y = fabs(y)));
    if (signbit(result)) result += y;
    return copysign(result, x);
}

Example

Run this code

#include <stdio.h>
#include <math.h>
#include <fenv.h>
 
#pragma STDC FENV_ACCESS ON
int main(void)
{
    printf("fmod(+5.1, +3.0) = %.1f\n", fmod(5.1,3));
    printf("fmod(-5.1, +3.0) = %.1f\n", fmod(-5.1,3));
    printf("fmod(+5.1, -3.0) = %.1f\n", fmod(5.1,-3));
    printf("fmod(-5.1, -3.0) = %.1f\n", fmod(-5.1,-3));
 
    // special values
    printf("fmod(+0.0, 1.0) = %.1f\n", fmod(0, 1));
    printf("fmod(-0.0, 1.0) = %.1f\n", fmod(-0.0, 1));
    printf("fmod(+5.1, Inf) = %.1f\n", fmod(5.1, INFINITY));
 
    // error handling
    feclearexcept(FE_ALL_EXCEPT);
    printf("fmod(+5.1, 0) = %.1f\n", fmod(5.1, 0));
    if(fetestexcept(FE_INVALID)) puts("    FE_INVALID raised");
}

Possible output:

fmod(+5.1, +3.0) = 2.1
fmod(-5.1, +3.0) = -2.1
fmod(+5.1, -3.0) = 2.1
fmod(-5.1, -3.0) = -2.1
fmod(+0.0, 1.0) = 0.0
fmod(-0.0, 1.0) = -0.0
fmod(+5.1, Inf) = 5.1
fmod(+5.1, 0) = nan
    FE_INVALID raised

See also

divldivlldiv (C99)	computes quotient and remainder of integer division (function)
remainderremainderfremainderl (C99)(C99)(C99)	computes signed remainder of the floating-point division operation (function)
remquoremquofremquol (C99)(C99)(C99)	computes signed remainder as well as the three last bits of the division operation (function)
C++ documentation for fmod