Namespaces
Variants

fmod, fmodf, fmodl

From cppreference.net
< c ‎ | numeric ‎ | math
Common mathematical functions
Functions
Basic operations
fmod
(C99)
(C99)
(C99)
(C99) (C99) (C99) (C23)
Maximum/minimum operations
Exponential functions
Power functions
Trigonometric and hyperbolic functions
Nearest integer floating-point
(C99) (C99) (C99)
(C23) (C23) (C23) (C23)
Floating-point manipulation
Narrowing operations
(C23)
(C23)
(C23)
(C23)
(C23)
(C23)
Quantum and quantum exponent
Decimal re-encoding functions
Total order and payload functions
Classification
Error and gamma functions
(C99)
(C99)
(C99)
(C99)
Types
Macro constants
Special floating-point values
Arguments and return values
Error handling
Fast operation indicators
定义于头文件 <math.h>
float fmodf ( float x, float y ) ;
(1) (C99 起)
double fmod ( double x, double y ) ;
(2)
long double fmodl ( long double x, long double y ) ;
(3) (C99 起)
定义于头文件 <tgmath.h>
#define fmod( x, y )
(4) (C99 起)
1-3) 计算除法运算 x / y 的浮点余数。
4) 类型泛型宏:若任一参数具有类型 long double ,则调用 fmodl 。否则,若任一参数具有整数类型或具有类型 double ,则调用 fmod 。否则,调用 fmodf

此函数计算的除法运算 x / y 的浮点余数,其精确值为 x - n * y ,其中 n 是将 x / y 的小数部分截断后的结果。

返回值的符号与 x 相同,且其绝对值小于或等于 y

目录

参数

x, y - 浮点数值

返回值

如果成功,返回按上述定义计算的除法 x / y 的浮点余数。

如果发生定义域错误,则返回一个由实现定义的值(在支持 NaN 的情况下返回 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 为零时,将发生定义域错误。

fmod 而非 remainder 可用于将浮点类型静默包装为无符号整数类型: ( 0.0 <= ( y = fmod ( rint ( x ) , 65536.0 ) ) ? y : 65536.0 + y ) 的值位于 [ - 0.0 , 65535.0 ] 范围内,对应 unsigned short 类型;而 remainder ( rint ( x ) , 65536.0 ) 的值位于 [ - 32767.0 , + 32768.0 ] 范围内,该范围超出了 signed short 的表示范围。

double 版本的 fmod 函数行为类似于以下实现方式:

double fmod(double x, double y)
{
#pragma STDC FENV_ACCESS ON
    double result = remainder(fabs(x), (y = fabs(y)));
    if (signbit(result))
        result += y;
    return copysign(result, x);
}

示例

#include <fenv.h>
#include <math.h>
#include <stdio.h>
// #pragma STDC FENV_ACCESS ON
int main(void)
{
    printf("fmod(+5.1, +3.0) = %.1f\n", fmod(5.1, 3));
    printf("fmod(-5.1, +3.0) = %.1f\n", fmod(-5.1, 3));
    printf("fmod(+5.1, -3.0) = %.1f\n", fmod(5.1, -3));
    printf("fmod(-5.1, -3.0) = %.1f\n", fmod(-5.1, -3));
    // 特殊值
    printf("fmod(+0.0, 1.0) = %.1f\n", fmod(0, 1));
    printf("fmod(-0.0, 1.0) = %.1f\n", fmod(-0.0, 1));
    printf("fmod(+5.1, Inf) = %.1f\n", fmod(5.1, INFINITY));
    // 错误处理
    feclearexcept(FE_ALL_EXCEPT);
    printf("fmod(+5.1, 0) = %.1f\n", fmod(5.1, 0));
    if (fetestexcept(FE_INVALID))
        puts("    FE_INVALID raised");
}

可能的输出:

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.0
fmod(-0.0, 1.0) = -0.0
fmod(+5.1, Inf) = 5.1
fmod(+5.1, 0) = nan
    FE_INVALID raised

参考文献

  • C23 标准 (ISO/IEC 9899:2024):
  • 7.12.10.1 fmod 函数 (p: TBD)
  • 7.25 类型泛型数学 <tgmath.h> (p: TBD)
  • F.10.7.1 fmod 函数 (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018):
  • 7.12.10.1 fmod 函数 (p: 185)
  • 7.25 类型泛型数学 <tgmath.h> (p: 274-275)
  • F.10.7.1 fmod 函数 (p: 385)
  • C11 标准 (ISO/IEC 9899:2011):
  • 7.12.10.1 fmod 函数 (p: 254)
  • 7.25 泛型数学 <tgmath.h> (p: 373-375)
  • F.10.7.1 fmod 函数 (p: 528)
  • C99标准(ISO/IEC 9899:1999):
  • 7.12.10.1 fmod函数(页:235)
  • 7.22 泛型数学 <tgmath.h>(页:335-337)
  • F.9.7.1 fmod函数(页:465)
  • C89/C90 标准 (ISO/IEC 9899:1990):
  • 4.5.6.4 fmod 函数

参考

计算整数除法的商和余数
(函数)
计算浮点除法操作的有符号余数
(函数)
(C99) (C99) (C99)
计算有符号余数及除法操作的最后三位
(函数)