std::fmod、std::fmodf、std::fmodl
定义在头文件 <cmath> 中 |
||
(1) | ||
float fmod ( float x, float y ); double fmod ( double x, double y ); |
(直到 C++23) | |
constexpr /* 浮点类型 */ fmod ( /* 浮点类型 */ 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) |
其他重载 (自 C++11) |
||
定义在头文件 <cmath> 中 |
||
template< class Integer > double fmod ( Integer x, Integer y ); |
(A) | (自 C++23 起为 constexpr) |
std::fmod
的重载,作为参数的类型。(自 C++23)
A) 为所有整数类型提供其他重载,这些类型被视为 double。
|
(自 C++11) |
此函数计算的除法运算 x / y 的浮点余数正好是值 x - iquot * y,其中 iquot 是 x / y,其小数部分被截断。
返回值与 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
|
(直到 C++23) |
如果 num1 和 num2 具有算术类型,那么 std::fmod(num1, num2) 与 std::fmod(static_cast</* common-floating-point-type */>(num1), 如果没有这样的具有最高等级和子等级的浮点类型,那么 重载解析 不会从提供的重载中产生可用的候选者。 |
(自 C++23) |
[edit] 示例
#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
[edit] 另请参阅
(C++11) |
计算整数除法的商和余数 (函数) |
(C++11)(C++11)(C++11) |
除法运算的有符号余数 (函数) |
(C++11)(C++11)(C++11) |
有符号余数以及除法运算的最后三个位 (函数) |
C 文档 for fmod
|