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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

技术规范

符号索引

外部库

 

数值库

常用数学函数

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

数学常数 (C++20)

浮点环境 (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)

byteswap (C++23)

has_single_bit (C++20)

bit_ceil (C++20)

bit_floor (C++20)

bit_width (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 ); double      fmod ( double x, double y ); long double fmod ( long double x, long double y );			(C++23 前)
/* 浮点类型 */ fmod( /* 浮点类型 */ x, /* 浮点类型 */ y );			(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 Arithmetic1, class Arithmetic2 > /* 公共浮点类型 */ fmod( Arithmetic1 x, Arithmetic2 y );		(A)	(C++23 起 constexpr)

1-3) 计算除法运算 x / y 的浮点余数。标准库提供所有以无 cv 限定的浮点类型作为参数 x 和 y 的类型的 std::fmod 重载。 (C++23 起)

A) 为算术类型的所有其他组合提供额外重载。

(C++11 起)

此函数计算的除法 x / y 的浮点余数是 x - rem * y 的准确值，其中 rem 是截断小数部分的 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 / y 到 std::trunc 的参数损失过多精度时，表达式 x - trunc(x / y) * y 不一定会等于 fmod(x, y)（例如：{{{1}}}，{{{1}}} ）。

额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的第一个实参 num1 和第二个实参 num2 满足以下要求：

如果 num1 或 num2 具有 long double 类型，那么 std::fmod(num1, num2) 和 std::fmod(static_cast<long double>(num1),           static_cast<long double>(num2)) 的效果相同。 否则，如果 num1 和/或 num2 具有 double 或整数类型，那么 std::fmod(num1, num2) 和 std::fmod(static_cast<double>(num1),           static_cast<double>(num2)) 的效果相同。 否则，如果 num1 或 num2 具有 float 类型，那么 std::fmod(num1, num2) 和 std::fmod(static_cast<float>(num1),           static_cast<float>(num2)) 的效果相同。

(C++23 前)

如果 num1 和 num2 具有算术类型，那么 std::fmod(num1, num2) 和 std::fmod(static_cast</* 公共浮点类型 */>(num1),           static_cast</* 公共浮点类型 */>(num2)) 的效果相同，其中 /* 公共浮点类型 */ 是 num1 和 num2 的类型中浮点转换等级和浮点转换子等级最高的浮点类型，整数类型的实参被视为具有与 double 相等的浮点转换等级。 如果不存在等级和子等级最高的浮点类型，那么在重载决议时不会从提供的重载中产生可用的候选。

(C++23 起)

示例

运行此代码

#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';
 
    // 特殊值
    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\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

参阅

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