C++ 参考手册

位置：首页 > C++ 参考手册 >数值库 >常用数学函数 > std::remainder, std::remainderf, std::remainderl

std::remainder, std::remainderf, std::remainderl

定义于头文件 <cmath>
float       remainder ( float x, float y );
float       remainderf( float x, float y );
 (1) (C++11 起)
double      remainder ( double x, double y );
 (2) (C++11 起)
long double remainder ( long double x, long double y );
long double remainderl( long double x, long double y );
 (3) (C++11 起)
Promoted    remainder ( Arithmetic1 x, Arithmetic2 y );
 (4) (C++11 起)
1-3) 计算浮点除法运算 x/y 的 IEEE 余数。
4) 所有 (1-3) 所不覆盖的算术类型参数组合的重载集或函数模板。若任何参数拥有整数类型，则将它转型到 double 。若任何其他参数为 long double ，则返回类型为 long double ，否则为 double 。

此函数所计算的除法运算 x/y 的 IEEE 浮点余数，准确地为值 x - n*y ，其中值 n 是最接近 x/y 准确值的整数值。 |n-x/y| = ½ 时，选择作为偶数的 n 。

与 std::fmod() 相反，不保证返回值拥有与 x 相同的符号。

若返回值是 0 ，则它拥有与 x 相同的符号。

参数

x, y - 浮点或整数类型值

返回值

若成功，则返回定义如上的除法 x/y 浮点余数。

若出现定义域错误，则返回实现定义值（受支持平台上为 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 的范围外。

示例

运行此代码
#include <iostream>
#include <cmath>
#include <cfenv>
 
#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';
 
    // 特殊值
    std::cout << "remainder(-0.0, 1.0) = " << std::remainder(-0.0, 1) << '\n'
              << "remainder(5.1, Inf) = " << std::remainder(5.1, INFINITY) << '\n';
 
    // 错误处理
    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

参阅

(C++11)
 计算整数除法的商和余数
(函数)
(C++11)(C++11)
 浮点除法运算的余数
(函数)
(C++11)(C++11)(C++11)
 除法运算的有符号余数和最后三个二进制位
(函数)