命名空间
变体
操作

std::fma, std::fmaf, std::fmal

来自 cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基本运算
(C++11)  
(C++11)
fma
(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)(C++11)


 
定义在头文件 <cmath>
(1)
float       fma ( float x, float y, float z );

double      fma ( double x, double y, double z );

long double fma ( long double x, long double y, long double z );
(自 C++11 起)
(直到 C++23)
constexpr /* 浮点类型 */

            fma ( /* 浮点类型 */ x,
                  /* 浮点类型 */ y,

                  /* 浮点类型 */ z );
(自 C++23 起)
float       fmaf( float x, float y, float z );
(2) (自 C++11 起)
(自 C++23 起 constexpr)
long double fmal( long double x, long double y, long double z );
(3) (自 C++11 起)
(自 C++23 起 constexpr)
#define FP_FAST_FMA  /* 实现定义 */
(4) (自 C++11 起)
#define FP_FAST_FMAF /* 实现定义 */
(5) (自 C++11 起)
#define FP_FAST_FMAL /* 实现定义 */
(6) (自 C++11 起)
定义在头文件 <cmath>
template< class Arithmetic1, class Arithmetic2, class Arithmetic3 >

/* 通用浮点类型 */

    fma( Arithmetic1 x, Arithmetic2 y, Arithmetic3 z );
(A) (自 C++11 起)
(自 C++23 起 constexpr)
1-3) 计算 x * y + z,就好像无限精度一样,只舍入一次以适合结果类型。 库为所有 cv 无限定浮点类型提供了 std::fma 的重载,作为参数 xyz 的类型。 (自 C++23 起)
4-6) 如果宏常量 FP_FAST_FMAFP_FAST_FMAFFP_FAST_FMAL 被定义,则函数 std::fma 的计算速度更快(除了更精确之外),而不是表达式 x * y + z,对于 doublefloatlong double 参数,分别。 如果定义,这些宏将计算为整数 1
A) 为所有其他算术类型的组合提供其他重载。

内容

[编辑] 参数

x, y, z - 浮点或整数值

[编辑] 返回值

如果成功,则返回 x * y + z 的值,就好像计算为无限精度一样,并且只舍入一次以适合结果类型(或者,或者,计算为单个三元浮点运算)。

如果由于溢出而发生范围错误,则返回 ±HUGE_VAL±HUGE_VALF±HUGE_VALL

如果由于下溢而发生范围错误,则返回正确的值(舍入后)。

[编辑] 错误处理

错误报告如 math_errhandling 中所述。

如果实现支持 IEEE 浮点运算(IEC 60559),

  • 如果 x 为零且 y 为无穷大,或者如果 x 为无穷大且 y 为零,并且
    • 如果 z 不是 NaN,则返回 NaN 并引发 FE_INVALID
    • 如果 z 是 NaN,则返回 NaN 并可能引发 FE_INVALID
  • 如果 x * y 是精确的无穷大且 z 是具有相反符号的无穷大,则返回 NaN 并引发 FE_INVALID
  • 如果 xy 是 NaN,则返回 NaN。
  • 如果 z 是 NaN,并且 x * y 不是 0 * InfInf * 0,则返回 NaN(不引发 FE_INVALID)。

[编辑] 备注

此操作通常在硬件中实现为 融合乘加 CPU 指令。如果硬件支持,则预计相应的 FP_FAST_FMA? 宏将被定义,但许多实现即使在未定义宏时也会使用 CPU 指令。

POSIX (fma, fmaf, fmal) 还指定返回 FE_INVALID 的情况是域错误。

由于其无限的中间精度,std::fma 是其他正确舍入的数学运算的常用构建块,例如 std::sqrt 甚至除法(在 CPU 不提供的情况下,例如 Itanium)。

与所有浮点表达式一样,表达式 x * y + z 可以被编译为融合乘加,除非 #pragma STDC FP_CONTRACT 被关闭。

不需要按 (A) 的方式完全提供附加的重载。它们只需要足够确保对于它们的第一个参数 num1,第二个参数 num2 和第三个参数 num3

  • 如果 num1num2num3 的类型为 long double,则 std::fma(num1, num2, num3)std::fma(static_cast<long double>(num1),
             static_cast<long double>(num2),
             static_cast<long double>(num3))
    的效果相同。
  • 否则,如果 num1num2 和/或 num3 的类型为 double 或整型,则 std::fma(num1, num2, num3)std::fma(static_cast<double>(num1),
             static_cast<double>(num2),
             static_cast<double>(num3))
    的效果相同。
  • 否则,如果 num1num2num3 的类型为 float,则 std::fma(num1, num2, num3)std::fma(static_cast<float>(num1),
             static_cast<float>(num2),
             static_cast<float>(num3))
    的效果相同。
(直到 C++23)

如果 num1num2num3 具有算术类型,则 std::fma(num1, num2, num3)std::fma(static_cast</* common-floating-point-type */>(num1),
         static_cast</* common-floating-point-type */>(num2),
         static_cast</* common-floating-point-type */>(num3))
的效果相同,其中 /* common-floating-point-type */ 是在 num1num2num3 的类型中具有最大 浮点转换等级 和最大 浮点转换子等级 的浮点类型,整型参数被认为具有与 double 相同的浮点转换等级。

如果不存在具有最大等级和子等级的浮点类型,则 重载解析 不会从提供的重载中生成可用的候选者。

(自 C++23 起)

[编辑] 示例

#include <cfenv>
#include <cmath>
#include <iomanip>
#include <iostream>
 
#ifndef __GNUC__
#pragma STDC FENV_ACCESS ON
#endif
 
int main()
{
    // demo the difference between fma and built-in operators
    const double in = 0.1;
    std::cout << "0.1 double is " << std::setprecision(23) << in
              << " (" << std::hexfloat << in << std::defaultfloat << ")\n"
              << "0.1*10 is 1.0000000000000000555112 (0x8.0000000000002p-3), "
              << "or 1.0 if rounded to double\n";
 
    const double expr_result = 0.1 * 10 - 1;
    const double fma_result = std::fma(0.1, 10, -1);
    std::cout << "0.1 * 10 - 1 = " << expr_result
              << " : 1 subtracted after intermediate rounding\n"
              << "fma(0.1, 10, -1) = " << std::setprecision(6) << fma_result << " ("
              << std::hexfloat << fma_result << std::defaultfloat << ")\n\n";
 
    // fma is used in double-double arithmetic
    const double high = 0.1 * 10;
    const double low = std::fma(0.1, 10, -high);
    std::cout << "in double-double arithmetic, 0.1 * 10 is representable as "
              << high << " + " << low << "\n\n";
 
    // error handling 
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "fma(+Inf, 10, -Inf) = " << std::fma(INFINITY, 10, -INFINITY) << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

可能的输出

0.1 double is 0.10000000000000000555112 (0x1.999999999999ap-4)
0.1*10 is 1.0000000000000000555112 (0x8.0000000000002p-3), or 1.0 if rounded to double
0.1 * 10 - 1 = 0 : 1 subtracted after intermediate rounding
fma(0.1, 10, -1) = 5.55112e-17 (0x1p-54)
 
in double-double arithmetic, 0.1 * 10 is representable as 1 + 5.55112e-17
 
fma(+Inf, 10, -Inf) = -nan
    FE_INVALID raised

[编辑] 另请参阅

(C++11)(C++11)(C++11)
除法运算的带符号余数
(函数) [编辑]
(C++11)(C++11)(C++11)
带符号余数以及除法运算的最后三位
(函数) [编辑]
C 文档 针对 fma