std::fmod, std::fmodf, std::fmodl

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

输入/输出库

本地化库

正则表达式库 (C++11)

原子操作库 (C++11)

线程支持库 (C++11)

文件系统库 (C++17)

技术规范

 

数值库

常用数学函数

数学特殊函数 (C++17)

数学常数 (C++20)

浮点环境 (C++11)

复数

数值数组

伪随机数生成

编译时有理数算术 (C++11)

数值算法

gcd (C++17)

lcm (C++17)

插值

midpoint (C++20)

lerp (C++20)

通用数值运算

iota (C++11)

accumulate

inner_product

adjacent_difference

partial_sum

位操作

bit_cast (C++20)

ispow2 (C++20)

ceil2 (C++20)

floor2 (C++20)

log2p1 (C++20)

rotl (C++20)

rotr (C++20)

countl_zero (C++20)

countl_one (C++20)

countr_zero (C++20)

countr_one (C++20)

popcount (C++20)

endian (C++20)

 

常用数学函数

函数
基本运算
abs(int)labsllabsimaxabs (C++11) abs(float)fabs divldivlldivimaxdiv (C++11) fmod	remainder (C++11) remquo (C++11) fma (C++11) fmax (C++11) fmin (C++11) fdim (C++11) nannanfnanl (C++11)(C++11)(C++11)
指数函数
exp exp2 (C++11) expm1 (C++11)	log log10 log1p (C++11) log2 (C++11)
幂函数
sqrt cbrt (C++11)	hypot (C++11) pow
三角与双曲函数
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)

误差与伽马函数
erf (C++11) erfc (C++11)	lgamma (C++11) tgamma (C++11)
临近整数的浮点运算
ceil floor roundlroundllround (C++11)(C++11)(C++11)	trunc (C++11) nearbyint (C++11) rintlrintllrint (C++11)(C++11)(C++11)
浮点操作函数
ldexp scalbnscalbln (C++11)(C++11) ilogb (C++11) logb (C++11)	frexp modf nextafternexttoward (C++11)(C++11) copysign (C++11)
分类/比较
fpclassify (C++11) isfinite (C++11) isinf (C++11) isnan (C++11) isnormal (C++11) signbit (C++11)	isgreater (C++11) isgreaterequal (C++11) isless (C++11) islessequal (C++11) islessgreater (C++11) isunordered (C++11)
宏常量
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) INFINITY (C++11) NAN (C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)	FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

定义于头文件 <cmath>
	(1)
float       fmod ( float x, float y );
float       fmodf( float x, float y );			(C++11 起)
double      fmod ( double x, double y );		(2)
		(3)
long double fmod ( long double x, long double y );
long double fmodl( long double x, long double y );				(C++11 起)
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

参阅

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