Namespaces
Variants

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

From cppreference.net
Common mathematical functions
Nearest integer floating point operations
(C++11)
(C++11)
(C++11) (C++11) (C++11)
Floating point manipulation functions
(C++11) (C++11)
(C++11)
(C++11)
Classification and comparison
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Types
(C++11)
(C++11)
(C++11)
Macro constants
定义于头文件 <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 前)
constexpr /*floating-point-type*/

fmod ( /*floating-point-type*/ x,

/*floating-point-type*/ 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)
SIMD 重载 (C++26 起)
定义于头文件 <simd>
template < class V0, class V1 >

constexpr /*math-common-simd-t*/ < V0, V1 >

fmod ( const V0 & v_x, const V1 & v_y ) ;
(S) (C++26 起)
额外重载 (C++11 起)
定义于头文件 <cmath>
template < class Integer >
double fmod ( Integer x, Integer y ) ;
(A) (C++23 起为 constexpr)
1-3) 计算除法运算 x / y 的浮点余数。 标准库为所有 cv 未限定浮点类型提供 std::fmod 的重载,作为参数类型。 (since C++23)
S) SIMD 重载对 v_x v_y 执行逐元素的 std::fmod 运算。
(其定义参见 math-common-simd-t
(since C++26)
A) 为所有整数类型提供了额外的重载,这些类型被视为 double
(since C++11)

此函数计算的除法运算 x / y 的浮点余数,精确等于值 x - iquot * y ,其中 iquot 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 为零时发生定义域错误。

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 类型的表示范围。

double 版本的 std::fmod 其行为如同通过以下方式实现:

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 - std:: trunc ( x / y ) * y 可能不等于 std :: fmod ( x, y ) ,当对 x / y 进行舍入以初始化 std::trunc 的参数时丢失过多精度时(例如: x = 30.508474576271183309 , y = 6.1016949152542370172 )。

额外的重载并不需要完全按照 (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 < /*common-floating-point-type*/ > ( num1 ) ,
static_cast < /*common-floating-point-type*/ > ( num2 ) )
,其中 /*common-floating-point-type*/ 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 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) (C++11)
除法运算的有符号余数
(函数)
(C++11) (C++11) (C++11)
有符号余数及除法运算的最后三位
(函数)
C 文档 for fmod