std::fmod

来自cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基础操作
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
指数函数
(C++11)
(C++11)
(C++11)
(C++11)
幂函数
(C++11)
(C++11)
三角与双曲函数
(C++11)
(C++11)
(C++11)
误差与伽马函数
(C++11)
(C++11)
(C++11)
(C++11)
临近整数的浮点运算
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
浮点操作函数
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
分类/比较
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
宏常量
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
定义于头文件 <cmath>
float       fmod( float x, float y );
(1)
double      fmod( double x, double y );
(2)
long double fmod( long double x, long double y );
(3)
Promoted    fmod( Arithmetic1 x, Arithmetic2 y );
(4) (C++11 起)
1-3) 计算除法运算 x/y 的浮点余数。
4) 所有 1-3 不覆盖的算术类型参数组合的重载集或函数模板。若任何参数拥有整数类型,则将它转型到 double 。若任何其他参数为 long double ,则返回类型是 long double ,否则是 double

此函数计算的浮点除法 x/y 余数是 x - n*y 的准确值,其中 n 是截断小数部分的 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 的范围外。

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/y 到 trunc 的参数损失过多精度时,表达式 x - trunc(x/y)*y 可以不等于 fmod(x,y) (例如: x = 30.508474576271183309, y = 6.1016949152542370172 )。

[编辑] 示例

#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';
 
    // 特殊值
    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';
 
    // 错误处理
    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)
有符号余数还有除法运算的最后三位
(函数) [编辑]
fmodC 文档