Fmod

定义于头文件 <cmath> 中。

描述

此函数计算的除法运算 x / y 的浮点余数精确地等于 x - rem * y，其中 rem 是 x / y 的小数部分被截断后的值。

返回值的符号与 x 相同，且幅度小于 y。

声明

C++23

// 1)
constexpr /* floating-point-type */
            fmod ( /* floating-point-type */ x,
                   /* floating-point-type */ y );
// 2)
constexpr float       fmodf( float x, float y );
// 3)
constexpr long double fmodl( long double x, long double y );

附加重载

// 4)
template< class Arithmetic1, class Arithmetic2 >
/* common-floating-point-type */ fmod( Arithmetic1 x, Arithmetic2 y );

C++11

// 1)
float       fmod ( float x, float y );
double      fmod ( double x, double y );
long double fmod ( long double x, long double y );
// 2)
float       fmodf( float x, float y );
// 3)
long double fmodl( long double x, long double y );

附加重载

// 4)
template< class Arithmetic1, class Arithmetic2 >
/* common-floating-point-type */ fmod( Arithmetic1 x, Arithmetic2 y );

参数

x, y - 浮点或整数值

返回值

如果成功，返回如上定义的 x / y 的浮点余数。

如果发生域错误，则返回实现定义的值（如果支持，返回 NaN）。

如果因下溢导致范围错误，则返回正确结果（舍入后）。

错误处理

如果 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]，这对应于无符号短整型，但 std::remainder(std::rint(x), 65536.0) 的范围是 [-32767.0, +32768.0]，这超出了有符号短整型的范围。

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：

如果 num1 或 num2 的类型是 long double，则
std::fmod(num1, num2) 的效果与
​ std::fmod(static_cast<long double>(num1), static_cast<long double>(num2)) 相同。

否则，如果 num1 和/或 num2 的类型是 double 或整数类型，则
std::fmod(num1, num2) 的效果与
​ std::fmod(static_cast<double>(num1), static_cast<double>(num2))。

否则，如果 num1 或 num2 的类型是 float，则
std::fmod(num1, num2) 的效果与
​ std::fmod(static_cast<float>(num1), static_cast<float>(num2))。

如果 num1 和 num2 具有算术类型，则
std::fmod(num1, num2) 的效果与
std::fmod(static_cast</* common-floating-point-type */>(num1), static_cast</* common-floating-point-type */>(num2))

其中 /* common-floating-point-type */ 是 num1 和 num2 的类型中具有最高浮点转换等级和最高浮点转换子等级的浮点类型，整数类型的参数被认为与 double 具有相同的浮点转换等级。

如果不存在具有最高等级和子等级的浮点类型，则重载决议不会从提供的重载中产生可用的候选。

示例

#include <iostream>
#include <cmath>
#include <cfenv>
 
// #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