std::fmod, std::fmodf, std::fmodl
| 定义于头文件 <cmath> |
||
| (1) | ||
float fmod ( float x, float y ); double fmod ( double x, double y ); |
(直至 C++23) | |
| constexpr /*浮点类型*/ fmod ( /*floating-point-type*/ x, |
(C++23 起) | |
float fmodf( float x, float y ); |
(2) | (C++11 起) (C++23 起为 constexpr) |
long double fmodl( long double x, long double y ); |
(3) | (C++11 起) (C++23 起为 constexpr) |
| SIMD 重载 (C++26 起) |
||
| 定义于头文件 <simd> |
||
| template< class V0, class V1 > constexpr /*math-common-simd-t*/<V0, V1> |
(S) | (C++26 起) |
| 额外重载 (自 C++11 起) |
||
| 定义于头文件 <cmath> |
||
template< class Integer > double fmod ( Integer x, Integer y ); |
(A) | (C++23 起为 constexpr) |
std::fmod 的重载作为参数的类型。(C++23 起)|
S) SIMD 重载在 v_x 和 v_y 上执行逐元素的
std::fmod。
|
(C++26 起) |
|
A) 为所有整数类型提供了额外的重载，它们被视为 double。
|
(C++11 起) |
此函数计算的除法操作 x / y 的浮点余数精确地是值 x - iquot * y，其中 iquot 是 x / y 截断小数部分后的值。
返回值的符号与 x 相同，且幅度小于 y。
目录 |
[编辑] 参数
| x, y | - | 浮点数或整数值 |
[编辑] 返回值
成功时，返回如上定义的除法 x / y 的浮点余数。
如果发生域错误，则返回实现定义的值 (支持 NaN 时返回 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
|
(直至 C++23) |
|
如果 num1 和 num2 具有算术类型，则 std::fmod(num1, num2) 的效果与 std::fmod(static_cast</*common-floating-point-type*/>(num1), 如果不存在具有最高等级和次等级的浮点类型，则重载决议不会从提供的重载中产生可用的候选函数。 |
(C++23 起) |
[编辑] 示例
#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[编辑] 参阅
| (C++11) |
计算整数除法的商和余数 (函数) |
| (C++11)(C++11)(C++11) |
除法运算的带符号余数 (函数) |
| (C++11)(C++11)(C++11) |
带符号余数以及除法运算的最后三位 (函数) |
| C 文档 关于 fmod
| |
