std::remainder, std::remainderf, std::remainderl

Functions

Basic operations

abs(int)labsllabsimaxabs (C++11)
abs(float)fabs
divldivlldivimaxdiv (C++11)
fmod

remainder (C++11)
remquo (C++11)
fma (C++11)
fmax (C++11)
fmin (C++11)
fdim (C++11)
nannanfnanl (C++11)(C++11)(C++11)

Exponential functions

exp
exp2 (C++11)
expm1 (C++11)

log
log10
log1p (C++11)
log2 (C++11)

Power functions

sqrt
cbrt (C++11)

hypot (C++11)
pow

Trigonometric and hyperbolic functions

sin
cos
tan
asin
acos
atan
atan2

sinh
cosh
tanh
asinh (C++11)
acosh (C++11)
atanh (C++11)

Error and gamma functions

erf (C++11)
erfc (C++11)

lgamma (C++11)
tgamma (C++11)

Nearest integer floating point operations

ceil
floor
roundlroundllround (C++11)(C++11)(C++11)

trunc (C++11)
nearbyint (C++11)
rintlrintllrint (C++11)(C++11)(C++11)

Floating point manipulation functions

ldexp
scalbnscalbln (C++11)(C++11)
ilogb (C++11)
logb (C++11)

frexp
modf
nextafternexttoward (C++11)(C++11)
copysign (C++11)

Classification/Comparison

fpclassify (C++11)
isfinite (C++11)
isinf (C++11)
isnan (C++11)
isnormal (C++11)
signbit (C++11)

isgreater (C++11)
isgreaterequal (C++11)
isless (C++11)
islessequal (C++11)
islessgreater (C++11)
isunordered (C++11)

Macro constants

HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11)
INFINITY (C++11)
NAN (C++11)
math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)

FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN

(C++11)(C++11)(C++11)(C++11)(C++11)

Defined in header `<cmath>`
float remainder ( float x, float y ); float remainderf( float x, float y );	(1)	(since C++11)
double remainder ( double x, double y );	(2)	(since C++11)
long double remainder ( long double x, long double y ); long double remainderl( long double x, long double y );	(3)	(since C++11)
Promoted remainder ( Arithmetic1 x, Arithmetic2 y );	(4)	(since C++11)

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

4) A set of overloads or a function template for all combinations of arguments of arithmetic type not covered by (1-3). If any argument has integral type, it is cast to double. If any other argument is long double, then the return type is long double, otherwise it is double.

The IEEE floating-point remainder of the division operation x/y calculated by this function is exactly the value x - n*y, where the value n is the integral value nearest the exact value x/y. When $|n-x/y| = ½$ , the value n is chosen to be even.

In contrast to std::fmod(), the returned value is not guaranteed to have the same sign as x.

If the returned value is 0, it will have the same sign as x.

Parameters

x, y

-

values of floating-point or integral types

Return value

If successful, returns the IEEE 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 is returned.

If y is zero, but the domain error does not occur, zero 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),

The current rounding mode has no effect.
FE_INEXACT is never raised, the result is always exact.
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 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 = std::fmod( std::rint(x), 65536.0 )) ? y : 65536.0 + y) is in the range [-0.0 .. 65535.0], which corresponds to unsigned short, but std::remainder(std::rint(x), 65536.0) is in the range [-32767.0, +32768.0], which is outside of the range of signed short.

Example

Run this code

#include <iostream>
#include <cmath>
#include <cfenv>
 
#pragma STDC FENV_ACCESS ON
int main()
{
    std::cout << "remainder(+5.1, +3.0) = " << std::remainder(5.1,3) << '\n'
              << "remainder(-5.1, +3.0) = " << std::remainder(-5.1,3) << '\n'
              << "remainder(+5.1, -3.0) = " << std::remainder(5.1,-3) << '\n'
              << "remainder(-5.1, -3.0) = " << std::remainder(-5.1,-3) << '\n';
 
    // special values
    std::cout << "remainder(-0.0, 1.0) = " << std::remainder(-0.0, 1) << '\n'
              << "remainder(5.1, Inf) = " << std::remainder(5.1, INFINITY) << '\n';
 
    // error handling
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "remainder(+5.1, 0) = " << std::remainder(5.1, 0) << '\n';
    if(fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

Possible output:

remainder(+5.1, +3.0) = -0.9
remainder(-5.1, +3.0) = 0.9
remainder(+5.1, -3.0) = -0.9
remainder(-5.1, -3.0) = 0.9
remainder(-0.0, 1.0) = -0
remainder(5.1, Inf) = 5.1
remainder(+5.1, 0) = -nan
    FE_INVALID raised

Language
Standard Library Headers
Freestanding and hosted implementations
Named requirements
Language support library
Concepts library (C++20)
Diagnostics library
Utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Input/output library
Localizations library
Regular expressions library (C++11)
Atomic operations library (C++11)
Thread support library (C++11)
Filesystem library (C++17)
Technical Specifications

Common mathematical functions
Special mathematical functions
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Compile-time rational arithmetic (C++11)
Numeric algorithms
gcd (C++17)
lcm (C++17)
Interpolations
midpoint (C++20)
lerp (C++20)
Generic numeric operations
iota (C++11)
accumulate
inner_product
adjacent_difference
partial_sum
reduce (C++17)
transform_reduce (C++17)
inclusive_scan (C++17)
exclusive_scan (C++17)
transform_inclusive_scan (C++17)
transform_exclusive_scan (C++17)
Bit operations
bit_cast (C++20)
ispow2 (C++20)
ceil2 (C++20)
floor2 (C++20)
log2p1 (C++20)