std::fmod, std::fmodf, std::fmodl

float       fmod ( float x, float y );
double      fmod ( double x, double y );
long double fmod ( long double x, long double y );

constexpr /* floating-point-type */
            fmod ( /* floating-point-type */ x,
                   /* floating-point-type */ y );

float       fmodf( float x, float y );

long double fmodl( long double x, long double y );

template< class Integer >
double      fmod ( Integer x, Integer y );

Остаток от деления с плавающей точкой операции x / y , вычисляемый этой функцией, точно равен значению x - rem * y, где rem - это x / y с усечённой дробной частью.

Возвращаемое значение имеет тот же знак, что и x, и меньше, чем y по абсолютной величине.

Параметры

Возвращаемое значение

При успешном выполнении возвращает остаток от деления с плавающей точкой x / y согласно определению выше.

В случае возникновения ошибки области определения возвращается значение, определённое реализацией (NaN, если поддерживается).

В случае возникновения ошибки диапазона из-за подпотока возвращается правильный результат (после округления).

Обработка ошибок

Ошибки сообщаются, как указано в math_errhandling.

Ошибка области определения может возникнуть, если y равно нулю.

Если реализация поддерживает арифметику с плавающей точкой IEEE (IEC 60559),

• Если x равно ±0, а y не равно нулю, возвращается ±0.
• Если x равно ±∞, а y не равно NaN, возвращается NaN и поднимается FE_INVALID.
• Если y равно ±0, а x не равно NaN, возвращается NaN и поднимается FE_INVALID.
• Если y равно ±∞, а x конечно, возвращается x.
• Если любой из аргументов равен NaN, возвращается NaN.

Примечания

POSIX требует, чтобы произошла ошибка области определения, если x бесконечно или y равно нулю.

std::fmod, но не std::remainder полезно для выполнения бесшумного обёртки типов с плавающей точкой в типы без знака целых чисел: (0.0 <= (y = std::fmod(std::rint(x), 65536.0)) ? y : 65536.0 + y) находится в диапазоне [-0.0, 65535.0], что соответствует unsigned short, но std::remainder(std::rint(x), 65536.0 находится в диапазоне [-32767.0, +32768.0], что выходит за пределы диапазона signed short.

Версия std::fmod типа double ведет себя так, как если бы она была реализована следующим образом:

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

Выражение x - std::trunc(x / y) * y может не равняться std::fmod(x, y), когда округление x / y для инициализации аргумента std::trunc теряет слишком много точности (пример: x = 30.508474576271183309, y = 6.1016949152542370172).

Дополнительные перегрузки не обязаны предоставляться точно как (A). Они должны быть достаточными для обеспечения того, что для их первого аргумента num1 и второго аргумента num2:

Пример

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

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
fmod(-0.0, 1.0) = -0
fmod(5.1, Inf) = 5.1
fmod(+5.1, 0) = -nan
    FE_INVALID raised

См. также