std::remainder、std::remainderf、std::remainderl
在头文件 <cmath> 中定义 |
||
(1) | ||
float remainder ( float x, float y ); double remainder ( double x, double y ); |
(直到 C++23) | |
constexpr /* 浮点类型 */ remainder ( /* 浮点类型 */ x, |
(自 C++23) | |
float remainderf( float x, float y ); |
(2) | (自 C++11) (自 C++23 为 constexpr) |
long double remainderl( long double x, long double y ); |
(3) | (自 C++11) (自 C++23 为 constexpr) |
其他重载 (自 C++11) |
||
在头文件 <cmath> 中定义 |
||
template< class Integer > double remainder ( Integer x, Integer y ); |
(A) | (自 C++23 为 constexpr) |
std::remainder
的重载,作为参数的类型。(自 C++23)
A) 为所有整数类型提供了其他重载,这些类型被视为 double.
|
(自 C++11) |
该函数计算的除法运算 x / y 的 IEEE 浮点余数恰好是值 x - quo * y,其中值 quo 是最接近精确值 x / y 的整数值。当 |quo - x / y| = ½ 时,选择值 quo 为偶数。
与 std::fmod 相反,返回值不保证与 x 的符号相同。
如果返回值为零,它将与 x 的符号相同。
内容 |
[编辑] 参数
x, y | - | 浮点或整数值 |
[编辑] 返回值
如果成功,则返回如上定义的除法运算 x / y 的 IEEE 浮点余数。
如果发生域错误,则返回实现定义的值(在支持的情况下返回 NaN)。
如果由于下溢而发生范围错误,则返回正确的结果。
如果 y 为零,但没有发生域错误,则返回零。
[编辑] 错误处理
错误报告方式如 math_errhandling 中所述。
如果 y 为零,则可能会发生域错误。
如果实现支持 IEEE 浮点算术(IEC 60559),
- 当前 舍入模式 没有影响。
- FE_INEXACT 从不引发,结果始终是精确的。
- 如果 x 为 ±∞ 且 y 不为 NaN,则返回 NaN 并引发 FE_INVALID。
- 如果 y 为 ±0 且 x 不为 NaN,则返回 NaN 并引发 FE_INVALID。
- 如果任一参数为 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 的范围。
不需要以(A)中描述的完全相同方式提供附加的重载。它们只需要足够确保对于它们的第一个参数 num1 和第二个参数 num2
|
(直到 C++23) |
如果 num1 和 num2 具有算术类型,那么 std::remainder(num1, num2) 与 std::remainder(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 << "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"; }
可能的输出
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
[edit] 参见
(C++11) |
计算整数除法的商和余数 (函数) |
(C++11)(C++11) |
浮点除法运算的余数 (函数) |
(C++11)(C++11)(C++11) |
带符号余数以及除法运算的最后三位 (函数) |
C 文档 for remainder
|